{"items":[{"type":"link","label":"Shoptet API","link":"/shoptet-api/openapi","routeSlug":"/shoptet-api/openapi","content":{"contentType":"overview","meta":{"name":"Shoptet API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/Shoptet API/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/Shoptet API/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Shoptet API (d5b9773)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created in cooperation with the Ministry of Industry and Trade of the Czech"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Republic within the \"The Country for the Future\" programme."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"img","attrs":{"src":"https://www.mzv.cz/public/fe/30/dd/3705578_2234497__867990_sm.png"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This documentation provides information about the interface for developers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"who would like to gain access to Shoptet"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shops. For more information about Shoptet, see https://www.shoptet.cz/."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API is available in two access modes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for \"Shoptet partner” developers who create the interconnection with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"services and extend the Shoptet system's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"functions for public usage. For more information about API and conditions, under which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it can be used, see https://developers.shoptet.com/addons/."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"direct private access to eshop data for eshop owner - available only for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.shoptetpremium.cz/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Premium Members"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See https://developers.shoptet.com/premium for more information about API access."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi"}],"sectionId":"/shoptet-api/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/basic-principles"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic principles"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/how-to-call-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to call API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API supports communication in JSON format. The URL for calling API requests"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is https://api.myshoptet.com. The API calls"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(endpoints and message formats) are common for private as well as addons"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access, it however uses different authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and authorization principles."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/how-to-call-api"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/how-to-call-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/basic-principles/for-addons"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Addons"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API is made to create the supplements for the Shoptet system and uses OAuth2"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization principles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To access the API it is necessary to implement a web service at your side,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which will communicate with our OAuth server."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In your e-shop administration, which you are using to work with our API, you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must search in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"API Partner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Access to API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here, you will find your clientID and addresses, from where you can call our"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth server."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The work with API begins with e-shop addon installation. (The installation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process can be tested in the addon detail in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section, where you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can cause the installation for your e-shop.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In your addon detail, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section, enter URL to gain a OAuth"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code. The URL must be linked to your server, where the script is prepared,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is able to gain an OAuth access token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this address, you will receive the HTTP request with a GET parameter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when installing the addon, with unique value (a 255 character long"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided only has short-term validity and can be used only once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With this code, request our OAuth server to provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OAuth access token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Such a request shall follow within the same script that received the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not put off gaining the OAuth access token for a later time, and do not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reply to our request with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, until you gain the OAuth access"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address for you to call, and an example of implementation, can be found"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in e-shop administration in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Access to API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a response you will obtain a JSON with your OAuth access token. Save this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token securely. Never send this token to the client computer, and use it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for communication between the servers and for gaining the temporary token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for access to API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have successfully received an OAuth access token, your script must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end with the HTTP status code “200”."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Now you have your OAuth access token, which links your addon with a specific"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop, perhaps you would like to communicate with the e-shop via API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From your server, call"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https:///action/ApiOAuthServer/getAccessToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with HTTP header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As the reply, you will receive a JSON containing an API access token value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the token expiration time value. An example of calling can be found in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop administration in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Access to API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is possible to request a maximum of 5 valid tokens."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API access token will enable you to call an individual URL of our API,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.myshoptet.com/api/eshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Send the API access token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in each request in the HTTP header"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shoptet-Access-Token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can have several valid API access tokens available at any one time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should the validity of the API access token expire, you will receive a HTTP"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status code 401 and message about token expiration."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"expired-token\",\n \"message\": \"Token is expired. Please ask for new one.\",\n \"instance\": \"unknown\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"expired-token\",\n \"message\": \"Token is expired. Please ask for new one.\",\n \"instance\": \"unknown\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your token does not have the access right for a specific endpoint, you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will obtain a reply with HTTP status code 403 Forbidden."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"invalid-token-no-rights\",\n \"message\": \"Your access token \\\"afd..123\\\" has no defined rights for this resource.\",\n \"instance\": \"access-token\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"invalid-token-no-rights\",\n \"message\": \"Your access token \\\"afd..123\\\" has no defined rights for this resource.\",\n \"instance\": \"access-token\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/for-addons"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/for-addons"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/basic-principles/for-private-api-access-(premium)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For private API access (Premium)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create API access tokens simply in the eshop administration. Send"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"them in the request header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shoptet-Private-API-Token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Private API tokens use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint group rights"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control access. Each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token is assigned one or more endpoint groups, and each group grants either"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read, write, or read+write access to the endpoints it contains."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When new token is created, all available endpoint groups are granted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically, so the token can access all API endpoints out of the box."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access can be restricted by removing individual endpoint groups in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eshop administration under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Access to API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the token does not have the required right for an endpoint, you will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receive a HTTP status code 403 Forbidden with the error code"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid-token-no-rights"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/for-private-api-access-(premium)"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/for-private-api-access-(premium)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/rate-limiting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limiting is at the level of server overload protection (DDoS), whereas the quantity of queries or total volume of data are unlimited."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are therefore the limits of the maximum number of coincident active connections. A maximum of 50 from a single IP address, and a maximum of 3 connections for a single token. If the limit is exceeded, the HTTP code 429 is returned. See also Nginx configuration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"limit_conn per_ip 50;\nlimit_conn per_token 3;\nlimit_conn_status 429;\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"limit_conn per_ip 50;\nlimit_conn per_token 3;\nlimit_conn_status 429;\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some URLs, for example for bulk operations, can have their own specific limits, which are mentioned in this documentation."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/rate-limiting"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/rate-limiting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/basic-principles/leaky-bucket"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Leaky bucket"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We have also prepared more detailed rules for checking the efficiency of calling your integrations using a leaky bucket algorithm."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We inform you about reaching the limits via headers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-RateLimit-Bucket-Filling"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (in every response), and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only if bucket is fulfilled), e.g."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-RateLimit-Bucket-Filling: 200/200\nRetry-After: Mon, 01 Jul 2024 12:01:11 GMT\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-RateLimit-Bucket-Filling: 200/200\nRetry-After: Mon, 01 Jul 2024 12:01:11 GMT\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, visit "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/api/documentation/rate-limiter/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Rate limiter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/leaky-bucket"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/leaky-bucket"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/locks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Write endpoints (DELETE, PATCH, POST, PUT methods) can take longer and may"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be prone to two concurrent matching requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To avoid problems with retrying identical write requests, we have added the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"locking function of these requests to the application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you execute the same request two times in quick succession, the second"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request receives error response with a 423 code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lock is only valid for a specific called URL, for the duration of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request processing, but no longer than 5 seconds."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/locks"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/locks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/server-response-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Server response format"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All JSON responses from the server have the same format, as a base."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any of the sections is not present in the response, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then received."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of call for addons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\ncurl --include \\\n -H 'Shoptet-Access-Token: 123456-a-123-XXXXXXXXXXXXXXXXXXXXXXXXX' \\\n -H 'Content-Type: application/json' \\\n 'https://api.myshoptet.com/api/eshop'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\ncurl --include \\\n -H 'Shoptet-Access-Token: 123456-a-123-XXXXXXXXXXXXXXXXXXXXXXXXX' \\\n -H 'Content-Type: application/json' \\\n 'https://api.myshoptet.com/api/eshop'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of call for private API access:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\ncurl --include \\\n -H 'Shoptet-Private-API-Token: 123456-a-123-XXXXXXXXXXXXXXXXXXXXXXXXX' \\\n -H 'Content-Type: application/json' \\\n 'https://api.myshoptet.com/api/eshop'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\ncurl --include \\\n -H 'Shoptet-Private-API-Token: 123456-a-123-XXXXXXXXXXXXXXXXXXXXXXXXX' \\\n -H 'Content-Type: application/json' \\\n 'https://api.myshoptet.com/api/eshop'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\nHTTP/2 200\n\ndate: Fri, 13 Jul 2018 15:57:29 GMT\n\ncontent-type: application/json; charset=utf-8\n\n\n{\n \"data\": {\n \"contactInformation\": {\n \"eshopName\": \"www.domena-eshopu.cz\",\n \"url\": \"https:\\/\\/www.domena-eshopu.cz\\/\",\n \"companyId\": \"28935675\",\n ...\n }\n ...\n },\n \"errors\": 'null',\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\nHTTP/2 200\n\ndate: Fri, 13 Jul 2018 15:57:29 GMT\n\ncontent-type: application/json; charset=utf-8\n\n\n{\n \"data\": {\n \"contactInformation\": {\n \"eshopName\": \"www.domena-eshopu.cz\",\n \"url\": \"https:\\/\\/www.domena-eshopu.cz\\/\",\n \"companyId\": \"28935675\",\n ...\n }\n ...\n },\n \"errors\": 'null',\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The basic structure of the response in the event of an error is as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"missing-access-token\",\n \"message\": \"Missing access token. Please add `Shoptet-Access-Token` header to your request.\",\n \"instance\": \"unknown\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"missing-access-token\",\n \"message\": \"Missing access token. Please add `Shoptet-Access-Token` header to your request.\",\n \"instance\": \"unknown\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is primary used for logging/reporting purposes. Please remember to include the value from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.requestId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or from the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Request-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when contacting the technical support with your specific inquiry for better traceability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most of the endpoints are synchronous, i.e. your answer is provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"immediately and contains the data requested. There"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are however some endpoints, where either the request or the response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing takes longer time. These are implemented as"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request will be queued and you"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receive only job identification in the response. You will be notified using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/api/documentation/webhooks/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the job is completed and your results"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"downloadable. Be aware, that registration of webhook "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job:finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required to be able to run asynchronous requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If webhook is not registered, you will receive an error response with HTTP"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status code 403 and job won't be queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job:finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also emitted when the job is failed so there is need to check the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/jobs/getjobdetail"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job detail"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to get the result of the job. If an error occurs during an asynchronous request, the job is automatically marked as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed 3 hours after its creation, and in this case, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job:finished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook is not emitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some attributes may be added to the new API version, or the sequence of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes can be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your software, therefore, shall not rely on either of these."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If some attributes are renamed or removed, you will be informed in an additional header - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/deprecated-header-+-sunset"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated header + Sunset"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/server-response-format"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/server-response-format"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/deprecated-header-+-sunset"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated header + Sunset"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are calling some endpoint in a version that will not be supported in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the future, you will receive a response with the header"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Shoptet-Deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you detect this header within the response and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"its presence is logged,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you should be aware of the support termination for a specific endpoint in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"advance and thus have enough time for correction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Furthermore, you shall also receive the response with a"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sunset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the date when the support for this endpoint is to be terminated."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/deprecated-header-+-sunset"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/deprecated-header-+-sunset"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/status-codes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When processing the response, the client shall first detect, what response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status code was received."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For GET requests for responses with 200 code, it is not necessary to explore"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" part of the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For PATCH/PUT requests, which can process more records at the same time and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"some records"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are not processed successfully, these end with a 200 response code and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"errors key contains info"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on skipped rows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unknown record is returned with a 404 code, etc. These responses have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the error field filled in, where you can"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"find detailed info about the error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following errors might be expected:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 - Some of the validations on item level have failed. There is no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason to retry, it will fail always."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 - Invalid token or the token has expired (for addons access tokens)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have to ask for another one."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403 - Forbidden. The token has no rights to the endpoint called. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoints must be allowed for an addon"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the eshop must have approved them. Valid for addons access tokens, private tokens can always access all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoints. Can be also returned when required module for request is missing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 - Either the endpoint is wrong; or most commonly, an entity"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifier, which is part of the URL, does"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not exist."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 - Conflict - the action could not be completed for some consistency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rules, such as duplicate data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or relation, which would be broken."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"413 - Payload too large - update requests can sometimes contain multiple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"entities to be amended. There is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"however a limit (varying for each request), how many can be specified within one request. If you breach the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"limit, you will get this error and nothing will be updated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422 - Unprocessable entity - we were not able to parse the request - it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does not match the expected format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Something is wrong with the request as whole, it might not be a correct JSON or it does not match the expected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON schema. There is no reason to retry, it will always fail."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"423 - Locked - for update and some read request we apply locks, usually on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an URL level, which should avoid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consistency problems possibly occuring from parallel updates. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/locks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section. Retry later,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"try to avoid parallel update requests."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 - General server error. Yes, this might happen to our software, too."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most commonly this is a temporary"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database issue and it might (but might not), work a few minutes later. We monitor all such errors and we"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"try to analyze and fix them."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"503 - System maintenance. Most commonly we move a database to another"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"database cluster or a database migration is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending and it will be available in a few minutes. Please try later."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/status-codes"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/status-codes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some endpoints can return larger quantity of records. Such endpoints do not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return the entire result, but support pagination of results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can page using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (int) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemsPerPage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (int) parameters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first page has number 1. If you require a different quantity of items per page, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemsPerPage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemsPerPage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has a default value used when the parameter is not specified, and a maximum value that cannot be exceeded. If a higher value is provided, the maximum is applied automatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default and maximum value can be different for each endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When paging, check the total number of items, if not altered ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), then the items on pages could be shifted and some of them could be missed or processed twice."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/paging"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/paging"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some endpoints return the data sections as optional, on demand. The request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is done by giving the section name in the"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Part of the data is returned each time, the other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"section only on demand. This makes the responses smaller for those, who do"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not need the data"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", thus saving the volume of data transmitted and shortening the time to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, for \"Eshop Info\" endpoint, you will gain basic info when simply"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[GET] /api/eshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"methods and transport options only when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[GET] /api/eshop?include=paymentMethods,shippingMethods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More values are separated by a comma, no sequencing, no upper/lower case"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"differentiation. Other blocks are available on demand"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and each endpoint informs you which identifier to request."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/section-on-demand"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/section-on-demand"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/translations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Translations"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For proper functionality in translations you will have to get module Foreign"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"languages (Cizí jazyky) activated on customer e-shop. Multi-language support"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in API is handled by query parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which can be used in whole"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API. If parameter is not set, default shop language is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When module foreignLanguages is active and initialized, read endpoints (HTTP"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verb GET) will return corresponding language version of texts where applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For write endpoints, first use POST endpoint to create entity and then use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PATCH endpoint with corresponding language query parameter to set language"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields. Language can be set only when module foreignLanguages is active and initialized."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that in some endpoints (typically surcharge/filtering/variant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameters) you must use the identifier's currently selected language"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variant (which is filtered in list)."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/translations"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/translations"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For files upload, there are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file is uploaded to a temporary storage which is not accessible"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"publicly. The file is kept there for 7 days and then deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After you upload a file, you may copy it to some API entities in their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoints - you specify filename returned in response of upload job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that currently only images (png, jpg, gif, webp) are allowed filetypes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for file upload."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/basic-principles/files-upload"}],"sectionId":"/shoptet-api/openapi/section/basic-principles/files-upload"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/product-images"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product images"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shoptet saves the product images in their original size and then prepares"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"several sizes for standardized usage (called"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image cuts). These cuts are created in advance and saved on the disk, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they are readily available. The list of cuts is"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the same for each e-shop, and each e-shop can theoretically have different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cut sizes. In practice, their size is given"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the template and most templates use the same sizes. The list of provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cuts is given by"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/image-cuts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image cuts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the response, where each cut has the actual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"size defined, and the URL base path. There are two base URLs (example for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"classic.shoptet.cz, cut "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"https://classic.shoptet.cz/user/shop/detail/\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"https://cdn-api.myshoptet.com/usr/classic.shoptet.cz/user/shop/detail/\""},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in case you need an up-to-date image right now. Use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url for your backend processing and you"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will retrieve the images only once. Images retrieved via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cached. You can use image name or SEO version"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the image name - see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in case you want to use the image url on the frontend and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"users of your application will display it,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. if you provide an alternative frontend, mobile application etc. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images are cached and provided with lower"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"latency. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retrieved from the product detail endpoint (or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"similar) - see below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you determine the URL based on the purpose and image cut size (for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for product detail, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"related"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for product preview), just append the filename you need. The filename can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retrieved from Product detail endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Although the e-shop is behind the content delivery network (Cloudflare CDN),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API still returns the same domain. Whether"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the e-shop is behind the Cloudflare CDN, you can find out from response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"headers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CDN-Loop: cloudflare"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product detail endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/products/{guid}?include=images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the image field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.images[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the same"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sequence, as these are entered in administration. The file name "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100.jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") needs to be connected"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the URL cut and then you have complete path to the image of a given cut"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(size), for example"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://classic.shoptet.cz/user/shop/detail/100.jpg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can also use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seoName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which also contains a description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the image - you will be redirected to the same image. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"intended for use with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains a signed URL for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"big"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cut. For other cuts, use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signedCdnNames"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. Each element has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the cut code, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"big"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thumbnail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the pre-signed filename) that can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appended to the matching cut's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Old-format bare-hash URLs remain valid on the CDN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields look like: (excerpt)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \"name\": \"106.png\",\n \"description\": \"shamrock 2115611 640\",\n \"seoName\": \"106_shamrock-2115611-640.png\",\n \"cdnName\": \"106_shamrock-2115611-640.png?ff=1&x=1024&y=768&q=85&ts=5b2a41f5&sg=cce48299\",\n \"signedCdnNames\": [\n {\"type\": \"big\", \"name\": \"106_shamrock-2115611-640.png?ff=1&x=1024&y=768&q=85&ts=5b2a41f5&sg=cce48299\"},\n {\"type\": \"detail\", \"name\": \"106_shamrock-2115611-640.png?ff=1&x=423&y=318&q=85&ts=5b2a41f5&sg=265606b9\"}\n ]\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \"name\": \"106.png\",\n \"description\": \"shamrock 2115611 640\",\n \"seoName\": \"106_shamrock-2115611-640.png\",\n \"cdnName\": \"106_shamrock-2115611-640.png?ff=1&x=1024&y=768&q=85&ts=5b2a41f5&sg=cce48299\",\n \"signedCdnNames\": [\n {\"type\": \"big\", \"name\": \"106_shamrock-2115611-640.png?ff=1&x=1024&y=768&q=85&ts=5b2a41f5&sg=cce48299\"},\n {\"type\": \"detail\", \"name\": \"106_shamrock-2115611-640.png?ff=1&x=423&y=318&q=85&ts=5b2a41f5&sg=265606b9\"}\n ]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the images mentioned for the product can be selected as the default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image for the product variant. The selected"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.variants[].image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item and contains the name of the image"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"– this can be searched for in the image"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list, in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item. Should the variant have no preselected default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image, the parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.variants[].isProductDefaultImage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, then the default product image is given. If it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is the default variant image."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The item "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.items[].mainImage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the main image in order detail -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this is either a default variant image,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or, if not set (or product does not have variants), the default product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image is given. The structure is the same as"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in product details, but not all images are given here, only the default one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"– representative image. The full path can"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be gained by assembling the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the e-shop info and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seoName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" items, given for the order item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Similarly, the product list gives "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.products[].mainImage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mentions the initial image for each product."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/product-images"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/code-lists"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code lists"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/image-cuts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image cuts"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orig"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"original image (in the original resolution)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"big"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"big image (typically 1024x768 px)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image detail (typically 360x270 px)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"size for listing in category (typically 216x105 px)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"related"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"size for related products (typically 100x100 px)"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/image-cuts"}],"sectionId":"/shoptet-api/openapi/section/code-lists/image-cuts"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/product-visibility"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hide product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visible"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"blocked"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be ordered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"show-registered"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show only to logged-in users"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"block-unregistered"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not allow order to logged-out users"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cash-desk-only"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show only in cash desk"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detail-only"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not show e-shop navigation"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/product-visibility"}],"sectionId":"/shoptet-api/openapi/section/code-lists/product-visibility"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bazar"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second-hand product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"service"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gift-certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift (deprecated)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product-set"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product set"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/product-types"}],"sectionId":"/shoptet-api/openapi/section/code-lists/product-types"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/types-of-order-items"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of order items"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bazar"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second-hand product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"service"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipping"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transportation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount-coupon"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount coupon"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"volume-discount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume discount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gift"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gift-certificate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift certificate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generic-item"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-specific item"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product-set"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product set"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product-set-item"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product set item"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deposit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/types-of-order-items"}],"sectionId":"/shoptet-api/openapi/section/code-lists/types-of-order-items"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/sorting-of-products-in-category"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting of products in category"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"most-selling"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most selling first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cheapest"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cheapest first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"most-expensive"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most expensive first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"oldest"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Oldest first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"newest"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newest first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alphabetically"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetically"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alphabetically-desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphabetically, descending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product-code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per product code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product-code-desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per product code, descending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category-priority"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category priority"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category-priority-desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category priority, descending"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/sorting-of-products-in-category"}],"sectionId":"/shoptet-api/openapi/section/code-lists/sorting-of-products-in-category"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload supported"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"availability:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"availability:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"availability:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - brand unique code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - brand unique code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - brand unique code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditNote:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit note creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of credit note"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditNote:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit note deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of credit note"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditNote:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit note change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of credit note"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New customer was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer GUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer was updated. Throws "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when try to register simultaneously with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer:disableOrders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer:enableOrders"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer GUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer:disableOrders"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An event disabled the customer, and his future orders will be automatically cancelled. Throws "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when try to register simultaneously with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer GUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer:enableOrders"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An event enabled the customer's future orders. Throws "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when try to register simultaneously with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer GUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer:import"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import of 1 and more customers was executed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed string \"customers\""},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer was deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer GUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerGroup:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer group creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of customer group"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerGroup:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer group change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of customer group"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerGroup:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer group deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of customer group"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deliveryNote:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery note creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of delivery note"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deliveryNote:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery note deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of delivery note"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deliveryNote:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery note creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of delivery note"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deliveryNote:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery note change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of delivery note"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discountCoupon:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount coupon creating event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - discount coupon unique code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discountCoupon:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount coupon deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of discount coupon"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discountCoupon:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount coupon updating event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - discount coupon unique code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eshop:currencies"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currencies settings change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of eshop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eshop:billingInformation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing information (i.e. eshop billing address) change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of eshop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eshop:settingsInformation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Eshop settings change event. Whenever some attribute from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response section of GET eshop detail change"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of eshop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eshop:design"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Design settings (template, colors, fonts, layout)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of eshop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eshop:mandatoryFields"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory fields of customer were updated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of eshop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eshop:projectDomain"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain of eshop was changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of eshop"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"job:finished"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The asynchronous request was finished"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mailingListEmail:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-mail addition event into the e-mail distribution list"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of e-mail distribution list"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mailingListEmail:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-mail deleting event from the e-mail distribution list"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of e-mail distribution"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order:cancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order cancel event. Webhook is emitted when order status is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Throws "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when try to register simultaneously with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order:paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order paid event. Not emitted if a new order with paid status is created (register "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order:massCreate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Emitted only if the unpaid state is changed to paid during order update."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order change event. Throws "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when try to register simultaneously with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order:cancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderHistoryRemarks:change"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order history remarks have been changed. Emitted when order remark is created or deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of order"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderStatusesList:change"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status list change event. Emitted when order status is created, updated or deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricelist:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricelist creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of pricelist"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricelist:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricelist deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of pricelist"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentMethod:change"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method GUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proformaInvoice:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proforma invoice creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of proforma invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proformaInvoice:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proforma invoice deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of proforma invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proformaInvoice:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proforma invoice change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of proforma invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"projectReview:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Project review creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of project review"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product:create (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product:update (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product:delete (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productVariant:create (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product variant creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productVariant:update (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product variant change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productVariant:delete (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product variant deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productVariantPrice:update (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product variant price change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productReview:created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product review creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of product review"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proofPayment:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of payment creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of proof payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proofPayment:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of payment deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of proof payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proofPayment:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof of payment change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of proof payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quantityDiscount:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity discount creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of quantity discount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quantityDiscount:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity discount change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of quantity discount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quantityDiscount:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity discount deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of quantity discount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salesChannel:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales channel create event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUID of sales channel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salesChannel:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales channel update event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUID of Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salesChannel:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales channel delete event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUID of Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipment:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment confirmation event. Carrier confirmed the shipment (tracking number assigned, label ready)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUID of Shipment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipment:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment status change event (in transit, delivered, returned, closed, cancel requested, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipment:fail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment failure event. Status changed to failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shippingMethod:change"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping method change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping method GUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sectionArticle:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Article section create event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of article section"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sectionArticle:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Article section update event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of article section"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sectionArticle:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Article section delete event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of article section"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shippingRequest:cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping request was not chosen for order delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingRequestCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the cart"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shippingRequest:confirmed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping request was chosen for order delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingRequestCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the cart"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stock:movement"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stock change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stock ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stock:inStock (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stock change event - sum across all of the stocks raised above 0 (beta, see below)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stock:soldOut (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stock change event - sum across all of the stocks reached 0 (beta, see below)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stock:minStockSupplyReached (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stock change event - sum across all of the stocks reached minimum stock supply value, if this limit is set for product (beta, see below)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplier:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supplier creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of supplier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplier:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supplier change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of supplier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplier:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supplier deletion event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of supplier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warranty:create"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warranty creation event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warranty ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warranty:update"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warranty change event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warranty ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warranty:delete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warranty deleting event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warranty ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(*) These webhooks are considered beta/experimental, for more information, please visit the X-url"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/webhook-event-types"}],"sectionId":"/shoptet-api/openapi/section/code-lists/webhook-event-types"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/code-lists/mass-webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These webhooks are sent when a mass change of entities is performed. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payload contains a json serialized list of IDs of changed entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose of these webhooks is to downgrade number of requests, while i.e."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"administrator performs mass change of orders status at once etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"So instead of emitting one event for every order, we emit one event for all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For now, if some mass event is performed, we also sent \"single\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook event for every updated entity as usual, but it will be changed in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"future"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so please watch "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/category/api/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"release changes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more info"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload delivery (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) is not available for mass webhooks, which is why the table below has no "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column - it applies to single events only."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category:massCreate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass create of product categories event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product categories"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category:massUpdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass change of product categories event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product categories"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category:massDelete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass delete of product categories event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of product categories"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discountCoupon:massCreate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass create of discount coupons event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of discount coupons"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discountCoupon:massDelete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass delete of discount coupons event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of discount coupons"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice:massUpdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass change of invoices event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order:massCreate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass create of orders event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of orders"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order:massUpdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass change of orders event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of orders"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order:massPaid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass paid of orders event. Not emitted if a new mass orders with paid status are created (register "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order:massCreate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Emitted only if the unpaid state is changed to paid during mass orders update."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of orders"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product:massCreate (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass create of products event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product:massUpdate (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass change of products event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product:massDelete (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass delete of products event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of string ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productVariant:massCreate (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass create of product variants event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of variant codes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productVariant:massUpdate (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass change of product variants event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of variant codes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productVariant:massDelete (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass delete of product variants event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of variant codes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"productVariantPrice:massUpdate (*)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass change of product variant prices event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of variant codes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quantityDiscount:massDelete"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass delete of quantity discount event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of quantity discounts IDs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quantityDiscount:massUpdate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass change of quantity discount event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json serialized list of quantity discounts IDs"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/mass-webhooks"}],"sectionId":"/shoptet-api/openapi/section/code-lists/mass-webhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/code-lists/system-webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These webhooks cannot be registered via API, they are setup in Partners'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Addon administration section instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"addon:suspend"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addon was suspended by the eshop or by Shoptet operations staff"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"addon:approve"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addon was approved (resumed) after it was suspended"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"addon:terminate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addon was terminated by the eshop or by Shoptet operations staff"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"addon:uninstall"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The addon was uninstalled by the eshop admin or the eshop was terminated"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/system-webhooks"}],"sectionId":"/shoptet-api/openapi/section/code-lists/system-webhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/url-address-from-endpoint-eshop-info"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL address from endpoint Eshop info"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See endpoint "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/eshop/geteshopinfo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Eshop info"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ident"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"admin-orders-list"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing of orders in administration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"admin-customers-list"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of customers in administration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"oauth"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth server address, used for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/api/documentation/eshop-verification-using-oauth/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop user verification"},"children":[]}]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/url-address-from-endpoint-eshop-info"}],"sectionId":"/shoptet-api/openapi/section/code-lists/url-address-from-endpoint-eshop-info"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/list-of-product-catalogues"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of product catalogues"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider (identification)"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"glami"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Glami"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"google"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"heureka"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Heuréka"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zbozi"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zboží.cz"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/list-of-product-catalogues"}],"sectionId":"/shoptet-api/openapi/section/code-lists/list-of-product-catalogues"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COD (cz: Dobírka)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wire transfer (cz: Převodem)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash (cz: Hotově)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card (cz: Kartou)"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/invoice-billing-methods"}],"sectionId":"/shoptet-api/openapi/section/code-lists/invoice-billing-methods"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/vat-modes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT modes"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Normal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One Stop Shop"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mini One Stop Shop"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse charge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outside the EU"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/vat-modes"}],"sectionId":"/shoptet-api/openapi/section/code-lists/vat-modes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/shipment-carrier-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment carrier types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"core"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"external"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integration_product_contract"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balikobot"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/shipment-carrier-types"}],"sectionId":"/shoptet-api/openapi/section/code-lists/shipment-carrier-types"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/code-lists/shipment-statuses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment statuses"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requested"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request_failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in_transit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ready_for_pickup"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"carrier_issue"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"back_transit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"canceled"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancel_requested"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"closed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted"},"children":[]}]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/code-lists/shipment-statuses"}],"sectionId":"/shoptet-api/openapi/section/code-lists/shipment-statuses"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/postman-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use Postman as an API platform for building and using APIs, we provide you a complex collection of Shoptet API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have 2 options how to import our postman collection (created from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://swagger.io/specification/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"openApi schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - openapi.yaml ) into your postman client"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/postman-collection/fork-shoptet-api-collection-from-shoptet-public-api-workspace-(recommended)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fork Shoptet API Collection from Shoptet Public API Workspace (recommended)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.postman.com/shoptet-developers/shoptet-public-api-workspace"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shoptet Public API Workspace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also check postman documentation for more details: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fork a collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/fork-shoptet-api-collection-from-shoptet-public-api-workspace-(recommended)"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/fork-shoptet-api-collection-from-shoptet-public-api-workspace-(recommended)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/step-1:-navigate-to-shoptet-public-api-workspace"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1: Navigate to Shoptet Public API Workspace"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Launch Postman on your desktop or in the browser."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the search bar in the top header of app, type "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shoptet Public API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and select collection from Shoptet public API Workspace."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-1:-navigate-to-shoptet-public-api-workspace"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-1:-navigate-to-shoptet-public-api-workspace"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/step-2:-locate-the-shoptet-api-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2: Locate the Shoptet API Collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once inside the Shoptet Public API Workspace, go to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shoptet API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" collection."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-2:-locate-the-shoptet-api-collection"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-2:-locate-the-shoptet-api-collection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/step-3:-fork-the-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 3: Fork the Collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click on the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shoptet API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" collection to open it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the collection view, click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fork"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button in the top-right corner."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the fork dialog, choose a name for your forked collection."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Select the workspace where you want to save the forked collection."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It’s recommended to check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"watch original collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get notified about changes in the original collection."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fork Collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-3:-fork-the-collection"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-3:-fork-the-collection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/step-4:-access-your-forked-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 4: Access Your Forked Collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Navigate to the workspace where you saved the forked collection."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You’ll now find the forked "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shoptet API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" collection under the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab, ready for you to use and modify."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Now you have your own copy of the Shoptet API collection! If you want to add changes from the original collection, you can do so by click on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pull changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in collection settings."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-4:-access-your-forked-collection"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-4:-access-your-forked-collection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/postman-collection/import-openapi.yaml-into-postman-as-a-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import openapi.yaml into Postman as a Collection"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/import-openapi.yaml-into-postman-as-a-collection"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/import-openapi.yaml-into-postman-as-a-collection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/step-1:-upload-the"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1: Upload the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openapi.yaml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" File"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/shoptet/developers/blob/master/openapi/openapi.yaml"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"openapi.yaml"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file from our developers "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/shoptet/developers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repository"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Launch Postman on your desktop or in the browser."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the top-left corner of Postman, click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" button."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A pop-up window will appear."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drag and drop your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openapi.yaml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file into the window, or click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload Files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and browse to the file's location."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-1:-upload-the"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-1:-upload-the"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/step-2:-verify-openapi-import"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2: Verify OpenAPI Import"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman will automatically recognize the OpenAPI schema."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will display a preview of the API schema."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-2:-verify-openapi-import"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-2:-verify-openapi-import"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/step-3:-import-as-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 3: Import as Collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the file is recognized, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman will convert the OpenAPI schema into a collection of requests, based on the defined endpoints in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"openapi.yaml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-3:-import-as-collection"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-3:-import-as-collection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/postman-collection/step-4:-access-the-imported-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 4: Access the Imported Collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the import is successful, go to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You’ll find your new collection, named after the OpenAPI schema, containing all the API requests generated from the file."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Now you can explore the API endpoints and use them directly within Postman!"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-4:-access-the-imported-collection"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/step-4:-access-the-imported-collection"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/postman-collection/collection-settings"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collection settings"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shoptet API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" collection name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set your access token into the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shoptet-Access-Token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Go to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variables"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variable here."},"children":[]}]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/postman-collection/collection-settings"}],"sectionId":"/shoptet-api/openapi/section/postman-collection/collection-settings"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/sdk"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SDK"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The official PHP library for the Shoptet REST API. The SDK is open-source and available on both "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://packagist.org/packages/shoptet/api-sdk-php"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Packagist"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/shoptet/api-sdk"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GitHub"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/sdk/requirements"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PHP 8.3 or later"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/requirements"}],"sectionId":"/shoptet-api/openapi/section/sdk/requirements"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/sdk/dependencies"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependencies"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SDK requires the following extensions and libraries to work properly:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.php.net/manual/en/book.curl.php"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"curl"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — You can use your own non-cURL client if preferred."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.php.net/manual/en/book.json.php"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"json"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.php-fig.org/psr/psr-3/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"psr/log"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you use Composer, these dependencies will be handled automatically."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you install the library manually, please ensure that these extensions are available."},"children":[]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/dependencies"}],"sectionId":"/shoptet-api/openapi/section/sdk/dependencies"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/sdk/installation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Installation"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/installation"}],"sectionId":"/shoptet-api/openapi/section/sdk/installation"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/composer"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Composer"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can install the sdk via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://getcomposer.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Composer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Run the following command:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" composer require shoptet/api-sdk-php\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" composer require shoptet/api-sdk-php\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the sdk, use Composer's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://getcomposer.org/doc/01-basic-usage.md#autoloading"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"autoload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" require_once 'vendor/autoload.php';\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" require_once 'vendor/autoload.php';\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/composer"}],"sectionId":"/shoptet-api/openapi/section/sdk/composer"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/manual"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" require_once '/path/to/api-sdk-php/init.php';\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" require_once '/path/to/api-sdk-php/init.php';\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/manual"}],"sectionId":"/shoptet-api/openapi/section/sdk/manual"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/sdk/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/getting-started"}],"sectionId":"/shoptet-api/openapi/section/sdk/getting-started"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/simple-usage"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simple usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For authorization, you need to set the partner domain URL and the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If token does not exist or is expired, you will need to obtain it first. For Obtaining a fresh public API token, you need to have the OAuth token for the eshop. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/api/documentation/getting-api-access-token/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"how to get access token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" // Set partner domain URL for obtaining fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \n try {\n // Try to authorize request with token for some eshop\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n } catch (TokenHasExpiredException | TokenNotFoundException) {\n // If token has expired or not found, create fresh public API token with specific OAuth token for eshop.\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::createFreshPublicApiToken('token-for-target-eshop', 'oauth-token-for-target-eshop');\n // Try to authorize request again with fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n }\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" // Set partner domain URL for obtaining fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \n try {\n // Try to authorize request with token for some eshop\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n } catch (TokenHasExpiredException | TokenNotFoundException) {\n // If token has expired or not found, create fresh public API token with specific OAuth token for eshop.\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::createFreshPublicApiToken('token-for-target-eshop', 'oauth-token-for-target-eshop');\n // Try to authorize request again with fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can obtain oAuth access token after addon is installed in the eshop and you receive installation callback request. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/api/documentation/installing-the-addon/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"how to process addon installation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" // Set partner domain URL for obtaining fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n\n $requestData = new \\Shoptet\\Api\\Sdk\\Php\\Endpoint\\OAuth\\CreateOauthAccessToken\\CreateOauthAccessTokenRequestData([\n 'client_id' => 'some-client-id',\n 'client_secret' => 'some-client-secret',\n 'redirect_uri' => 'https://partner-redirect-domain.com/after/authorize',\n 'code' => 'fdqmcvw0b89p3xv31j7w....', // use code from request\n ]);\n\n $authorizationFacade = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createAuthorizationFacade();\n // obtain and store new OAuth token\n $authorizationFacade->addonInstallationCallback('oauth-token-for-target-eshop', $requestData);\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" // Set partner domain URL for obtaining fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n\n $requestData = new \\Shoptet\\Api\\Sdk\\Php\\Endpoint\\OAuth\\CreateOauthAccessToken\\CreateOauthAccessTokenRequestData([\n 'client_id' => 'some-client-id',\n 'client_secret' => 'some-client-secret',\n 'redirect_uri' => 'https://partner-redirect-domain.com/after/authorize',\n 'code' => 'fdqmcvw0b89p3xv31j7w....', // use code from request\n ]);\n\n $authorizationFacade = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createAuthorizationFacade();\n // obtain and store new OAuth token\n $authorizationFacade->addonInstallationCallback('oauth-token-for-target-eshop', $requestData);\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For storing tokens, there is in default basic implementation used "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FileTokenStorage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which stores tokens in the file system. Default path for storing tokens is:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" protected const string DEFAULT_FILE_STORAGE_PATH = '/tmp/shoptet-api';\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" protected const string DEFAULT_FILE_STORAGE_PATH = '/tmp/shoptet-api';\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This implementation is not recommended for production use. You should implement your own token storage which implements "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TokenStorage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" interface."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setTokenStorage(new MyTokenStorage());\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setTokenStorage(new MyTokenStorage());\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call endpoint with request body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n\n $createdBrandResponse = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createBrand([\n 'data' => [\n 'name' => 'Brand name',\n 'description' => 'Brand description',\n 'indexName' => 'brand-name',\n ]\n ]);\n\n $createdBrandResponse->getBody();\n //...\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n\n $createdBrandResponse = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createBrand([\n 'data' => [\n 'name' => 'Brand name',\n 'description' => 'Brand description',\n 'indexName' => 'brand-name',\n ]\n ]);\n\n $createdBrandResponse->getBody();\n //...\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://github.com/shoptet/api-sdk/blob/master/docs/request_body_processing_methods.md"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" about possible methods, how to call endpoints with request body."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginator"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n\n $listOfProductResponse = \\Shoptet\\Api\\Sdk\\Php\\Sdk::getListOfProducts();\n //... Process response\n try {\n $listOfProductResponseNextPage = $listOfProductResponse->getNextPage();\n } catch (\\Shoptet\\Api\\Sdk\\Php\\Exception\\OutOfRangeException $e) {\n //Next page is out of range - Last page already reached\n }\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n\n $listOfProductResponse = \\Shoptet\\Api\\Sdk\\Php\\Sdk::getListOfProducts();\n //... Process response\n try {\n $listOfProductResponseNextPage = $listOfProductResponse->getNextPage();\n } catch (\\Shoptet\\Api\\Sdk\\Php\\Exception\\OutOfRangeException $e) {\n //Next page is out of range - Last page already reached\n }\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/simple-usage"}],"sectionId":"/shoptet-api/openapi/section/sdk/simple-usage"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of supported webhooks can be found in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\Shoptet\\Api\\Sdk\\Php\\Webhook\\Event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enum."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the enum above or plain string in request body to register new webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" Sdk::registerNewWebhook([\n 'data' => [\n [\n 'event' => \\Shoptet\\Api\\Sdk\\Php\\Webhook\\Event::BRAND_CREATE,\n 'url' => 'https://my-domain.com/shoptet-webhook-consumer/brand-create'\n ]\n ],\n ]);\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" Sdk::registerNewWebhook([\n 'data' => [\n [\n 'event' => \\Shoptet\\Api\\Sdk\\Php\\Webhook\\Event::BRAND_CREATE,\n 'url' => 'https://my-domain.com/shoptet-webhook-consumer/brand-create'\n ]\n ],\n ]);\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/webhooks"}],"sectionId":"/shoptet-api/openapi/section/sdk/webhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/custom-header"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom header"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" // Add/remove custom header\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setHeader('X-MY-AWESOME-HEADER', 'my-awesome-header-value');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::unsetHeader('X-MY-AWESOME-HEADER');\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" // Add/remove custom header\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setHeader('X-MY-AWESOME-HEADER', 'my-awesome-header-value');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::unsetHeader('X-MY-AWESOME-HEADER');\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/custom-header"}],"sectionId":"/shoptet-api/openapi/section/sdk/custom-header"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/custom-request-timeouts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom request timeouts"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" $httpClient = \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient();\n\n /**\n * Set connection timeout on 60sec\n * Default is 30sec\n * @see \\Shoptet\\Api\\Sdk\\Php\\HttpClient\\CurlClient::DEFAULT_TIMEOUT\n */\n $httpClient->setTimeout(60);\n\n /**\n * Set timeout on 90sec\n * Default is 80sec\n * @see \\Shoptet\\Api\\Sdk\\Php\\HttpClient\\CurlClient::DEFAULT_CONNECT_TIMEOUT\n */\n $httpClient->setConnectTimeout(90);\n\n echo $httpClient->getTimeout(); // 60\n echo $httpClient->getConnectTimeout(); // 90\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" $httpClient = \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient();\n\n /**\n * Set connection timeout on 60sec\n * Default is 30sec\n * @see \\Shoptet\\Api\\Sdk\\Php\\HttpClient\\CurlClient::DEFAULT_TIMEOUT\n */\n $httpClient->setTimeout(60);\n\n /**\n * Set timeout on 90sec\n * Default is 80sec\n * @see \\Shoptet\\Api\\Sdk\\Php\\HttpClient\\CurlClient::DEFAULT_CONNECT_TIMEOUT\n */\n $httpClient->setConnectTimeout(90);\n\n echo $httpClient->getTimeout(); // 60\n echo $httpClient->getConnectTimeout(); // 90\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/custom-request-timeouts"}],"sectionId":"/shoptet-api/openapi/section/sdk/custom-request-timeouts"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/handling-rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handling Rate Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the API rate limit is exceeded, the SDK throws a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RateLimitExceededException"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can handle this exception by retrying the request after the suggested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date. For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.docs.shoptet.com/openapi/section/basic-principles/rate-limiting"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in the API documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" try {\n // ... Prepare the order entity\n // Send the request, which may exceed the rate limit\n $response = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createOrder($orderEntity);\n } catch (\\Shoptet\\Api\\Sdk\\Php\\Exception\\RateLimitExceededException $e) {\n // Try again after Retry-After\n $retryAfter = $e->getRetryAfter();\n // ...\n }\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" try {\n // ... Prepare the order entity\n // Send the request, which may exceed the rate limit\n $response = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createOrder($orderEntity);\n } catch (\\Shoptet\\Api\\Sdk\\Php\\Exception\\RateLimitExceededException $e) {\n // Try again after Retry-After\n $retryAfter = $e->getRetryAfter();\n // ...\n }\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/handling-rate-limits"}],"sectionId":"/shoptet-api/openapi/section/sdk/handling-rate-limits"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/custom-curl-options"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom cURL options"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can customize the default CurlClient with extra options. The keys should be valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CURLOPT_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" constants or their integer equivalents. The options will be used in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl_setopt_array()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" // Add/remove custom option in HttpClient\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient()\n ->addOption(CURLOPT_PROXY, 'my-proxy.local:80');\n ->removeOption(CURLOPT_PROXY);\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" // Add/remove custom option in HttpClient\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient()\n ->addOption(CURLOPT_PROXY, 'my-proxy.local:80');\n ->removeOption(CURLOPT_PROXY);\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/custom-curl-options"}],"sectionId":"/shoptet-api/openapi/section/sdk/custom-curl-options"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/response-body-type"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body type"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The SDK provides multiple options how to handle response body automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return response body as the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Factory class: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\EntityResponseFactory"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default option"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return response body as array"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Factory class: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\ArrayResponseFactory"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return response body as raw string"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Factory class: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\RawResponseFactory"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" echo get_class(\\Shoptet\\Api\\Sdk\\Php\\Sdk::getEshopInfo()->getBody()); // Shoptet\\Api\\Sdk\\Php\\Endpoint\\Eshop\\GetEshopInfoResponse\\GetEshopInfoResponse\n\n // Set response factory to ArrayResponseFactory so the response body will return as array (not the Entity)\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient()->setResponseFactory(new \\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\ArrayResponseFactory());\n\n echo gettype(\\Shoptet\\Api\\Sdk\\Php\\Sdk::getEshopInfo()->getBody()); // array\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" echo get_class(\\Shoptet\\Api\\Sdk\\Php\\Sdk::getEshopInfo()->getBody()); // Shoptet\\Api\\Sdk\\Php\\Endpoint\\Eshop\\GetEshopInfoResponse\\GetEshopInfoResponse\n\n // Set response factory to ArrayResponseFactory so the response body will return as array (not the Entity)\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient()->setResponseFactory(new \\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\ArrayResponseFactory());\n\n echo gettype(\\Shoptet\\Api\\Sdk\\Php\\Sdk::getEshopInfo()->getBody()); // array\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/response-body-type"}],"sectionId":"/shoptet-api/openapi/section/sdk/response-body-type"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/custom-httpclient"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom HttpClient"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If current HttpClient is not sufficient you can implement your own Client. The client must implement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\Shoptet\\Api\\Sdk\\Php\\HttpClient\\ClientInterface"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setHttpClient($httpClient);\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setHttpClient($httpClient);\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/custom-httpclient"}],"sectionId":"/shoptet-api/openapi/section/sdk/custom-httpclient"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/logger"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logger"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The library does minimal logging. Logging can be configured with a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.php-fig.org/psr/psr-3/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PSR-3 compatible logger"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Default Logger is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Psr\\Log\\NullLogger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - So the logs end up in the void."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setLogger($logger);\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" \\Shoptet\\Api\\Sdk\\Php\\Sdk::setLogger($logger);\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/logger"}],"sectionId":"/shoptet-api/openapi/section/sdk/logger"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/handeling-snapshot-endpoints-result"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handeling snapshot endpoints result"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need to process snapshot job result, i.e. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/products/snapshot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JobResultProcessor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or Sdk helper method "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sdk::processSnapshotResult"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This method gets job result file path from response and processes it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns an iterator over snapshot job result data. This method use Generator to process data with smaller memory footprint."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" $snapshotResultData = Sdk::processSnapshotResult('3xhzjz2');\n\n foreach ($snapshotResultData as $entity) {\n // do something with entity\n }\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" $snapshotResultData = Sdk::processSnapshotResult('3xhzjz2');\n\n foreach ($snapshotResultData as $entity) {\n // do something with entity\n }\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/handeling-snapshot-endpoints-result"}],"sectionId":"/shoptet-api/openapi/section/sdk/handeling-snapshot-endpoints-result"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/exceptions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exceptions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All exceptions should implement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shoptet\\Api\\Sdk\\Php\\Exception\\Exception"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are 3 base types of Exceptions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shoptet\\Api\\Sdk\\Php\\Exception\\LogicException"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shoptet\\Api\\Sdk\\Php\\Exception\\RuntimeException"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shoptet\\Api\\Sdk\\Php\\Exception\\ReflectionException"},"children":[]}]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/exceptions"}],"sectionId":"/shoptet-api/openapi/section/sdk/exceptions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/sdk/tests"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tests"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To run unit tests, use the following command:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":" composer test:unit\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":" composer test:unit\n"},"children":[]}]}]}],"sectionId":"/shoptet-api/openapi/section/sdk/tests"}],"sectionId":"/shoptet-api/openapi/section/sdk/tests"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/last-changes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last changes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last API changes are published on the [API news] page"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(https://developers.shoptet.com/category/api/)."},"children":[]}]}]}]}],"sectionId":"/shoptet-api/openapi/section/last-changes"}]}]}},{"type":"group","label":"Basic principles","link":"/shoptet-api/openapi/section/basic-principles","routeSlug":"/shoptet-api/openapi/section/basic-principles","items":[{"type":"link","label":"How to call API","link":"/shoptet-api/openapi/section/basic-principles/how-to-call-api","routeSlug":"/shoptet-api/openapi/section/basic-principles/how-to-call-api","content":null},{"type":"link","label":"For Addons","link":"/shoptet-api/openapi/section/basic-principles/for-addons","routeSlug":"/shoptet-api/openapi/section/basic-principles/for-addons","content":null},{"type":"link","label":"For private API access (Premium)","link":"/shoptet-api/openapi/section/basic-principles/for-private-api-access-(premium)","routeSlug":"/shoptet-api/openapi/section/basic-principles/for-private-api-access-(premium)","content":null},{"type":"link","label":"Rate limiting","link":"/shoptet-api/openapi/section/basic-principles/rate-limiting","routeSlug":"/shoptet-api/openapi/section/basic-principles/rate-limiting","content":null},{"type":"link","label":"Leaky bucket","link":"/shoptet-api/openapi/section/basic-principles/leaky-bucket","routeSlug":"/shoptet-api/openapi/section/basic-principles/leaky-bucket","content":null},{"type":"link","label":"Locks","link":"/shoptet-api/openapi/section/basic-principles/locks","routeSlug":"/shoptet-api/openapi/section/basic-principles/locks","content":null},{"type":"link","label":"Server response format","link":"/shoptet-api/openapi/section/basic-principles/server-response-format","routeSlug":"/shoptet-api/openapi/section/basic-principles/server-response-format","content":null},{"type":"link","label":"Deprecated header + Sunset","link":"/shoptet-api/openapi/section/basic-principles/deprecated-header-+-sunset","routeSlug":"/shoptet-api/openapi/section/basic-principles/deprecated-header-+-sunset","content":null},{"type":"link","label":"Status codes","link":"/shoptet-api/openapi/section/basic-principles/status-codes","routeSlug":"/shoptet-api/openapi/section/basic-principles/status-codes","content":null},{"type":"link","label":"Paging","link":"/shoptet-api/openapi/section/basic-principles/paging","routeSlug":"/shoptet-api/openapi/section/basic-principles/paging","content":null},{"type":"link","label":"Section on demand","link":"/shoptet-api/openapi/section/basic-principles/section-on-demand","routeSlug":"/shoptet-api/openapi/section/basic-principles/section-on-demand","content":null},{"type":"link","label":"Translations","link":"/shoptet-api/openapi/section/basic-principles/translations","routeSlug":"/shoptet-api/openapi/section/basic-principles/translations","content":null},{"type":"link","label":"Files upload","link":"/shoptet-api/openapi/section/basic-principles/files-upload","routeSlug":"/shoptet-api/openapi/section/basic-principles/files-upload","content":null}],"content":null},{"type":"link","label":"Product images","link":"/shoptet-api/openapi/section/product-images","routeSlug":"/shoptet-api/openapi/section/product-images","content":null},{"type":"group","label":"Code lists","link":"/shoptet-api/openapi/section/code-lists","routeSlug":"/shoptet-api/openapi/section/code-lists","items":[{"type":"link","label":"Image cuts","link":"/shoptet-api/openapi/section/code-lists/image-cuts","routeSlug":"/shoptet-api/openapi/section/code-lists/image-cuts","content":null},{"type":"link","label":"Product visibility","link":"/shoptet-api/openapi/section/code-lists/product-visibility","routeSlug":"/shoptet-api/openapi/section/code-lists/product-visibility","content":null},{"type":"link","label":"Product types","link":"/shoptet-api/openapi/section/code-lists/product-types","routeSlug":"/shoptet-api/openapi/section/code-lists/product-types","content":null},{"type":"link","label":"Types of order items","link":"/shoptet-api/openapi/section/code-lists/types-of-order-items","routeSlug":"/shoptet-api/openapi/section/code-lists/types-of-order-items","content":null},{"type":"link","label":"Sorting of products in category","link":"/shoptet-api/openapi/section/code-lists/sorting-of-products-in-category","routeSlug":"/shoptet-api/openapi/section/code-lists/sorting-of-products-in-category","content":null},{"type":"link","label":"Webhook event types","link":"/shoptet-api/openapi/section/code-lists/webhook-event-types","routeSlug":"/shoptet-api/openapi/section/code-lists/webhook-event-types","content":null},{"type":"link","label":"Mass Webhooks","link":"/shoptet-api/openapi/section/code-lists/mass-webhooks","routeSlug":"/shoptet-api/openapi/section/code-lists/mass-webhooks","content":null},{"type":"link","label":"System Webhooks","link":"/shoptet-api/openapi/section/code-lists/system-webhooks","routeSlug":"/shoptet-api/openapi/section/code-lists/system-webhooks","content":null},{"type":"link","label":"URL address from endpoint Eshop info","link":"/shoptet-api/openapi/section/code-lists/url-address-from-endpoint-eshop-info","routeSlug":"/shoptet-api/openapi/section/code-lists/url-address-from-endpoint-eshop-info","content":null},{"type":"link","label":"List of product catalogues","link":"/shoptet-api/openapi/section/code-lists/list-of-product-catalogues","routeSlug":"/shoptet-api/openapi/section/code-lists/list-of-product-catalogues","content":null},{"type":"link","label":"Invoice billing methods","link":"/shoptet-api/openapi/section/code-lists/invoice-billing-methods","routeSlug":"/shoptet-api/openapi/section/code-lists/invoice-billing-methods","content":null},{"type":"link","label":"VAT modes","link":"/shoptet-api/openapi/section/code-lists/vat-modes","routeSlug":"/shoptet-api/openapi/section/code-lists/vat-modes","content":null},{"type":"link","label":"Shipment carrier types","link":"/shoptet-api/openapi/section/code-lists/shipment-carrier-types","routeSlug":"/shoptet-api/openapi/section/code-lists/shipment-carrier-types","content":null},{"type":"link","label":"Shipment statuses","link":"/shoptet-api/openapi/section/code-lists/shipment-statuses","routeSlug":"/shoptet-api/openapi/section/code-lists/shipment-statuses","content":null}],"content":null},{"type":"group","label":"Postman collection","link":"/shoptet-api/openapi/section/postman-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection","items":[{"type":"link","label":"Fork Shoptet API Collection from Shoptet Public API Workspace (recommended)","link":"/shoptet-api/openapi/section/postman-collection/fork-shoptet-api-collection-from-shoptet-public-api-workspace-(recommended)","routeSlug":"/shoptet-api/openapi/section/postman-collection/fork-shoptet-api-collection-from-shoptet-public-api-workspace-(recommended)","content":null},{"type":"link","label":"Step 1: Navigate to Shoptet Public API Workspace","link":"/shoptet-api/openapi/section/postman-collection/step-1:-navigate-to-shoptet-public-api-workspace","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-1:-navigate-to-shoptet-public-api-workspace","content":null},{"type":"link","label":"Step 2: Locate the Shoptet API Collection","link":"/shoptet-api/openapi/section/postman-collection/step-2:-locate-the-shoptet-api-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-2:-locate-the-shoptet-api-collection","content":null},{"type":"link","label":"Step 3: Fork the Collection","link":"/shoptet-api/openapi/section/postman-collection/step-3:-fork-the-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-3:-fork-the-collection","content":null},{"type":"link","label":"Step 4: Access Your Forked Collection","link":"/shoptet-api/openapi/section/postman-collection/step-4:-access-your-forked-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-4:-access-your-forked-collection","content":null},{"type":"link","label":"Import openapi.yaml into Postman as a Collection","link":"/shoptet-api/openapi/section/postman-collection/import-openapi.yaml-into-postman-as-a-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/import-openapi.yaml-into-postman-as-a-collection","content":null},{"type":"link","label":"Step 1: Upload the ","link":"/shoptet-api/openapi/section/postman-collection/step-1:-upload-the","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-1:-upload-the","content":null},{"type":"link","label":"Step 2: Verify OpenAPI Import","link":"/shoptet-api/openapi/section/postman-collection/step-2:-verify-openapi-import","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-2:-verify-openapi-import","content":null},{"type":"link","label":"Step 3: Import as Collection","link":"/shoptet-api/openapi/section/postman-collection/step-3:-import-as-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-3:-import-as-collection","content":null},{"type":"link","label":"Step 4: Access the Imported Collection","link":"/shoptet-api/openapi/section/postman-collection/step-4:-access-the-imported-collection","routeSlug":"/shoptet-api/openapi/section/postman-collection/step-4:-access-the-imported-collection","content":null},{"type":"link","label":"Collection settings","link":"/shoptet-api/openapi/section/postman-collection/collection-settings","routeSlug":"/shoptet-api/openapi/section/postman-collection/collection-settings","content":null}],"content":null},{"type":"group","label":"SDK","link":"/shoptet-api/openapi/section/sdk","routeSlug":"/shoptet-api/openapi/section/sdk","items":[{"type":"link","label":"Requirements","link":"/shoptet-api/openapi/section/sdk/requirements","routeSlug":"/shoptet-api/openapi/section/sdk/requirements","content":null},{"type":"link","label":"Dependencies","link":"/shoptet-api/openapi/section/sdk/dependencies","routeSlug":"/shoptet-api/openapi/section/sdk/dependencies","content":null},{"type":"link","label":"Installation","link":"/shoptet-api/openapi/section/sdk/installation","routeSlug":"/shoptet-api/openapi/section/sdk/installation","content":null},{"type":"link","label":"Composer","link":"/shoptet-api/openapi/section/sdk/composer","routeSlug":"/shoptet-api/openapi/section/sdk/composer","content":null},{"type":"link","label":"Manual","link":"/shoptet-api/openapi/section/sdk/manual","routeSlug":"/shoptet-api/openapi/section/sdk/manual","content":null},{"type":"link","label":"Getting Started","link":"/shoptet-api/openapi/section/sdk/getting-started","routeSlug":"/shoptet-api/openapi/section/sdk/getting-started","content":null},{"type":"link","label":"Simple usage","link":"/shoptet-api/openapi/section/sdk/simple-usage","routeSlug":"/shoptet-api/openapi/section/sdk/simple-usage","content":null},{"type":"link","label":"Webhooks","link":"/shoptet-api/openapi/section/sdk/webhooks","routeSlug":"/shoptet-api/openapi/section/sdk/webhooks","content":null},{"type":"link","label":"Custom header","link":"/shoptet-api/openapi/section/sdk/custom-header","routeSlug":"/shoptet-api/openapi/section/sdk/custom-header","content":null},{"type":"link","label":"Custom request timeouts","link":"/shoptet-api/openapi/section/sdk/custom-request-timeouts","routeSlug":"/shoptet-api/openapi/section/sdk/custom-request-timeouts","content":null},{"type":"link","label":"Handling Rate Limits","link":"/shoptet-api/openapi/section/sdk/handling-rate-limits","routeSlug":"/shoptet-api/openapi/section/sdk/handling-rate-limits","content":null},{"type":"link","label":"Custom cURL options","link":"/shoptet-api/openapi/section/sdk/custom-curl-options","routeSlug":"/shoptet-api/openapi/section/sdk/custom-curl-options","content":null},{"type":"link","label":"Response body type","link":"/shoptet-api/openapi/section/sdk/response-body-type","routeSlug":"/shoptet-api/openapi/section/sdk/response-body-type","content":null},{"type":"link","label":"Custom HttpClient","link":"/shoptet-api/openapi/section/sdk/custom-httpclient","routeSlug":"/shoptet-api/openapi/section/sdk/custom-httpclient","content":null},{"type":"link","label":"Logger","link":"/shoptet-api/openapi/section/sdk/logger","routeSlug":"/shoptet-api/openapi/section/sdk/logger","content":null},{"type":"link","label":"Handeling snapshot endpoints result","link":"/shoptet-api/openapi/section/sdk/handeling-snapshot-endpoints-result","routeSlug":"/shoptet-api/openapi/section/sdk/handeling-snapshot-endpoints-result","content":null},{"type":"link","label":"Exceptions","link":"/shoptet-api/openapi/section/sdk/exceptions","routeSlug":"/shoptet-api/openapi/section/sdk/exceptions","content":null},{"type":"link","label":"Tests","link":"/shoptet-api/openapi/section/sdk/tests","routeSlug":"/shoptet-api/openapi/section/sdk/tests","content":null}],"content":null},{"type":"link","label":"Last changes","link":"/shoptet-api/openapi/section/last-changes","routeSlug":"/shoptet-api/openapi/section/last-changes","content":null},{"type":"separator","label":"Orders","content":null},{"type":"group","label":"Orders","link":"/shoptet-api/openapi/orders","routeSlug":"/shoptet-api/openapi/orders","items":[{"label":"List of orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlistoforders","routeSlug":"/shoptet-api/openapi/orders/getlistoforders","metadata":{"seo":{"title":"List of orders","description":"List of orders in e-shop and cash desks. Endpoint supports Paging. For default calls, it returns 50 orders,"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfOrders","name":"List of orders","isWebhook":false,"pointer":"/paths/~1api~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of orders in e-shop and cash desks. Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For default calls, it returns 50 orders,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using the parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?itemsPerPage=100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can request up to 100"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders at a time. Temporarily disabled, only 50 orders per page is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported. We apologize for the inconvenience."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list can be filtered according to status, transport, payment, date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of creation, order number and customer number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is the order identifier. Although this is usually a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number, it is necessary to take into account that this might also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include letters, dash, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request parameter to get the list of specific orders. Order codes are separated by a comma. If you use this query parameter, other filters are not applied, and the set of particular orders is returned. Please note that this parameter "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepts max. 50 order codes in request parameter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"statusId","in":"query","schemaId":"schema_522","description":"Purchase order filtering, according to order status id.","example":-1},{"name":"shippingGuid","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to forwarder GUID.","example":"ecb3e399-2f57-11eb-8853-0800275177b9"},{"name":"shippingCompanyCode","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to forwarder "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/shipping-methods/getlistofshippingmethods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"zasilkovna"},{"name":"paymentMethodGuid","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to payment method.","example":"b57f91bb-e920-11e0-baa3-7dc668b75ca8"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to date of creation. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2014-09-05T00:00:00%2B0000"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to date of creation. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2014-09-05T00:00:00%2B0000"},{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to order code.","example":"0000000006"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to order code.","example":"0000000006"},{"name":"customerGuid","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to customer number.","example":"443cad54-73bc-11e8-8216-002590dad85e"},{"name":"email","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to customer e-mail. The accurate\nmatch is searched for, regardless of capitalization.","example":"john.doe@example.com"},{"name":"phone","in":"query","schemaId":"schema_524","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to customer phone. International"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format only (+420123456789)"},"children":[]}]}]}]},{"name":"productCode","in":"query","schemaId":"schema_525","description":"Order filter by product's code that is in order."},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to date of last update. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2014-09-05T00:00:00%2B0000"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to date of last update. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2014-09-05T00:00:00%2B0000"},{"name":"sourceId","in":"query","schemaId":"schema_522","description":"Order source filtering according to source id. For more information,\nsee List of order sources endpoint.","example":-1},{"name":"orderCodes","in":"query","schemaId":"schema_523","description":"Define the output set of orders. Use max. 50 order codes separated by a comma. No additional filters take\neffect.","example":"2025000004,2025000002,2017000038,2017000025,2015000248"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 50.","example":44},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"statusId","in":"query","example":-1,"schemaId":"schema_522"},{"name":"shippingGuid","in":"query","example":"ecb3e399-2f57-11eb-8853-0800275177b9","schemaId":"schema_523"},{"name":"shippingCompanyCode","in":"query","example":"zasilkovna","schemaId":"schema_523"},{"name":"paymentMethodGuid","in":"query","example":"b57f91bb-e920-11e0-baa3-7dc668b75ca8","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"codeFrom","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"customerGuid","in":"query","example":"443cad54-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"email","in":"query","example":"john.doe@example.com","schemaId":"schema_523"},{"name":"phone","in":"query","example":"+420123456789","schemaId":"schema_524"},{"name":"productCode","in":"query","example":"15/ZLU","schemaId":"schema_525"},{"name":"changeTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"sourceId","in":"query","example":-1,"schemaId":"schema_522"},{"name":"orderCodes","in":"query","example":"2025000004,2025000002,2017000038,2017000025,2015000248","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":44,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/orders","href":"orders/getlistoforders","openApiOperationId":"getListOfOrders","summary":"List of orders","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1orders/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getlistoforders"}],"panels":[]}]},"httpPath":"/api/orders"},{"label":"Order insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/createorder","routeSlug":"/shoptet-api/openapi/orders/createorder","metadata":{"seo":{"title":"Order insertion","description":"This endpoint enables insert the order into Shoptet, which was createdin other system. You can use it for an import"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrder","name":"Order insertion","isWebhook":false,"pointer":"/paths/~1api~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint enables insert the order into Shoptet, which was created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in other system. You can use it for an import"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from an older e-shop solution, or to transfer orders from external sales"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channels."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A large amount of info can be set, but for regular usage only a few"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes are needed. Values of other"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attributes are added as per their default values. The detailed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information can be found in the right pane, after"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"clicking on title \"Order insertion\" above (search for \"Request\" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Attributes” sections)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request is sent in JSON format in its body. Simple example (detailed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example can be found in call example in right pane):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n{\n \"data\": {\n \"email\": \"foo@bar.cz\",\n \"externalCode\": \"123\",\n \"paymentMethodGuid\": \"6f2c8e36-3faf-11e2-a723-705ab6a2ba75\",\n \"shippingGuid\": \"8921cdc1-051b-11e5-a8d3-ac162d8a2454\",\n \"billingAddress\": {\n \"fullName\": \"Jan Novák\",\n \"street\": \"Rovná\",\n \"city\": \"Rovina\",\n \"zip\": \"12300\"\n },\n \"currency\": {\n \"code\": \"CZK\"\n },\n \"items\": [\n {\n \"itemType\": \"product\",\n \"code\": \"32/ZEL\",\n \"vatRate\": \"21.00\",\n \"itemPriceWithVat\": \"121.00\"\n },\n {\n \"itemType\": \"billing\",\n \"name\": \"Platba převodem\",\n \"vatRate\": \"21.00\",\n \"itemPriceWithVat\": \"0\"\n },\n {\n \"itemType\": \"shipping\",\n \"name\": \"PPL\",\n \"vatRate\": \"21.00\",\n \"itemPriceWithVat\": \"59.00\"\n }\n ]\n }\n}\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n{\n \"data\": {\n \"email\": \"foo@bar.cz\",\n \"externalCode\": \"123\",\n \"paymentMethodGuid\": \"6f2c8e36-3faf-11e2-a723-705ab6a2ba75\",\n \"shippingGuid\": \"8921cdc1-051b-11e5-a8d3-ac162d8a2454\",\n \"billingAddress\": {\n \"fullName\": \"Jan Novák\",\n \"street\": \"Rovná\",\n \"city\": \"Rovina\",\n \"zip\": \"12300\"\n },\n \"currency\": {\n \"code\": \"CZK\"\n },\n \"items\": [\n {\n \"itemType\": \"product\",\n \"code\": \"32/ZEL\",\n \"vatRate\": \"21.00\",\n \"itemPriceWithVat\": \"121.00\"\n },\n {\n \"itemType\": \"billing\",\n \"name\": \"Platba převodem\",\n \"vatRate\": \"21.00\",\n \"itemPriceWithVat\": \"0\"\n },\n {\n \"itemType\": \"shipping\",\n \"name\": \"PPL\",\n \"vatRate\": \"21.00\",\n \"itemPriceWithVat\": \"59.00\"\n }\n ]\n }\n}\n\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the field is mandatory, apart from the basic definition, also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"depends on whether the order was created via the cash desk"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashDeskOrder: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or via e-shop. Some fields from invoicing,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery and contact data"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are mandatory or optional, as per e-shop settings (see also e-shop"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"administration "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settings > Customers > Mandatory fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the order is created, it is checked, whether the e-shop includes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products with the respective code (can be suppressed with"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressProductChecking=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the products from the order are deducted from the stock (can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suppressed with the GET parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressStockMovements=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation is created for the order (can be suppressed with the GET parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressDocumentGeneration=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a confirmation e-mail is sent (can be suppressed with the GET parameter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressEmailSending=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a webhook is executed for the new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"**Parameters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressProductChecking=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressStockMovements=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are to be used only for orders that will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not be changed or deleted in the future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Editing or deleting such an order can damage the consistency of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warehousing.**"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressHistoricalMandatoryFields=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"disable mandatory fields checks, but only for \"historical\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creationTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is older than 24 hours). Keep in mind even"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"historical orders should be kept consistent and complete"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as much as possible to allow their processing for statistics, volume"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculations etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting the mandatory items for invoicing and the delivery address can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be different between individual e-shops. The mandatory items corresponds"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to the settings"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for ordering from the basket."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressHistoricalPaymentChecking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressHistoricalShippingChecking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allow corresponding field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In that case, if an billing/shipping item is provided in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field must be filled in that item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To remove products from the stock, the shop (or product) setting as to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether the inventory can be negative or not is respected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a negative value is not permitted for shopping and the order cannot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be covered from the current inventory, the order is not created and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns an error message in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order's minimum size or maximum number of items as per the settings"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of e-shop are not checked."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint only checks the same parameters as the order detail."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order can be inserted while using currencies setup in the eshop (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The exchange rate related to the"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"eshop default currency is optional. If not provided, the current eshop"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exchange rate will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For historical orders the exchange rate should be provided using the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"historical value of the order's creation date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shoptet eshops do not store historical exchange rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warning: for SK and CZ different exchange rate format is used. You"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should use the same form as you get from the endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". We will internally convert it to the correct format to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"compatible with eshop statistics calculations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because of the conversion, the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be different (inverse) to the one you had sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When entering the order, the initial welcome e-mail is always sent. Even"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"though the order status is set differently to the initial value,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the e-mail associated with a status change is not sent, but the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"welcome e-mail is (to e-shop operator and customer)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating the receipt (invoice, proforma invoice, delivery note) the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receipt is created with the current date and the 14 days due date, even"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"though"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"creationTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is given from the past."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples of how to work with the order and items statuses, and how to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ensure the correct insertion of a discount, can be found in a"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"separate "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/api/documentation/creating-order/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"article at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"developers.shoptet.com"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the order is successfully created, you will receive a response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with a 201 code and a response structure matching the order detail,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/orders/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note following rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 10 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 100 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 32 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.fullName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.street"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.houseNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.district"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.additional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.regionName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.regionShortcut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 18 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.vatId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 16 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.taxId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 16 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.fullName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.street"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.houseNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.district"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.additional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.regionName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.regionShortcut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes.trackingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 32 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 250 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.variantName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 128 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.brand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 64 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.supplierName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 64 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.additionalField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.amountUnit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 16 characters"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressDocumentGeneration","in":"query","schemaId":"schema_529","description":"suppress the generation of linked documents.","example":true},{"name":"suppressEmailSending","in":"query","schemaId":"schema_529","description":"suppress sending the linked information e-mails.","example":true},{"name":"suppressProductChecking","in":"query","schemaId":"schema_529","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suppress the product existence check as per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and GUID"},"children":[]}]}]}],"example":true},{"name":"suppressStockMovements","in":"query","schemaId":"schema_529","description":"suppress deduction of the products from stock","example":true},{"name":"suppressHistoricalMandatoryFields","in":"query","schemaId":"schema_529","description":"set the flag that disables mandatory fields checking","example":true},{"name":"suppressHistoricalPaymentChecking","in":"query","schemaId":"schema_529","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set the flag that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"example":true},{"name":"suppressHistoricalShippingChecking","in":"query","schemaId":"schema_529","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set the flag that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1api~1orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530","pointer":"/paths/~1api~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"suppressDocumentGeneration","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressEmailSending","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressProductChecking","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressStockMovements","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressHistoricalMandatoryFields","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressHistoricalPaymentChecking","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressHistoricalShippingChecking","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_530"}},"responseCodes":["201","403","422"],"pointer":"/api/orders","href":"orders/createorder","openApiOperationId":"createOrder","summary":"Order insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_530"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"},{"code":"403","description":"Consumption tax module is not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/post/responses/403/content/application~1json/example"]},{"code":"422","description":"Consumption tax id not exists / not visible","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1orders/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/post/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1orders/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/createorder"}],"panels":[]}]},"httpPath":"/api/orders"},{"label":"List of all orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlistofallorders","routeSlug":"/shoptet-api/openapi/orders/getlistofallorders","metadata":{"seo":{"title":"List of all orders","description":"Using this endpoint, you can get list of all orders with detailed info of each order (like in Order Detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllOrders","name":"List of all orders","isWebhook":false,"pointer":"/paths/~1api~1orders~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all orders with detailed info of each order (like in Order Detail endpoint) asynchronously. See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list may be filtered by date of creation and order code. The code is the order identifier. Although this is usually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a number, it is necessary to take into account that this might also include letters, dash, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each order taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One order in response has the same format as order detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/ordersnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are exported only when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order remarks, including up to six additional fields, which can be freely used by e-shop for its individual needs. The field names can be defined in administration and this section returns their names."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"images"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order images"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingDetails"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transport details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stockLocation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position in the stock"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productFlags"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item product flags"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request parameter to get the list of specific orders. Order codes are separated by a comma. If you use this query parameter, other filters are not applied, and the set of particular orders is returned. Please note that this parameter "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepts max. 50 order codes in request parameter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parts of response. Available values are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes,images,shippingDetails,stockLocation,surchargeParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"orderCodes","in":"query","schemaId":"schema_523","description":"Define the output set of orders. Use max. 50 order codes separated by a comma. No additional filters take\neffect.","example":"2025000004,2025000002,2017000038,2017000025,2015000248"},{"name":"statusId","in":"query","schemaId":"schema_522","description":"Purchase order filtering, according to order status id.","example":-1},{"name":"shippingGuid","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to forwarder GUID.","example":"ecb3e399-2f57-11eb-8853-0800275177b9"},{"name":"shippingCompanyCode","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to forwarder "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/shipping-methods/getlistofshippingmethods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"zasilkovna"},{"name":"paymentMethodGuid","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to payment method.","example":"b57f91bb-e920-11e0-baa3-7dc668b75ca8"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to date of creation. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2014-09-05T00:00:00%2B0000"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to date of creation. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2014-09-05T00:00:00%2B0000"},{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to order code.","example":"0000000006"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to order code.","example":"0000000006"},{"name":"customerGuid","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to customer number.","example":"443cad54-73bc-11e8-8216-002590dad85e"},{"name":"email","in":"query","schemaId":"schema_523","description":"Purchase order filtering, according to customer e-mail. The accurate\nmatch is searched for, regardless of capitalization.","example":"john.doe@example.com"},{"name":"phone","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to customer phone. International"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format only (+420123456789)"},"children":[]}]}]}],"example":"+420123456789"},{"name":"productCode","in":"query","schemaId":"schema_523","description":"Order filter by product's code that is in order.","example":"15/ZLU"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to date of last update. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2014-09-05T00:00:00%2B0000"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purchase order filtering, according to date of last update. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2014-09-05T00:00:00%2B0000"},{"name":"sourceId","in":"query","schemaId":"schema_522","description":"Order source filtering according to source id. For more information,\nsee List of order sources endpoint.","example":-1}],"pointer":"/paths/~1api~1orders~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_523"},{"name":"orderCodes","in":"query","example":"2025000004,2025000002,2017000038,2017000025,2015000248","schemaId":"schema_523"},{"name":"statusId","in":"query","example":-1,"schemaId":"schema_522"},{"name":"shippingGuid","in":"query","example":"ecb3e399-2f57-11eb-8853-0800275177b9","schemaId":"schema_523"},{"name":"shippingCompanyCode","in":"query","example":"zasilkovna","schemaId":"schema_523"},{"name":"paymentMethodGuid","in":"query","example":"b57f91bb-e920-11e0-baa3-7dc668b75ca8","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"codeFrom","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"customerGuid","in":"query","example":"443cad54-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"email","in":"query","example":"john.doe@example.com","schemaId":"schema_523"},{"name":"phone","in":"query","example":"+420123456789","schemaId":"schema_523"},{"name":"productCode","in":"query","example":"15/ZLU","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"sourceId","in":"query","example":-1,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202","400"],"pointer":"/api/orders/snapshot","href":"orders/getlistofallorders","openApiOperationId":"getListOfAllOrders","summary":"List of all orders","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1snapshot/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1snapshot/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1snapshot/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1snapshot/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getlistofallorders"}],"panels":[]}]},"httpPath":"/api/orders/snapshot"},{"label":"Bulk order status change","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/bulkorderstatuschange","routeSlug":"/shoptet-api/openapi/orders/bulkorderstatuschange","metadata":{"seo":{"title":"Bulk order status change","description":"The endpoint allows you to change the status for multiple order codes simultaneously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkOrderStatusChange","name":"Bulk order status change","isWebhook":false,"pointer":"/paths/~1api~1orders~1status-change/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk order status change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint allows you to change the status for multiple order codes simultaneously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-existing order codes are skipped and summarized in response errors. The request process continues even if some"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order codes are skipped."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you try to set the status that the order already has, no change is done and the request process continues."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If at least one order code is processed successfully, the response code is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all the order codes are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"skipped, the response code is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If basic validation of data fails, the response code is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is not processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status definition can include an e-mail/SMS sending, or document generation. To suppress these types of consequences"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can use following query parameters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressEmailSending=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressSmsSending=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressDocumentGeneration=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressDocumentGeneration","in":"query","schemaId":"schema_529","description":"Suppress the generation of linked documents.","example":true},{"name":"suppressEmailSending","in":"query","schemaId":"schema_529","description":"Suppress sending the linked information e-mails.","example":true},{"name":"suppressSmsSending","in":"query","schemaId":"schema_529","description":"Suppress sending the linked information SMS messages.","example":true}],"pointer":"/paths/~1api~1orders~1status-change/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1status-change/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_533"}},"schemaId":"schema_533","pointer":"/paths/~1api~1orders~1status-change/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/orders/status-change","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"suppressDocumentGeneration","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressEmailSending","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressSmsSending","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_533"}},"responseCodes":["200","400","422"],"pointer":"/api/orders/status-change","href":"orders/bulkorderstatuschange","openApiOperationId":"bulkOrderStatusChange","summary":"Bulk order status change","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_533","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_533"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1status-change/patch/responses/400/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1status-change/patch/responses/400/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1status-change/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1status-change/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1status-change/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1status-change/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1status-change/patch/responses/400/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1status-change/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1status-change/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/bulkorderstatuschange"}],"panels":[]}]},"httpPath":"/api/orders/status-change"},{"label":"Order detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getorderdetail","routeSlug":"/shoptet-api/openapi/orders/getorderdetail","metadata":{"seo":{"title":"Order detail","description":"This endpoint has several sections, which are only sent when requestedin the include parameter (see Section on demand)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderDetail","name":"Order detail","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order remarks, including up to six additional fields, which can be freely used by e-shop for its individual needs. The field names can be defined in administration and this section returns their names."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"images"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order images"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingDetails"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transport details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stockLocation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position in the stock"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentTransactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment transactions within the order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productFlags"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item product flags"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the detail for one order. In the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, the individual"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"items of the order, including transport and payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product name and variants, weight, manufacturer and similar items"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are copied into the order items when the order is made."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Even though the products are changed later in the shop, the orders are not affected. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item contains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUID of purchased product. If this is changed or deleted, the order is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not affected. You have to take into account that"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not have to refer to an existing product. The same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"goes for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item, containing the identification of a purchased"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variant or product. You have to take into account that when deleting the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product or changing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the product, the reference from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is lost. In other words, you have to take into account the fact that the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not have to refer to one of the currently"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"existing"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products (variant). They may also be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In most cases the items in the response are the same as you can see in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the administration of PDF printout of an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are however some advanced cases (in case of coupon discount with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"absolute value or in case of"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a volume discount and products with multiple VAT rates in the order), in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which case they are different:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administration and PDF will show multiple rows for the discount – for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"each VAT rate one row and the price field split evenly."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API response will return only one row indicating the total price"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the discount."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The difference is based on how data is internally stored and presented."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API is bases more on internal storage principle,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there is however also an array "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayPrices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which contains the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"presentation (printout) version of each item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you state the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter within the URL, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information about the main image for all products in the order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will also be part of the response. For more information about access to images go to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Product-images"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product images"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section, there is an information about shipping"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the order. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the identification of the carrier's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"branch and"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"next fields are used for the detail of the branch (name, address, etc.)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"carrierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for the numeral identification of the carrier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nowadays this field"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is used for Zasilkovna only and the value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Czech"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zasilkovna or integer for Zasilkovna in the other countries."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000012"}],"pointer":"/paths/~1api~1orders~1{code}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"optional parts of response","example":"notes,images,shippingDetails,stockLocation,productFlags"}],"pointer":"/paths/~1api~1orders~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","example":"notes,images,shippingDetails,stockLocation,productFlags","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/{code}","href":"orders/getorderdetail","openApiOperationId":"getOrderDetail","summary":"Order detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"}],"pointer":"/paths/~1api~1orders~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorderdetail"}],"panels":[]}]},"httpPath":"/api/orders/{code}"},{"label":"Order deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/deleteorder","routeSlug":"/shoptet-api/openapi/orders/deleteorder","metadata":{"seo":{"title":"Order deletion","description":"Order deletion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrder","name":"Order deletion","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000001"}],"pointer":"/paths/~1api~1orders~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/orders/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000001","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/orders/{code}","href":"orders/deleteorder","openApiOperationId":"deleteOrder","summary":"Order deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/deleteorder"}],"panels":[]}]},"httpPath":"/api/orders/{code}"},{"label":"Order head change","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/updateorderhead","routeSlug":"/shoptet-api/openapi/orders/updateorderhead","metadata":{"seo":{"title":"Order head change","description":"You can change basic info (head) of order with this method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrderHead","name":"Order head change","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1head/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order head change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can change basic info (head) of order with this method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note following rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 100 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 32 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.fullName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.street"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.houseNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.district"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.additional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.regionName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.regionShortcut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.companyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 18 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.vatId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 16 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAddress.taxId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 16 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.fullName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.street"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.houseNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.district"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.additional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.regionName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAddress.regionShortcut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" .. maxLength 255 characters"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code (number)","required":true,"example":"2018000012"}],"pointer":"/paths/~1api~1orders~1{code}~1head/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1head/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_535"}},"schemaId":"schema_535","pointer":"/paths/~1api~1orders~1{code}~1head/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/orders/{code}/head","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_535"}},"responseCodes":["200","409"],"pointer":"/api/orders/{code}/head","href":"orders/updateorderhead","openApiOperationId":"updateOrderHead","summary":"Order head change","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_535","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_535"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1head/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1head/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1head/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1head/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1head/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/updateorderhead"}],"panels":[]}]},"httpPath":"/api/orders/{code}/head"},{"label":"Download order as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/downloadorderaspdf","routeSlug":"/shoptet-api/openapi/orders/downloadorderaspdf","metadata":{"seo":{"title":"Download order as PDF","description":"You can request the order as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadOrderAsPdf","name":"Download order as PDF","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download order as PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the order as PDF file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download pdf documents"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000004"}],"pointer":"/paths/~1api~1orders~1{code}~1pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/{code}/pdf","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000004","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/api/orders/{code}/pdf","href":"orders/downloadorderaspdf","openApiOperationId":"downloadOrderAsPdf","summary":"Download order as PDF","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1pdf/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1pdf/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1pdf/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1pdf/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1pdf/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1pdf/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1pdf/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1pdf/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/downloadorderaspdf"}],"panels":[]}]},"httpPath":"/api/orders/{code}/pdf"},{"label":"Update remarks for the order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/updateremarksfororder","routeSlug":"/shoptet-api/openapi/orders/updateremarksfororder","metadata":{"seo":{"title":"Update remarks for the order","description":"The endpoint enables the remarks and additional fields (index 1 - 6) tobe updated for the order. Within a call, the update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRemarksForOrder","name":"Update remarks for the order","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1notes/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update remarks for the order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint enables the remarks and additional fields (index 1 - 6) to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be updated for the order. Within a call, the update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of more data can be called for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The individual data object keys are not optional. Only the key values,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which are included in the data object, will be updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If \"customerRemark\", \"trackingNumber\", \"eshopRemark\" have a value of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NULL, the originally saved value will be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For additional fields (\"additionalFields” key) only the fields included"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this field are updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the key value is \"text\" for NULL additional field, the originally"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved text in this field will be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the non-existing key is entered, or the call is erroneous in another"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"way, no item is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trackingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be longer than 32"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"characters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with index 1, 2 & 3 cannot be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"longer than 255 characters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000012"}],"pointer":"/paths/~1api~1orders~1{code}~1notes/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1notes/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_536","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_536","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1orders~1{code}~1notes/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/orders/{code}/notes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_536","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","404"],"pointer":"/api/orders/{code}/notes","href":"orders/updateremarksfororder","openApiOperationId":"updateRemarksForOrder","summary":"Update remarks for the order","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_536","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_536","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1notes/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1notes/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/updateremarksfororder"}],"panels":[]}]},"httpPath":"/api/orders/{code}/notes"},{"label":"Update of order status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/updateorderstatus","routeSlug":"/shoptet-api/openapi/orders/updateorderstatus","metadata":{"seo":{"title":"Update of order status","description":"The endpoint enables the order status, “paid” flag and payment method tobe updated. This data must be set during a call."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrderStatus","name":"Update of order status","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1status/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of order status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint enables the order status, “paid” flag and payment method to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be updated. This data must be set during a call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the fields to be updated are optional, but at least one has to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the key value is \"text\" for NULL additional field, the originally"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved text in this field will be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a non-existing key is entered, or the call is erroneous in another"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"way, no item is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you call the status setting within your request, which has \"set the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order as paid\" in the definition, and at the same time you required"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a change of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the order status will be carried out and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the status definition includes sending an e-mail, such an e-mail will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be sent. If not required, sending an e-mail can be suppressed with the"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?suppressEmailSending=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Similarly, sending information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS messages when the order is changed (if set) can be suppressed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?suppressSmsSending=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. In analogy, if the status includes document generation (for example a proforma invoice),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the document will be generated (if not existent). The generation can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suppressed with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?suppressDocumentGeneration=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint tries not to unnecessarily change the order status. If you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"try to set the status that the order already has, no change is done and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no document is generated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling the same requests in parallel, there is the risk that there"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may be concurrence and related actions may be executed twice. Therefore"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"we recommend calling this request from one source only, in a serial"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"manner."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status change might imply automatic documents (e. g. invoice)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generation. In exceptional cases the generation might fail,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"although the order status itself gets actually changed. In such case the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API return status code 200 (OK), but in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you can find the order details and in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array eventually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details about the failed documents generation. The error"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document-not-generated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Example of an error message:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n\"errors\": [\n {\n \"errorCode\": \"document-not-generated\",\n \"message\": \"Delivery note belonging to order \\\"2020000149\\\" was not created. Generating document code failed.\",\n \"instance\": \"2020000149\"\n }\n]\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n\"errors\": [\n {\n \"errorCode\": \"document-not-generated\",\n \"message\": \"Delivery note belonging to order \\\"2020000149\\\" was not created. Generating document code failed.\",\n \"instance\": \"2020000149\"\n }\n]\n\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000012"}],"pointer":"/paths/~1api~1orders~1{code}~1status/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressDocumentGeneration","in":"query","schemaId":"schema_529","description":"suppress the generation of linked documents.","example":true},{"name":"suppressEmailSending","in":"query","schemaId":"schema_529","description":"suppress sending the linked information e-mails.","example":true},{"name":"suppressSmsSending","in":"query","schemaId":"schema_529","description":"suppress sending the linked information SMS messages.","example":true}],"pointer":"/paths/~1api~1orders~1{code}~1status/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1status/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_537"}},"schemaId":"schema_537","pointer":"/paths/~1api~1orders~1{code}~1status/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/orders/{code}/status","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"}],"query":[{"name":"suppressDocumentGeneration","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressEmailSending","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressSmsSending","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_537"}},"responseCodes":["200","404","409"],"pointer":"/api/orders/{code}/status","href":"orders/updateorderstatus","openApiOperationId":"updateOrderStatus","summary":"Update of order status","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_537","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_537"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1status/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1status/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1status/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1status/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1status/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1status/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1status/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1status/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1status/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/updateorderstatus"}],"panels":[]}]},"httpPath":"/api/orders/{code}/status"},{"label":"Order copy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/ordercopy","routeSlug":"/shoptet-api/openapi/orders/ordercopy","metadata":{"seo":{"title":"Order copy","description":"This endpoint allows you to copy a order identified by its code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderCopy","name":"Order copy","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order copy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to copy a order identified by its code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can choose scope in which will be the order copied. The scope can be"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - copy the order with all its items"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no-billing-shipping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - copy the order without billing and shipping items"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact-only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - copy the order without any items"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note, that copy order creates stock demand (if stock module is active and negative stock amount is not allowed) and if this demand overflows the stock, the order will be fully created with error "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order-duplication-stock-overflow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to include additional parts of response, same as in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order detail, to retrieve more information about the copied order in copy response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000012"}],"pointer":"/paths/~1api~1orders~1{code}~1copy/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"optional parts of response","example":"notes,images,shippingDetails,stockLocation,productFlags"}],"pointer":"/paths/~1api~1orders~1{code}~1copy/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_538"}},"schemaId":"schema_538","pointer":"/paths/~1api~1orders~1{code}~1copy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{code}/copy","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","example":"notes,images,shippingDetails,stockLocation,productFlags","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_538"}},"responseCodes":["201","404","500"],"pointer":"/api/orders/{code}/copy","href":"orders/ordercopy","openApiOperationId":"orderCopy","summary":"Order copy","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_538","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_538"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1copy/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1copy/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1copy/post/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1copy/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1copy/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1copy/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1copy/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1copy/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/ordercopy"}],"panels":[]}]},"httpPath":"/api/orders/{code}/copy"},{"label":"List of order statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlistoforderstatuses","routeSlug":"/shoptet-api/openapi/orders/getlistoforderstatuses","metadata":{"seo":{"title":"List of order statuses","description":"Detailed information on order status within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfOrderStatuses","name":"List of order statuses","isWebhook":false,"pointer":"/paths/~1api~1orders~1statuses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of order statuses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Detailed information on order status within the e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1statuses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/statuses","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/statuses","href":"orders/getlistoforderstatuses","openApiOperationId":"getListOfOrderStatuses","summary":"List of order statuses","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539"}],"pointer":"/paths/~1api~1orders~1statuses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getlistoforderstatuses"}],"panels":[]}]},"httpPath":"/api/orders/statuses"},{"label":"List of order sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlistofordersources","routeSlug":"/shoptet-api/openapi/orders/getlistofordersources","metadata":{"seo":{"title":"List of order sources","description":"Detailed information on current possible order sources within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfOrderSources","name":"List of order sources","isWebhook":false,"pointer":"/paths/~1api~1orders~1sources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of order sources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Detailed information on current possible order sources within the e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1sources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/sources","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/sources","href":"orders/getlistofordersources","openApiOperationId":"getListOfOrderSources","summary":"List of order sources","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_540"}},"schemaId":"schema_540"}],"pointer":"/paths/~1api~1orders~1sources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_540","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_540"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getlistofordersources"}],"panels":[]}]},"httpPath":"/api/orders/sources"},{"label":"Last order changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getlastorderchanges","routeSlug":"/shoptet-api/openapi/orders/getlastorderchanges","metadata":{"seo":{"title":"Last order changes","description":"The Endpoint is intended to determine the changes after you have loaded the complete list of orders and you need to know,if any of these has been changed (or deleted). Guaranteed history is 30 days, the older data are deleted progressively."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLastOrderChanges","name":"Last order changes","isWebhook":false,"pointer":"/paths/~1api~1orders~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last order changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Endpoint is intended to determine the changes after you have loaded the complete list of orders and you need to know,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if any of these has been changed (or deleted). Guaranteed history is 30 days, the older data are deleted progressively."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each order in the log is only mentioned with its last change. For example, if the order was modified and then deleted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the log will only show information about its deletion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be filtered by changeType = edit/delete parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation is considered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action. So, when there is a new item created, it will be displayed like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime from which up to the present we are interested in the changes. + in the time zone"},"children":[]}]}]}],"required":true,"example":"2018-01-01T01:01:01+02:00"},{"name":"changeType","in":"query","schemaId":"schema_523","description":"Returning only edit or delete type changed records","example":"edit"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 1000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1orders~1changes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/changes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":true,"example":"2018-01-01T01:01:01+02:00","schemaId":"schema_523"},{"name":"changeType","in":"query","required":false,"example":"edit","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/changes","href":"orders/getlastorderchanges","openApiOperationId":"getLastOrderChanges","summary":"Last order changes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_541"}},"schemaId":"schema_541"}],"pointer":"/paths/~1api~1orders~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_541","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_541"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getlastorderchanges"}],"panels":[]}]},"httpPath":"/api/orders/changes"},{"label":"Orders with product claims","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/getorderclaims","routeSlug":"/shoptet-api/openapi/orders/getorderclaims","metadata":{"seo":{"title":"Orders with product claims","description":"Endpoint listing all ordered products with unfulfilled claims."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderClaims","name":"Orders with product claims","isWebhook":false,"pointer":"/paths/~1api~1orders~1claims/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders with product claims","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint listing all ordered products with unfulfilled claims."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeClosedAndCancelledOrders","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include orders in final state - such as closed and cancelled orders. Default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED due to misleading name and actual irrelevance. To be removed in the future."},"children":[]}]}]}],"deprecated":true,"example":true},{"name":"productCode","in":"query","schemaId":"schema_523","description":"Filter order claims by product code","example":"DS53437473"},{"name":"orderCode","in":"query","schemaId":"schema_523","description":"Filter order claims by order code","example":"2017000066"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 100. Max value is 250.","example":110},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1orders~1claims/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1claims/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/claims","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"includeClosedAndCancelledOrders","in":"query","example":true,"schemaId":"schema_542"},{"name":"productCode","in":"query","example":"DS53437473","schemaId":"schema_523"},{"name":"orderCode","in":"query","example":"2017000066","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":110,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/claims","href":"orders/getorderclaims","openApiOperationId":"getOrderClaims","summary":"Orders with product claims","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_543"}},"schemaId":"schema_543"}],"pointer":"/paths/~1api~1orders~1claims/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_543","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_543"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/getorderclaims"}],"panels":[]}]},"httpPath":"/api/orders/claims"},{"label":"Order BATCH insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/orders/orderbatchinsertion","routeSlug":"/shoptet-api/openapi/orders/orderbatchinsertion","metadata":{"seo":{"title":"Order BATCH insertion","description":"Beta/Experimental feature: This endpoint is currently in beta and may exhibit unexpected behavior.This endpoint allows you to create multiple orders at once. Batch insertion is processed asynchronously in the same way as, for example, List of all orders, but it does not have resultUrl in the response. Instead, you can check the attribute log which contains successfully created orders and errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderBatchInsertion","name":"Order BATCH insertion","isWebhook":false,"pointer":"/paths/~1api~1orders~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order BATCH insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beta/Experimental feature: This endpoint is currently in beta and may exhibit unexpected behavior."},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to create multiple orders at once. Batch insertion is processed asynchronously in the same way as, for example, "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Orders/list-of-all-orders"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of all orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but it does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response. Instead, you can check the attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"log"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains successfully created orders and errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File with data for insert must be in JSONL ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") format. Each line must contain one order in JSON format. Maximum size of file is 100MB. The base structure of a JSON row contains 2 main parameters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, you can set the suppress parameters for a specific row/record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All params in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be in 3 states:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is applied."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is applied."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter is missing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the default value "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is applied."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structure of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is the same as the structure of JSON for single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/orders/createorder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order insertion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/batch/orderbatchcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order batch create schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The asynchronous job processes the JSONL file row by row and tries to validate and save the data. If there is any error, the row is skipped and the error is logged, but it does not stop the processing of other rows. In the log, every order is identified by its position in the file (starting from 1)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","pointer":"/paths/~1api~1orders~1batch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/batch","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_544"}},"responseCodes":["202","404","409"],"pointer":"/api/orders/batch","href":"orders/orderbatchinsertion","openApiOperationId":"orderBatchInsertion","summary":"Order BATCH insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1orders~1batch/post/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1orders~1batch/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1batch/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1batch/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"404","exampleIds":["paths/~1api~1orders~1batch/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1orders~1batch/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1batch/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1batch/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/orderbatchinsertion"}],"panels":[]}]},"httpPath":"/api/orders/batch"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Basic endpoints for managing orders. See the sections below for other specific actions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders","summary":"List of orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getlistoforders","deprecated":false},{"title":"/api/orders","summary":"Order insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/createorder","deprecated":false},{"title":"/api/orders/snapshot","summary":"List of all orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getlistofallorders","deprecated":false},{"title":"/api/orders/status-change","summary":"Bulk order status change","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/orders/bulkorderstatuschange","deprecated":false},{"title":"/api/orders/{code}","summary":"Order detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorderdetail","deprecated":false},{"title":"/api/orders/{code}","summary":"Order deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/deleteorder","deprecated":false},{"title":"/api/orders/{code}/head","summary":"Order head change","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/orders/updateorderhead","deprecated":false},{"title":"/api/orders/{code}/pdf","summary":"Download order as PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/downloadorderaspdf","deprecated":false},{"title":"/api/orders/{code}/notes","summary":"Update remarks for the order","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/orders/updateremarksfororder","deprecated":false},{"title":"/api/orders/{code}/status","summary":"Update of order status","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/orders/updateorderstatus","deprecated":false},{"title":"/api/orders/{code}/copy","summary":"Order copy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/ordercopy","deprecated":false},{"title":"/api/orders/statuses","summary":"List of order statuses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getlistoforderstatuses","deprecated":false},{"title":"/api/orders/sources","summary":"List of order sources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getlistofordersources","deprecated":false},{"title":"/api/orders/changes","summary":"Last order changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getlastorderchanges","deprecated":false},{"title":"/api/orders/claims","summary":"Orders with product claims","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/getorderclaims","deprecated":false},{"title":"/api/orders/batch","summary":"Order BATCH insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/orderbatchinsertion","deprecated":false}]}]}]}]}},{"type":"group","label":"Order gifts","link":"/shoptet-api/openapi/order-gifts","routeSlug":"/shoptet-api/openapi/order-gifts","items":[{"label":"Get order gifts list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-gifts/getordergiftslist","routeSlug":"/shoptet-api/openapi/order-gifts/getordergiftslist","metadata":{"seo":{"title":"Get order gifts list","description":"This endpoint allow get, add or delete order related gifts. Gifts is relation to product variant by itscode identifier and is ordered by priority field"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderGiftsList","name":"Get order gifts list","isWebhook":false,"pointer":"/paths/~1api~1orders~1gifts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order gifts list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allow get, add or delete order related gifts. Gifts is relation to product variant by its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifier and is ordered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1gifts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/gifts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/gifts","href":"order-gifts/getordergiftslist","openApiOperationId":"getOrderGiftsList","summary":"Get order gifts list","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}},"schemaId":"schema_546"}],"pointer":"/paths/~1api~1orders~1gifts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_546","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-gifts/getordergiftslist"}],"panels":[]}]},"httpPath":"/api/orders/gifts"},{"label":"Add order gift at the end of the list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-gifts/addordergift","routeSlug":"/shoptet-api/openapi/order-gifts/addordergift","metadata":{"seo":{"title":"Add order gift at the end of the list","description":"Add order gift (product variant) at the end of the order gift list. Giftis defined by code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addOrderGift","name":"Add order gift at the end of the list","isWebhook":false,"pointer":"/paths/~1api~1orders~1gifts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add order gift at the end of the list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add order gift (product variant) at the end of the order gift list. Gift"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is defined by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1gifts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_547"}},"schemaId":"schema_547","pointer":"/paths/~1api~1orders~1gifts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/gifts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_547"}},"responseCodes":["200"],"pointer":"/api/orders/gifts","href":"order-gifts/addordergift","openApiOperationId":"addOrderGift","summary":"Add order gift at the end of the list","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_547","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_547"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}},"schemaId":"schema_546"}],"pointer":"/paths/~1api~1orders~1gifts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_546","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-gifts/addordergift"}],"panels":[]}]},"httpPath":"/api/orders/gifts"},{"label":"Delete order gift","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-gifts/deleteordergift","routeSlug":"/shoptet-api/openapi/order-gifts/deleteordergift","metadata":{"seo":{"title":"Delete order gift","description":"Delete order gift item by primary key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderGift","name":"Delete order gift","isWebhook":false,"pointer":"/paths/~1api~1orders~1gifts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete order gift","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete order gift item by primary key."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"ID of gift","required":true,"example":4}],"pointer":"/paths/~1api~1orders~1gifts~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1gifts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/orders/gifts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":4,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/gifts/{id}","href":"order-gifts/deleteordergift","openApiOperationId":"deleteOrderGift","summary":"Delete order gift","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534","exampleIds":["paths/~1api~1orders~1gifts~1{id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_534","exampleIds":["paths/~1api~1orders~1gifts~1{id}/delete/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1gifts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","exampleIds":["paths/~1api~1orders~1gifts~1{id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534","exampleIds":["paths/~1api~1orders~1gifts~1{id}/delete/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-gifts/deleteordergift"}],"panels":[]}]},"httpPath":"/api/orders/gifts/{id}"}],"content":{"contentType":"group","meta":{"name":"Order gifts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order gifts","showPageActions":true},{"nodeType":"markdoc","content":"Managing order gifts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/gifts","summary":"Get order gifts list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-gifts/getordergiftslist","deprecated":false},{"title":"/api/orders/gifts","summary":"Add order gift at the end of the list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-gifts/addordergift","deprecated":false},{"title":"/api/orders/gifts/{id}","summary":"Delete order gift","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-gifts/deleteordergift","deprecated":false}]}]}]}]}},{"type":"group","label":"Order history","link":"/shoptet-api/openapi/order-history","routeSlug":"/shoptet-api/openapi/order-history","items":[{"label":"List of all remarks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-history/getlistofallremarks","routeSlug":"/shoptet-api/openapi/order-history/getlistofallremarks","metadata":{"seo":{"title":"List of all remarks","description":"Using this endpoint, you can get list of all remarks with detailed info of each remark asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllRemarks","name":"List of all remarks","isWebhook":false,"pointer":"/paths/~1api~1orders~1history~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all remarks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all remarks with detailed info of each remark asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each remark taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One remark in response has the same format as an item in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/order-history/getlistofremarksfororder"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of remarks for order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is extended with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, which identifies the relation to the order. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/orderhistorysnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order history snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request parameter to get the list of specific orders remarks. Order codes are separated by a comma. Please note that this parameter "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepts max. 50 order codes in request parameter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"orderCodes","in":"query","schemaId":"schema_523","description":"Define the output set of orders remarks. Use max. 50 order codes separated by a comma.","example":"2025000004,2025000002,2017000038,2017000025,2015000248"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"date and time of remark creation - lower limit","example":"2025-06-23T14:17:00+02:00"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"date and time of remark creation - upper limit","example":"2025-07-01T14:17:00+02:00"},{"name":"userId","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identification of change originator, either user’s e-mail, or system process identifier"},"children":[]}]}]}],"examples":{"User email":{"value":"john.doe@example.com"},"Process identifier":{"value":"api.service-21@fenix.myshoptet.com"}}}],"pointer":"/paths/~1api~1orders~1history~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1history~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/history/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"orderCodes","in":"query","example":"2025000004,2025000002,2017000038,2017000025,2015000248","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2025-06-23T14:17:00+02:00","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2025-07-01T14:17:00+02:00","schemaId":"schema_523"},{"name":"userId","in":"query","example":"john.doe@example.com","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/orders/history/snapshot","href":"order-history/getlistofallremarks","openApiOperationId":"getListOfAllRemarks","summary":"List of all remarks","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1orders~1history~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-history/getlistofallremarks"}],"panels":[]}]},"httpPath":"/api/orders/history/snapshot"},{"label":"List of remarks for the order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-history/getlistofremarksfororder","routeSlug":"/shoptet-api/openapi/order-history/getlistofremarksfororder","metadata":{"seo":{"title":"List of remarks for the order","description":"The endpoint shows the order history which is displayed in Shoptetadministration in the"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfRemarksForOrder","name":"List of remarks for the order","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of remarks for the order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint shows the order history which is displayed in Shoptet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"administration in the"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"“History” tab, in the order detail. Thus they are the most important"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system actions that have affected the order (they cannot be"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changed by the user) and then the notes added by the e-shop, primarily"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"intended as messages between several employees,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which may be needed to coordinate the order processing (these can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"entered and deleted by the user)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Order code","required":true,"example":"2018000067"}],"pointer":"/paths/~1api~1orders~1{code}~1history/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"system","in":"query","schemaId":"schema_542","description":"allows filtering only system/non-system remarks","example":true}],"pointer":"/paths/~1api~1orders~1{code}~1history/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/{code}/history","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000067","schemaId":"schema_523"}],"query":[{"name":"system","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/{code}/history","href":"order-history/getlistofremarksfororder","openApiOperationId":"getListOfRemarksForOrder","summary":"List of remarks for the order","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_548"}},"schemaId":"schema_548"}],"pointer":"/paths/~1api~1orders~1{code}~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_548","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_548"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-history/getlistofremarksfororder"}],"panels":[]}]},"httpPath":"/api/orders/{code}/history"},{"label":"Insertion of remark to order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-history/createorderremark","routeSlug":"/shoptet-api/openapi/order-history/createorderremark","metadata":{"seo":{"title":"Insertion of remark to order","description":"This endpoint may be used to add the user remark into the order history."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderRemark","name":"Insertion of remark to order","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1history/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insertion of remark to order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint may be used to add the user remark into the order history."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example the payment gateway may give the payment identification at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"its side, or"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"add the remarks during the process of payment or order processing. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remarks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are displayed in administration, in the “History” tab, in the order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detail,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"together with main system changes of the order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000012"}],"pointer":"/paths/~1api~1orders~1{code}~1history/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1history/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549","pointer":"/paths/~1api~1orders~1{code}~1history/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{code}/history","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_549"}},"responseCodes":["201","403","404","422"],"pointer":"/api/orders/{code}/history","href":"order-history/createorderremark","openApiOperationId":"createOrderRemark","summary":"Insertion of remark to order","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1history/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-history/createorderremark"}],"panels":[]}]},"httpPath":"/api/orders/{code}/history"},{"label":"Delete order history item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-history/deleteorderhistoryitem","routeSlug":"/shoptet-api/openapi/order-history/deleteorderhistoryitem","metadata":{"seo":{"title":"Delete order history item","description":"Delete order history item by primary key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderHistoryItem","name":"Delete order history item","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1history~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete order history item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete order history item by primary key."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Order code","required":true,"example":"2018000067"},{"name":"id","in":"path","schemaId":"schema_522","description":"ID of history item","required":true,"example":4}],"pointer":"/paths/~1api~1orders~1{code}~1history~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1history~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/orders/{code}/history/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000067","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":4,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/orders/{code}/history/{id}","href":"order-history/deleteorderhistoryitem","openApiOperationId":"deleteOrderHistoryItem","summary":"Delete order history item","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"404","description":"Order history item deletion failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1history~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1history~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-history/deleteorderhistoryitem"}],"panels":[]}]},"httpPath":"/api/orders/{code}/history/{id}"}],"content":{"contentType":"group","meta":{"name":"Order history"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order history","showPageActions":true},{"nodeType":"markdoc","content":"Managing order history."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/history/snapshot","summary":"List of all remarks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-history/getlistofallremarks","deprecated":false},{"title":"/api/orders/{code}/history","summary":"List of remarks for the order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-history/getlistofremarksfororder","deprecated":false},{"title":"/api/orders/{code}/history","summary":"Insertion of remark to order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-history/createorderremark","deprecated":false},{"title":"/api/orders/{code}/history/{id}","summary":"Delete order history item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-history/deleteorderhistoryitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Order items","link":"/shoptet-api/openapi/order-items","routeSlug":"/shoptet-api/openapi/order-items","items":[{"label":"Order item add","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/createorderitem","routeSlug":"/shoptet-api/openapi/order-items/createorderitem","metadata":{"seo":{"title":"Order item add","description":"Order item add"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderItem","name":"Order item add","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1item/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order item add","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code","required":true,"example":"2018000012"}],"pointer":"/paths/~1api~1orders~1{code}~1item/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressProductChecking","in":"query","schemaId":"schema_529","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suppress the product existence check as per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and GUID"},"children":[]}]}]}],"example":true},{"name":"suppressStockMovements","in":"query","schemaId":"schema_529","description":"suppress deduction of the products from stock","example":true}],"pointer":"/paths/~1api~1orders~1{code}~1item/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1item/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"schemaId":"schema_551","pointer":"/paths/~1api~1orders~1{code}~1item/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{code}/item","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"}],"query":[{"name":"suppressProductChecking","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressStockMovements","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_551"}},"responseCodes":["201","403","422"],"pointer":"/api/orders/{code}/item","href":"order-items/createorderitem","openApiOperationId":"createOrderItem","summary":"Order item add","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_551","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_551"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"},{"code":"403","description":"Consumption tax module is not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item/post/responses/403/content/application~1json/example"]},{"code":"422","description":"Consumption tax id not exists / not visible","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1item/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item/post/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/createorderitem"}],"panels":[]}]},"httpPath":"/api/orders/{code}/item"},{"label":"Order item change","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/updateorderitem","routeSlug":"/shoptet-api/openapi/order-items/updateorderitem","metadata":{"seo":{"title":"Order item change","description":"Order item change"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrderItem","name":"Order item change","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order item change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code (number)","required":true,"example":"2018000012"},{"name":"id","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order item id. Can be found in field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.order.items.itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order detail. (number)"},"children":[]}]}]}],"required":true,"example":"198"}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressProductGuidCheck","in":"query","schemaId":"schema_529","description":"suppress the product existence check per GUID","example":true}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_552"}},"schemaId":"schema_552","pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/orders/{code}/item/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":"198","schemaId":"schema_523"}],"query":[{"name":"suppressProductGuidCheck","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_552"}},"responseCodes":["200","403","404","409","422"],"pointer":"/api/orders/{code}/item/{id}","href":"order-items/updateorderitem","openApiOperationId":"updateOrderItem","summary":"Order item change","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_552","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_552"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_553"}},"schemaId":"schema_553"},{"code":"403","description":"Consumption tax module is not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Currency not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_553","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_553"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/updateorderitem"}],"panels":[]}]},"httpPath":"/api/orders/{code}/item/{id}"},{"label":"Order item delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/deleteorderitem","routeSlug":"/shoptet-api/openapi/order-items/deleteorderitem","metadata":{"seo":{"title":"Order item delete","description":"Order item delete"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderItem","name":"Order item delete","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order item delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code (number)","required":true,"example":"2018000012"},{"name":"id","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order item id. Can be found in field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.order.items.itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order detail. (number)"},"children":[]}]}]}],"required":true,"example":"198"}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/orders/{code}/item/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":"198","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","409"],"pointer":"/api/orders/{code}/item/{id}","href":"order-items/deleteorderitem","openApiOperationId":"deleteOrderItem","summary":"Order item delete","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1item~1{id}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/deleteorderitem"}],"panels":[]}]},"httpPath":"/api/orders/{code}/item/{id}"},{"label":"Order item surcharge parameters insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/createorderitemsurchargeparameters","routeSlug":"/shoptet-api/openapi/order-items/createorderitemsurchargeparameters","metadata":{"seo":{"title":"Order item surcharge parameters insertion","description":"There is possibility to edit surcharge parameters related to order item. For that purpose, there is inget order item detail endpoint attribute specificSurchargeParameters which returned adjusted surchargeparameters data (see order item detail endpoint)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderItemSurchargeParameters","name":"Order item surcharge parameters insertion","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order item surcharge parameters insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is possibility to edit surcharge parameters related to order item. For that purpose, there is in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"get order item detail endpoint attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificSurchargeParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which returned adjusted surcharge"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameters data (see order item detail "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/orders/getorderdetail"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This mean that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute in order detail is persistent and any adjustment in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surcharge parameters appears in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificSurchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint purpose is to add surcharge parameter in relation within"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have to send one of attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameterCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valueIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cant send this attributes together."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you post "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameterCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valueIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", there will be validation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if surcharge parameter exits and if can be related"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to order item's product and price (if not send) will be added from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surcharge parameter itself."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise you can send attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead, which could have any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"form, but has to be unique. If price is not send,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"than it will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code","required":true,"example":"2018000012"},{"name":"id","in":"path","schemaId":"schema_522","description":"order item id","required":true,"example":3120}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_554"}},"schemaId":"schema_554","pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{code}/item/{id}/surcharge-parameters","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":3120,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_554"}},"responseCodes":["200"],"pointer":"/api/orders/{code}/item/{id}/surcharge-parameters","href":"order-items/createorderitemsurchargeparameters","openApiOperationId":"createOrderItemSurchargeParameters","summary":"Order item surcharge parameters insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_554","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_554"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/createorderitemsurchargeparameters"}],"panels":[]}]},"httpPath":"/api/orders/{code}/item/{id}/surcharge-parameters"},{"label":"Order item surcharge parameters deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-items/deleteorderitemsurchargeparameters","routeSlug":"/shoptet-api/openapi/order-items/deleteorderitemsurchargeparameters","metadata":{"seo":{"title":"Order item surcharge parameters deletion","description":"You have to provide dynamically generated relationId which identifywhich surcharge parameter related to order item you want to delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderItemSurchargeParameters","name":"Order item surcharge parameters deletion","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters~1{relationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order item surcharge parameters deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have to provide dynamically generated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relationId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which identify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which surcharge parameter related to order item you want to delete."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code","required":true,"example":"2018000012"},{"name":"id","in":"path","schemaId":"schema_522","description":"order item id","required":true,"example":3120},{"name":"relationId","in":"path","schemaId":"schema_523","description":"key to identify, which surcharge parameter in relation to order\nitem, should be delete","required":true,"example":"abc123"}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters~1{relationId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters~1{relationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/orders/{code}/item/{id}/surcharge-parameters/{relationId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":3120,"schemaId":"schema_522"},{"name":"relationId","in":"path","required":true,"example":"abc123","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/{code}/item/{id}/surcharge-parameters/{relationId}","href":"order-items/deleteorderitemsurchargeparameters","openApiOperationId":"deleteOrderItemSurchargeParameters","summary":"Order item surcharge parameters deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1orders~1{code}~1item~1{id}~1surcharge-parameters~1{relationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-items/deleteorderitemsurchargeparameters"}],"panels":[]}]},"httpPath":"/api/orders/{code}/item/{id}/surcharge-parameters/{relationId}"}],"content":{"contentType":"group","meta":{"name":"Order items"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order items","showPageActions":true},{"nodeType":"markdoc","content":"Managing order items."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/{code}/item","summary":"Order item add","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-items/createorderitem","deprecated":false},{"title":"/api/orders/{code}/item/{id}","summary":"Order item change","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order-items/updateorderitem","deprecated":false},{"title":"/api/orders/{code}/item/{id}","summary":"Order item delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-items/deleteorderitem","deprecated":false},{"title":"/api/orders/{code}/item/{id}/surcharge-parameters","summary":"Order item surcharge parameters insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-items/createorderitemsurchargeparameters","deprecated":false},{"title":"/api/orders/{code}/item/{id}/surcharge-parameters/{relationId}","summary":"Order item surcharge parameters deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-items/deleteorderitemsurchargeparameters","deprecated":false}]}]}]}]}},{"type":"group","label":"Order payment","link":"/shoptet-api/openapi/order-payment","routeSlug":"/shoptet-api/openapi/order-payment","items":[{"label":"Order payment add","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-payment/createorderpayment","routeSlug":"/shoptet-api/openapi/order-payment/createorderpayment","metadata":{"seo":{"title":"Order payment add","description":"Order payment add"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderPayment","name":"Order payment add","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order payment add","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code","required":true,"example":"2018000079"}],"pointer":"/paths/~1api~1orders~1{code}~1payment/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1payment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_555"}},"schemaId":"schema_555","pointer":"/paths/~1api~1orders~1{code}~1payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{code}/payment","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000079","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_555"}},"responseCodes":["201"],"pointer":"/api/orders/{code}/payment","href":"order-payment/createorderpayment","openApiOperationId":"createOrderPayment","summary":"Order payment add","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_555","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_555"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"}],"pointer":"/paths/~1api~1orders~1{code}~1payment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-payment/createorderpayment"}],"panels":[]}]},"httpPath":"/api/orders/{code}/payment"},{"label":"Order payment update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-payment/updateorderpayment","routeSlug":"/shoptet-api/openapi/order-payment/updateorderpayment","metadata":{"seo":{"title":"Order payment update","description":"Order payment update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrderPayment","name":"Order payment update","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1payment~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order payment update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code","required":true,"example":"2018000079"},{"name":"id","in":"path","schemaId":"schema_522","description":"id of order item","required":true,"example":1}],"pointer":"/paths/~1api~1orders~1{code}~1payment~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1payment~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_556"}},"schemaId":"schema_556","pointer":"/paths/~1api~1orders~1{code}~1payment~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/orders/{code}/payment/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000079","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_556"}},"responseCodes":["200"],"pointer":"/api/orders/{code}/payment/{id}","href":"order-payment/updateorderpayment","openApiOperationId":"updateOrderPayment","summary":"Order payment update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_556","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_556"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_553"}},"schemaId":"schema_553"}],"pointer":"/paths/~1api~1orders~1{code}~1payment~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_553","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_553"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-payment/updateorderpayment"}],"panels":[]}]},"httpPath":"/api/orders/{code}/payment/{id}"}],"content":{"contentType":"group","meta":{"name":"Order payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order payment","showPageActions":true},{"nodeType":"markdoc","content":"Managing order payment."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/{code}/payment","summary":"Order payment add","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-payment/createorderpayment","deprecated":false},{"title":"/api/orders/{code}/payment/{id}","summary":"Order payment update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order-payment/updateorderpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Order shipping","link":"/shoptet-api/openapi/order-shipping","routeSlug":"/shoptet-api/openapi/order-shipping","items":[{"label":"Order shipping add","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-shipping/addordershipping","routeSlug":"/shoptet-api/openapi/order-shipping/addordershipping","metadata":{"seo":{"title":"Order shipping add","description":"Order shipping add"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addOrderShipping","name":"Order shipping add","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1shipping/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order shipping add","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code","required":true,"example":"2018000079"}],"pointer":"/paths/~1api~1orders~1{code}~1shipping/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1shipping/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_557"}},"schemaId":"schema_557","pointer":"/paths/~1api~1orders~1{code}~1shipping/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{code}/shipping","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000079","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_557"}},"responseCodes":["201"],"pointer":"/api/orders/{code}/shipping","href":"order-shipping/addordershipping","openApiOperationId":"addOrderShipping","summary":"Order shipping add","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_557","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_557"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"}],"pointer":"/paths/~1api~1orders~1{code}~1shipping/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-shipping/addordershipping"}],"panels":[]}]},"httpPath":"/api/orders/{code}/shipping"},{"label":"Order shipping update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/order-shipping/updateordershipping","routeSlug":"/shoptet-api/openapi/order-shipping/updateordershipping","metadata":{"seo":{"title":"Order shipping update","description":"Order shipping update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrderShipping","name":"Order shipping update","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1shipping~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order shipping update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"order code","required":true,"example":"2018000079"},{"name":"id","in":"path","schemaId":"schema_522","description":"id of order item","required":true,"example":1}],"pointer":"/paths/~1api~1orders~1{code}~1shipping~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1shipping~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_558"}},"schemaId":"schema_558","pointer":"/paths/~1api~1orders~1{code}~1shipping~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/orders/{code}/shipping/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000079","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_558"}},"responseCodes":["200"],"pointer":"/api/orders/{code}/shipping/{id}","href":"order-shipping/updateordershipping","openApiOperationId":"updateOrderShipping","summary":"Order shipping update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_558","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_558"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_553"}},"schemaId":"schema_553"}],"pointer":"/paths/~1api~1orders~1{code}~1shipping~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_553","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_553"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-shipping/updateordershipping"}],"panels":[]}]},"httpPath":"/api/orders/{code}/shipping/{id}"}],"content":{"contentType":"group","meta":{"name":"Order shipping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order shipping","showPageActions":true},{"nodeType":"markdoc","content":"Managing order shipping."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/{code}/shipping","summary":"Order shipping add","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-shipping/addordershipping","deprecated":false},{"title":"/api/orders/{code}/shipping/{id}","summary":"Order shipping update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order-shipping/updateordershipping","deprecated":false}]}]}]}]}},{"type":"separator","label":"Accounting","content":null},{"type":"group","label":"Credit notes","link":"/shoptet-api/openapi/credit-notes","routeSlug":"/shoptet-api/openapi/credit-notes","items":[{"label":"List of credit notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/getlistofcreditnotes","routeSlug":"/shoptet-api/openapi/credit-notes/getlistofcreditnotes","metadata":{"seo":{"title":"List of credit notes","description":"The list of credit notes supports Paging"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfCreditNotes","name":"List of credit notes","isWebhook":false,"pointer":"/paths/~1api~1credit-notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of credit notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of credit notes supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isValid","in":"query","schemaId":"schema_542","description":"filtering according to document validity. Optional.","example":true},{"name":"invoiceCode","in":"query","schemaId":"schema_523","description":"filtering according to number of invoice. Optional.","example":"0000000006"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"date of credit note creation, in ISO 8601 format, lower limit.\nOptional.","example":"2017-02-28T17:04:47+0100"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"date of credit note creation, in ISO 8601 format, upper limit.\nOptional.","example":"2028-02-28T17:04:47+0100"},{"name":"varSymbol","in":"query","schemaId":"schema_523","description":"filtering according to variable symbol of credit note","example":"0000000006"},{"name":"proofPaymentCode","in":"query","schemaId":"schema_523","description":"filtering according to proof payment code. Optional.","example":"P--2017200011-1"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1credit-notes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/credit-notes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"},{"name":"invoiceCode","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2028-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"varSymbol","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"proofPaymentCode","in":"query","example":"P--2017200011-1","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/credit-notes","href":"credit-notes/getlistofcreditnotes","openApiOperationId":"getListOfCreditNotes","summary":"List of credit notes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559"}],"pointer":"/paths/~1api~1credit-notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/getlistofcreditnotes"}],"panels":[]}]},"httpPath":"/api/credit-notes"},{"label":"List of all credit notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/getlistofallcreditnotes","routeSlug":"/shoptet-api/openapi/credit-notes/getlistofallcreditnotes","metadata":{"seo":{"title":"List of all credit notes","description":"Using this endpoint, you can get list of all credit notes with detailed info of each credit note (like in Credit note detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllCreditNotes","name":"List of all credit notes","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all credit notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all credit notes with detailed info of each credit note (like in Credit note detail endpoint) asynchronously. See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each credit note taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One credit note in response has the same format as credit note detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/creditnotesnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit note snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"Export credit notes created after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"Export credit notes created before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"Export credit notes updated after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":"Export credit notes updated before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"Export credit notes with code after given value","example":"0000000006"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"Export credit notes with code before given value","example":"0000000006"},{"name":"invoiceCodeFrom","in":"query","schemaId":"schema_523","description":"Export credit notes with invoice code after given value","example":"2017000010"},{"name":"invoiceCodeTo","in":"query","schemaId":"schema_523","description":"Export credit notes with invoice code before given value","example":"2017000010"},{"name":"dueDateFrom","in":"query","schemaId":"schema_523","description":"Export credit notes with due date after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"dueDateTo","in":"query","schemaId":"schema_523","description":"Export credit notes with due date before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"hasProofPaymentCode","in":"query","schemaId":"schema_542","description":"Export credit notes with or without proof payment codes only","example":true},{"name":"taxDateFrom","in":"query","schemaId":"schema_523","description":"Export credit notes with tax date after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"taxDateTo","in":"query","schemaId":"schema_523","description":"Export credit notes with tax date before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"orderCodeFrom","in":"query","schemaId":"schema_523","description":"Export credit notes with order code after given value","example":"2017000010"},{"name":"orderCodeTo","in":"query","schemaId":"schema_523","description":"Export credit notes with order code before given value","example":"2017000010"},{"name":"customerGuid","in":"query","schemaId":"schema_523","description":"Export credit notes with given customer","example":"443cad54-73bc-11e8-8216-002590dad85e"},{"name":"varSymbol","in":"query","schemaId":"schema_523","description":"Export credit notes with given variable symbol","example":"2010001"},{"name":"restocked","in":"query","schemaId":"schema_542","description":"Export restocked or not restocked credit notes","example":false},{"name":"isValid","in":"query","schemaId":"schema_542","description":"Filtering according to document validity","example":true},{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"surchargeParameters"}],"pointer":"/paths/~1api~1credit-notes~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/credit-notes/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"codeFrom","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"invoiceCodeFrom","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"invoiceCodeTo","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"dueDateFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"dueDateTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"hasProofPaymentCode","in":"query","example":true,"schemaId":"schema_542"},{"name":"taxDateFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"taxDateTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"orderCodeFrom","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"orderCodeTo","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"customerGuid","in":"query","example":"443cad54-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"varSymbol","in":"query","example":"2010001","schemaId":"schema_523"},{"name":"restocked","in":"query","example":false,"schemaId":"schema_542"},{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"},{"name":"include","in":"query","required":false,"example":"surchargeParameters","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/credit-notes/snapshot","href":"credit-notes/getlistofallcreditnotes","openApiOperationId":"getListOfAllCreditNotes","summary":"List of all credit notes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1credit-notes~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/getlistofallcreditnotes"}],"panels":[]}]},"httpPath":"/api/credit-notes/snapshot"},{"label":"Credit note detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/getcreditnotedetail","routeSlug":"/shoptet-api/openapi/credit-notes/getcreditnotedetail","metadata":{"seo":{"title":"Credit note detail","description":"Additional information about one credit note."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCreditNoteDetail","name":"Credit note detail","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit note detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about one credit note."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000002"}],"pointer":"/paths/~1api~1credit-notes~1{code}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"surchargeParameters"}],"pointer":"/paths/~1api~1credit-notes~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/credit-notes/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000002","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","required":false,"example":"surchargeParameters","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/credit-notes/{code}","href":"credit-notes/getcreditnotedetail","openApiOperationId":"getCreditNoteDetail","summary":"Credit note detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1credit-notes~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/getcreditnotedetail"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}"},{"label":"Credit note update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/updatecreditnote","routeSlug":"/shoptet-api/openapi/credit-notes/updatecreditnote","metadata":{"seo":{"title":"Credit note update","description":"Credit note update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCreditNote","name":"Credit note update","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit note update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000002"}],"pointer":"/paths/~1api~1credit-notes~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_561"}},"schemaId":"schema_561","pointer":"/paths/~1api~1credit-notes~1{code}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/credit-notes/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000002","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_561"}},"responseCodes":["201","409","422"],"pointer":"/api/credit-notes/{code}","href":"credit-notes/updatecreditnote","openApiOperationId":"updateCreditNote","summary":"Credit note update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_561","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_561"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/patch/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1credit-notes~1{code}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/patch/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/updatecreditnote"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}"},{"label":"Credit note deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/deletecreditnote","routeSlug":"/shoptet-api/openapi/credit-notes/deletecreditnote","metadata":{"seo":{"title":"Credit note deletion","description":"Credit note deletion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCreditNote","name":"Credit note deletion","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit note deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000002"}],"pointer":"/paths/~1api~1credit-notes~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/credit-notes/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000002","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/credit-notes/{code}","href":"credit-notes/deletecreditnote","openApiOperationId":"deleteCreditNote","summary":"Credit note deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1credit-notes~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/deletecreditnote"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}"},{"label":"Credit note restock","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/restockcreditnote","routeSlug":"/shoptet-api/openapi/credit-notes/restockcreditnote","metadata":{"seo":{"title":"Credit note restock","description":"Restock items from credit note."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"restockCreditNote","name":"Credit note restock","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}~1restock/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit note restock","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Restock items from credit note."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000002"}],"pointer":"/paths/~1api~1credit-notes~1{code}~1restock/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}~1restock/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/credit-notes/{code}/restock","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000002","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/credit-notes/{code}/restock","href":"credit-notes/restockcreditnote","openApiOperationId":"restockCreditNote","summary":"Credit note restock","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_562"}},"schemaId":"schema_562"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1restock/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1restock/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1restock/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1restock/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1credit-notes~1{code}~1restock/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_562","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_562"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1restock/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1restock/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1restock/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1restock/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/restockcreditnote"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}/restock"},{"label":"Credit note from invoice creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/createcreditnotefrominvoice","routeSlug":"/shoptet-api/openapi/credit-notes/createcreditnotefrominvoice","metadata":{"seo":{"title":"Credit note from invoice creation","description":"Creating credit note from existing invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCreditNoteFromInvoice","name":"Credit note from invoice creation","isWebhook":false,"pointer":"/paths/~1api~1invoices~1{code}~1credit-note/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit note from invoice creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating credit note from existing invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value | Section"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"--------|------"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Item surcharge parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will create a credit note from the given invoice. It will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically take all invoice items and add them to the credit note. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you want to add just some items from the invoice or different amount,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"use the parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This parameter will allow you to generate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit note only with provided items."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Code of invoice","required":true,"example":"2018000004"}],"pointer":"/paths/~1api~1invoices~1{code}~1credit-note/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"surchargeParameters"}],"pointer":"/paths/~1api~1invoices~1{code}~1credit-note/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1invoices~1{code}~1credit-note/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_563"}},"schemaId":"schema_563","pointer":"/paths/~1api~1invoices~1{code}~1credit-note/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/invoices/{code}/credit-note","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000004","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","required":false,"example":"surchargeParameters","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_563"}},"responseCodes":["201","422"],"pointer":"/api/invoices/{code}/credit-note","href":"credit-notes/createcreditnotefrominvoice","openApiOperationId":"createCreditNoteFromInvoice","summary":"Credit note from invoice creation","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_563","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_563"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-1","paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-2"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-1","paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-2"]}],"pointer":"/paths/~1api~1invoices~1{code}~1credit-note/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-1","paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-1","paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/createcreditnotefrominvoice"}],"panels":[]}]},"httpPath":"/api/invoices/{code}/credit-note"},{"label":"Credit note from proof of payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/createcreditnotefromproofofpayment","routeSlug":"/shoptet-api/openapi/credit-notes/createcreditnotefromproofofpayment","metadata":{"seo":{"title":"Credit note from proof of payment","description":"Creating credit note from existing proof of payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCreditNoteFromProofOfPayment","name":"Credit note from proof of payment","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit note from proof of payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creating credit note from existing proof of payment.\n\nIt will create a credit note from the given proof of payment. It will\nautomatically take all proof of payment items and add them to the credit\nnote."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Proof of payment code","required":true,"example":"P-2014000004-01"}],"pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_564"}},"schemaId":"schema_564","pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proof-payments/{code}/credit-note","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"P-2014000004-01","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_564"}},"responseCodes":["201","404","409","422"],"pointer":"/api/proof-payments/{code}/credit-note","href":"credit-notes/createcreditnotefromproofofpayment","openApiOperationId":"createCreditNoteFromProofOfPayment","summary":"Credit note from proof of payment","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_564","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_564"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict with already created invoice","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/createcreditnotefromproofofpayment"}],"panels":[]}]},"httpPath":"/api/proof-payments/{code}/credit-note"},{"label":"Creation of credit note item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/createcreditnoteitem","routeSlug":"/shoptet-api/openapi/credit-notes/createcreditnoteitem","metadata":{"seo":{"title":"Creation of credit note item","description":"Creates a new credit note item to an existing credit, only billing or shipping item types are allowed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCreditNoteItem","name":"Creation of credit note item","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}~1item/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of credit note item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new credit note item to an existing credit, only billing or shipping item types are allowed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"credit note code (number)","required":true,"example":"2018000012"}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_565"}},"schemaId":"schema_565","pointer":"/paths/~1api~1credit-notes~1{code}~1item/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/credit-notes/{code}/item","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_565"}},"responseCodes":["200"],"pointer":"/api/credit-notes/{code}/item","href":"credit-notes/createcreditnoteitem","openApiOperationId":"createCreditNoteItem","summary":"Creation of credit note item","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_565","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_565"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560"}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/createcreditnoteitem"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}/item"},{"label":"Update of credit note item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/updatecreditnoteitem","routeSlug":"/shoptet-api/openapi/credit-notes/updatecreditnoteitem","metadata":{"seo":{"title":"Update of credit note item","description":"Updates credit note item. It's not possible to change productTypeproperty and it's not possible to update credit note item of anothertype then product or product-set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCreditNoteItem","name":"Update of credit note item","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of credit note item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates credit note item. It's not possible to change "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productType"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property and it's not possible to update credit note item of another"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"credit note code (number)","required":true,"example":"2018000012"},{"name":"id","in":"path","schemaId":"schema_522","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit note item id. Can be found in field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.creditNote.items.itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Credit note detail."},"children":[]}]}]}],"required":true,"example":198}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_566"}},"schemaId":"schema_566","pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/credit-notes/{code}/item/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":198,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_566"}},"responseCodes":["200","422"],"pointer":"/api/credit-notes/{code}/item/{id}","href":"credit-notes/updatecreditnoteitem","openApiOperationId":"updateCreditNoteItem","summary":"Update of credit note item","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_566","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_566"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_567"}},"schemaId":"schema_567"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_567","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_567"}}},{"code":"422","schemaId":"schema_568","exampleIds":["paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/updatecreditnoteitem"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}/item/{id}"},{"label":"Deletion of credit note item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/deletecreditnoteitem","routeSlug":"/shoptet-api/openapi/credit-notes/deletecreditnoteitem","metadata":{"seo":{"title":"Deletion of credit note item","description":"Deletes credit note item. It's not possible to delete credit note itemof another type then product or product-set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCreditNoteItem","name":"Deletion of credit note item","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of credit note item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes credit note item. It's not possible to delete credit note item"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of another type then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"credit note code (number)","required":true,"example":"2018000012"},{"name":"id","in":"path","schemaId":"schema_522","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credit note item id. Can be found in field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.creditNote.items.itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Credit note detail."},"children":[]}]}]}],"required":true,"example":198}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/credit-notes/{code}/item/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000012","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":198,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/credit-notes/{code}/item/{id}","href":"credit-notes/deletecreditnoteitem","openApiOperationId":"deleteCreditNoteItem","summary":"Deletion of credit note item","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/deletecreditnoteitem"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}/item/{id}"},{"label":"Download credit note as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/downloadcreditnotepdf","routeSlug":"/shoptet-api/openapi/credit-notes/downloadcreditnotepdf","metadata":{"seo":{"title":"Download credit note as PDF","description":"You can request the credit note as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCreditNotePdf","name":"Download credit note as PDF","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download credit note as PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the credit note as PDF file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download pdf documents"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000002"}],"pointer":"/paths/~1api~1credit-notes~1{code}~1pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/credit-notes/{code}/pdf","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000002","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/api/credit-notes/{code}/pdf","href":"credit-notes/downloadcreditnotepdf","openApiOperationId":"downloadCreditNotePdf","summary":"Download credit note as PDF","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1credit-notes~1{code}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/downloadcreditnotepdf"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}/pdf"},{"label":"Download credit note as ISDOC","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/downloadcreditnoteasisdoc","routeSlug":"/shoptet-api/openapi/credit-notes/downloadcreditnoteasisdoc","metadata":{"seo":{"title":"Download credit note as ISDOC","description":"You can request the credit note as ISDOC file, response will be asapplication/octet-stream. You can download the documentsonly one-by-one for every e-shop. Parallel requests end with 423 Locked error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCreditNoteAsIsdoc","name":"Download credit note as ISDOC","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1{code}~1isdoc/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download credit note as ISDOC","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the credit note as ISDOC file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download the documents"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000002"}],"pointer":"/paths/~1api~1credit-notes~1{code}~1isdoc/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1{code}~1isdoc/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/credit-notes/{code}/isdoc","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000002","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/api/credit-notes/{code}/isdoc","href":"credit-notes/downloadcreditnoteasisdoc","openApiOperationId":"downloadCreditNoteAsIsdoc","summary":"Download credit note as ISDOC","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1credit-notes~1{code}~1isdoc/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/downloadcreditnoteasisdoc"}],"panels":[]}]},"httpPath":"/api/credit-notes/{code}/isdoc"},{"label":"Last credit note changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/credit-notes/getlastcreditnotechanges","routeSlug":"/shoptet-api/openapi/credit-notes/getlastcreditnotechanges","metadata":{"seo":{"title":"Last credit note changes","description":"Returns the list of credit notes, which were changed. The Endpoint is intended to determinethe changes after you have loaded the list of credit notes and you need to know the changes.The guaranteed history of changes is 30 days."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLastCreditNoteChanges","name":"Last credit note changes","isWebhook":false,"pointer":"/paths/~1api~1credit-notes~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last credit note changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of credit notes, which were changed. The Endpoint is intended to determine"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the changes after you have loaded the list of credit notes and you need to know the changes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The guaranteed history of changes is 30 days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each credit note is only given in the listing with its last change. For example, if the credit note was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"modified and then deleted, the listing will only show information about its deletion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be filtered by changeType = edit/delete parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation is considered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action. So, when there is a new item created, it will be displayed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime from which up to the present we are interested in the changes. + in the time zone"},"children":[]}]}]}],"required":true,"example":"2018-01-01T01:01:01+02:00"},{"name":"changeType","in":"query","schemaId":"schema_523","description":"Returning only edit or delete type changed records","example":"edit"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1credit-notes~1changes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1credit-notes~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/credit-notes/changes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":true,"example":"2018-01-01T01:01:01+02:00","schemaId":"schema_523"},{"name":"changeType","in":"query","required":false,"example":"edit","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/credit-notes/changes","href":"credit-notes/getlastcreditnotechanges","openApiOperationId":"getLastCreditNoteChanges","summary":"Last credit note changes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}},"schemaId":"schema_569"}],"pointer":"/paths/~1api~1credit-notes~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_569","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-notes/getlastcreditnotechanges"}],"panels":[]}]},"httpPath":"/api/credit-notes/changes"}],"content":{"contentType":"group","meta":{"name":"Credit notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit notes","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing credit notes in the e-shop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is the credit note identifier. Although this is usually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a number, it is necessary to take into account that this might also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include letters, a dash, etc."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/credit-notes","summary":"List of credit notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-notes/getlistofcreditnotes","deprecated":false},{"title":"/api/credit-notes/snapshot","summary":"List of all credit notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-notes/getlistofallcreditnotes","deprecated":false},{"title":"/api/credit-notes/{code}","summary":"Credit note detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-notes/getcreditnotedetail","deprecated":false},{"title":"/api/credit-notes/{code}","summary":"Credit note update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/credit-notes/updatecreditnote","deprecated":false},{"title":"/api/credit-notes/{code}","summary":"Credit note deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credit-notes/deletecreditnote","deprecated":false},{"title":"/api/credit-notes/{code}/restock","summary":"Credit note restock","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-notes/restockcreditnote","deprecated":false},{"title":"/api/invoices/{code}/credit-note","summary":"Credit note from invoice creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-notes/createcreditnotefrominvoice","deprecated":false},{"title":"/api/proof-payments/{code}/credit-note","summary":"Credit note from proof of payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-notes/createcreditnotefromproofofpayment","deprecated":false},{"title":"/api/credit-notes/{code}/item","summary":"Creation of credit note item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-notes/createcreditnoteitem","deprecated":false},{"title":"/api/credit-notes/{code}/item/{id}","summary":"Update of credit note item","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/credit-notes/updatecreditnoteitem","deprecated":false},{"title":"/api/credit-notes/{code}/item/{id}","summary":"Deletion of credit note item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credit-notes/deletecreditnoteitem","deprecated":false},{"title":"/api/credit-notes/{code}/pdf","summary":"Download credit note as PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-notes/downloadcreditnotepdf","deprecated":false},{"title":"/api/credit-notes/{code}/isdoc","summary":"Download credit note as ISDOC","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-notes/downloadcreditnoteasisdoc","deprecated":false},{"title":"/api/credit-notes/changes","summary":"Last credit note changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-notes/getlastcreditnotechanges","deprecated":false}]}]}]}]}},{"type":"group","label":"Delivery notes","link":"/shoptet-api/openapi/delivery-notes","routeSlug":"/shoptet-api/openapi/delivery-notes","items":[{"label":"Delivery note from Order creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/deliverynotefromorder","routeSlug":"/shoptet-api/openapi/delivery-notes/deliverynotefromorder","metadata":{"seo":{"title":"Delivery note from Order creation","description":"Creating delivery note from existing order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deliveryNoteFromOrder","name":"Delivery note from Order creation","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1delivery-notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery note from Order creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creating delivery note from existing order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Order code","required":true,"example":"2018000053"}],"pointer":"/paths/~1api~1orders~1{code}~1delivery-notes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1delivery-notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_570"}},"schemaId":"schema_570","pointer":"/paths/~1api~1orders~1{code}~1delivery-notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{code}/delivery-notes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000053","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_570"}},"responseCodes":["201","404","409","422"],"pointer":"/api/orders/{code}/delivery-notes","href":"delivery-notes/deliverynotefromorder","openApiOperationId":"deliveryNoteFromOrder","summary":"Delivery note from Order creation","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_570","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_570"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}},"schemaId":"schema_571"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1delivery-notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_571","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1delivery-notes/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-notes/deliverynotefromorder"}],"panels":[]}]},"httpPath":"/api/orders/{code}/delivery-notes"},{"label":"List of delivery notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/getlistofdeliverynotes","routeSlug":"/shoptet-api/openapi/delivery-notes/getlistofdeliverynotes","metadata":{"seo":{"title":"List of delivery notes","description":"The list of delivery notes supports the Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfDeliveryNotes","name":"List of delivery notes","isWebhook":false,"pointer":"/paths/~1api~1delivery-notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of delivery notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of delivery notes supports the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isValid","in":"query","schemaId":"schema_542","description":"sorting according to document validity","example":true},{"name":"orderCode","in":"query","schemaId":"schema_523","description":"sorting according to number of order","example":"2018000012"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 100.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1delivery-notes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1delivery-notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/delivery-notes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"},{"name":"orderCode","in":"query","example":"2018000012","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/delivery-notes","href":"delivery-notes/getlistofdeliverynotes","openApiOperationId":"getListOfDeliveryNotes","summary":"List of delivery notes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_572"}},"schemaId":"schema_572"}],"pointer":"/paths/~1api~1delivery-notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_572","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_572"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-notes/getlistofdeliverynotes"}],"panels":[]}]},"httpPath":"/api/delivery-notes"},{"label":"List of all delivery notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/getlistofalldeliverynotes","routeSlug":"/shoptet-api/openapi/delivery-notes/getlistofalldeliverynotes","metadata":{"seo":{"title":"List of all delivery notes","description":"Using this endpoint, you can get list of all delivery notes with detailed info of each delivery note (like in Delivery note detail endpoint) asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllDeliveryNotes","name":"List of all delivery notes","isWebhook":false,"pointer":"/paths/~1api~1delivery-notes~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all delivery notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all delivery notes with detailed info of each delivery note (like in Delivery note detail endpoint) asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each delivery note taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One delivery note in response has the same format as delivery note detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/deliverynotesnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery note snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"Export delivery notes created after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"Export delivery notes created before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"Export delivery notes updated after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":"Export delivery notes updated before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"Export delivery notes with code after given value","example":"0000000006"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"Export delivery notes with code befor given value","example":"0000000006"},{"name":"orderCodeFrom","in":"query","schemaId":"schema_523","description":"Export delivery notes with order code after given value","example":"2017000010"},{"name":"orderCodeTo","in":"query","schemaId":"schema_523","description":"Export delivery notes with order code before given value","example":"2017000010"},{"name":"customerGuid","in":"query","schemaId":"schema_523","description":"Export delivery notes with given customer","example":"443cad54-73bc-11e8-8216-002590dad85e"},{"name":"isValid","in":"query","schemaId":"schema_542","description":"Filtering according to document validity","example":true}],"pointer":"/paths/~1api~1delivery-notes~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1delivery-notes~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/delivery-notes/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"codeFrom","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"orderCodeFrom","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"orderCodeTo","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"customerGuid","in":"query","example":"443cad54-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/delivery-notes/snapshot","href":"delivery-notes/getlistofalldeliverynotes","openApiOperationId":"getListOfAllDeliveryNotes","summary":"List of all delivery notes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532","exampleIds":["paths/~1api~1delivery-notes~1snapshot/get/responses/202/content/application~1json/example"]}},"schemaId":"schema_532","exampleIds":["paths/~1api~1delivery-notes~1snapshot/get/responses/202/content/application~1json/example"]}],"pointer":"/paths/~1api~1delivery-notes~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","exampleIds":["paths/~1api~1delivery-notes~1snapshot/get/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532","exampleIds":["paths/~1api~1delivery-notes~1snapshot/get/responses/202/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-notes/getlistofalldeliverynotes"}],"panels":[]}]},"httpPath":"/api/delivery-notes/snapshot"},{"label":"Detail of delivery note","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/getdetailofdeliverynote","routeSlug":"/shoptet-api/openapi/delivery-notes/getdetailofdeliverynote","metadata":{"seo":{"title":"Detail of delivery note","description":"Additional information about one delivery note."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfDeliveryNote","name":"Detail of delivery note","isWebhook":false,"pointer":"/paths/~1api~1delivery-notes~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of delivery note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about one delivery note."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000003"}],"pointer":"/paths/~1api~1delivery-notes~1{code}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response","example":"surchargeParameters"}],"pointer":"/paths/~1api~1delivery-notes~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1delivery-notes~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/delivery-notes/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000003","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","example":"surchargeParameters","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/delivery-notes/{code}","href":"delivery-notes/getdetailofdeliverynote","openApiOperationId":"getDetailOfDeliveryNote","summary":"Detail of delivery note","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}},"schemaId":"schema_571"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1delivery-notes~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_571","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_571"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-notes/getdetailofdeliverynote"}],"panels":[]}]},"httpPath":"/api/delivery-notes/{code}"},{"label":"Download delivery note as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery-notes/downloaddeliverynoteaspdf","routeSlug":"/shoptet-api/openapi/delivery-notes/downloaddeliverynoteaspdf","metadata":{"seo":{"title":"Download delivery note as PDF","description":"You can request the delivery note as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadDeliveryNoteAsPdf","name":"Download delivery note as PDF","isWebhook":false,"pointer":"/paths/~1api~1delivery-notes~1{code}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download delivery note as PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the delivery note as PDF file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download pdf documents"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"0000000001"}],"pointer":"/paths/~1api~1delivery-notes~1{code}~1pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1delivery-notes~1{code}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/delivery-notes/{code}/pdf","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"0000000001","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/api/delivery-notes/{code}/pdf","href":"delivery-notes/downloaddeliverynoteaspdf","openApiOperationId":"downloadDeliveryNoteAsPdf","summary":"Download delivery note as PDF","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1delivery-notes~1{code}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery-notes/downloaddeliverynoteaspdf"}],"panels":[]}]},"httpPath":"/api/delivery-notes/{code}/pdf"}],"content":{"contentType":"group","meta":{"name":"Delivery notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery notes","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing delivery notes in the e-shop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is the credit notes identifier. Although this is usually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a number, it is necessary to take into account that this might also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include letters, a dash, etc."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/{code}/delivery-notes","summary":"Delivery note from Order creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/delivery-notes/deliverynotefromorder","deprecated":false},{"title":"/api/delivery-notes","summary":"List of delivery notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery-notes/getlistofdeliverynotes","deprecated":false},{"title":"/api/delivery-notes/snapshot","summary":"List of all delivery notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery-notes/getlistofalldeliverynotes","deprecated":false},{"title":"/api/delivery-notes/{code}","summary":"Detail of delivery note","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery-notes/getdetailofdeliverynote","deprecated":false},{"title":"/api/delivery-notes/{code}/pdf","summary":"Download delivery note as PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery-notes/downloaddeliverynoteaspdf","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoices","link":"/shoptet-api/openapi/invoices","routeSlug":"/shoptet-api/openapi/invoices","items":[{"label":"List of invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/getlistofinvoices","routeSlug":"/shoptet-api/openapi/invoices/getlistofinvoices","metadata":{"seo":{"title":"List of invoices","description":"Returns the list of invoices with basic information.The list of invoices supports Paging"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfInvoices","name":"List of invoices","isWebhook":false,"pointer":"/paths/~1api~1invoices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of invoices with basic information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of invoices supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is the invoice identifier. Although this is usually a number,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is necessary to take into account that this might also include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"letters, a dash, etc. Filtering uses string comparison with >=, <= operators."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isValid","in":"query","schemaId":"schema_542","description":"filtering according to document validity","example":true},{"name":"proformaInvoiceCode","in":"query","schemaId":"schema_523","description":"filtering according to number of proforma invoice","example":"2017000017"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"filtering according to date of invoice issue","example":"2017-02-28T17:04:47+0100"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"filtering according to date of invoice issue","example":"2028-02-28T17:04:47+0100"},{"name":"taxDateFrom","in":"query","schemaId":"schema_523","description":"filtering according to tax date of invoice","example":"2017-02-28T17:04:47+0100"},{"name":"orderCode","in":"query","schemaId":"schema_523","description":"filtering according to order code of invoice","example":"2018000012"},{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"filtering according to code of invoice","example":"2018000001"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"filtering according to code of invoice","example":"2018000012"},{"name":"varSymbol","in":"query","schemaId":"schema_523","description":"filtering according to variable symbol of invoice","example":"666"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 1000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1invoices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1invoices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/invoices","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"},{"name":"proformaInvoiceCode","in":"query","example":"2017000017","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2028-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"taxDateFrom","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"orderCode","in":"query","example":"2018000012","schemaId":"schema_523"},{"name":"codeFrom","in":"query","example":"2018000001","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"2018000012","schemaId":"schema_523"},{"name":"varSymbol","in":"query","example":"666","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/invoices","href":"invoices/getlistofinvoices","openApiOperationId":"getListOfInvoices","summary":"List of invoices","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_573"}},"schemaId":"schema_573"}],"pointer":"/paths/~1api~1invoices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_573","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_573"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getlistofinvoices"}],"panels":[]}]},"httpPath":"/api/invoices"},{"label":"List of all invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/getlistofallinvoices","routeSlug":"/shoptet-api/openapi/invoices/getlistofallinvoices","metadata":{"seo":{"title":"List of all invoices","description":"Using this endpoint, you can get list of all invoices with detailed info of each invoice (like in Invoice Detail endpoint) asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllInvoices","name":"List of all invoices","isWebhook":false,"pointer":"/paths/~1api~1invoices~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all invoices with detailed info of each invoice (like in Invoice Detail endpoint) asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each invoice taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One invoice in response has the same format as invoice detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/invoicesnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"surchargeParameters"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"Export invoices created after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"Export invoices created before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"Export invoices updated after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":"Export invoices updated before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"Export invoices with code after given value","example":"0000000006"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"Export invoices with code before given value","example":"0000000006"},{"name":"proformaInvoiceCodeFrom","in":"query","schemaId":"schema_523","description":"Export invoices with proforma invoice code after given value","example":"2017000010"},{"name":"proformaInvoiceCodeTo","in":"query","schemaId":"schema_523","description":"Export invoices with proforma invoice code befor given value","example":"2017000010"},{"name":"dueDateFrom","in":"query","schemaId":"schema_523","description":"Export invoices with due date after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"dueDateTo","in":"query","schemaId":"schema_523","description":"Export invoices with due date before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"taxDateFrom","in":"query","schemaId":"schema_523","description":"Export invoices with tax date after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"taxDateTo","in":"query","schemaId":"schema_523","description":"Export invoices with tax date before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"orderCodeFrom","in":"query","schemaId":"schema_523","description":"Export invoices with order code after given value","example":"2017000010"},{"name":"orderCodeTo","in":"query","schemaId":"schema_523","description":"Export invoices with order code before given value","example":"2017000010"},{"name":"customerGuid","in":"query","schemaId":"schema_523","description":"Export invoices with given customer","example":"443cad54-73bc-11e8-8216-002590dad85e"},{"name":"varSymbol","in":"query","schemaId":"schema_523","description":"Export invoices with given variable symbol","example":"2010001"},{"name":"isValid","in":"query","schemaId":"schema_542","description":"Filtering according to document validity","example":true},{"name":"hasTaxId","in":"query","schemaId":"schema_542","description":"Filtering according to the presence of a TAX identification number","example":true},{"name":"hasVatId","in":"query","schemaId":"schema_542","description":"Filtering according to the presence of a VAT identification number","example":true},{"name":"hasCompanyId","in":"query","schemaId":"schema_542","description":"Filtering according to the presence of a company registration number","example":true}],"pointer":"/paths/~1api~1invoices~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1invoices~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/invoices/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"surchargeParameters","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"codeFrom","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"proformaInvoiceCodeFrom","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"proformaInvoiceCodeTo","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"dueDateFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"dueDateTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"taxDateFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"taxDateTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"orderCodeFrom","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"orderCodeTo","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"customerGuid","in":"query","example":"443cad54-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"varSymbol","in":"query","example":"2010001","schemaId":"schema_523"},{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"},{"name":"hasTaxId","in":"query","example":true,"schemaId":"schema_542"},{"name":"hasVatId","in":"query","example":true,"schemaId":"schema_542"},{"name":"hasCompanyId","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/invoices/snapshot","href":"invoices/getlistofallinvoices","openApiOperationId":"getListOfAllInvoices","summary":"List of all invoices","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}},"schemaId":"schema_574"}],"pointer":"/paths/~1api~1invoices~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_574","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getlistofallinvoices"}],"panels":[]}]},"httpPath":"/api/invoices/snapshot"},{"label":"Invoice detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/getinvoicedetail","routeSlug":"/shoptet-api/openapi/invoices/getinvoicedetail","metadata":{"seo":{"title":"Invoice detail","description":"Detailed information about one invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoiceDetail","name":"Invoice detail","isWebhook":false,"pointer":"/paths/~1api~1invoices~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed information about one invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In most cases the items in the response are the same as you can see in the administration of PDF printout of an invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are however some advanced cases (in case of coupon discount with absolute value or in case of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a volume discount and products with multiple VAT rates in the invoice), in which case they are different:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administration and PDF will show multiple rows for the discount – for each VAT rate one row and the price field split evenly."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API response will return only one row indication the total discount price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The difference is based on how data is internally stored and presented. The API is bases more on internal storage principle,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there is however also an array "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayPrices"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which contains the presentation (printout) form of each item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000004"}],"pointer":"/paths/~1api~1invoices~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1invoices~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/invoices/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000004","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/invoices/{code}","href":"invoices/getinvoicedetail","openApiOperationId":"getInvoiceDetail","summary":"Invoice detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1invoices~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoicedetail"}],"panels":[]}]},"httpPath":"/api/invoices/{code}"},{"label":"Invoice from order creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/createinvoicefromorder","routeSlug":"/shoptet-api/openapi/invoices/createinvoicefromorder","metadata":{"seo":{"title":"Invoice from order creation","description":"Creating invoice from existing order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInvoiceFromOrder","name":"Invoice from order creation","isWebhook":false,"pointer":"/paths/~1api~1orders~1{code}~1invoice/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice from order creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creating invoice from existing order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Code of order","required":true,"example":"2018000053"}],"pointer":"/paths/~1api~1orders~1{code}~1invoice/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressExistenceCheck","in":"query","schemaId":"schema_529","description":"suppress checking of existing invoices per order (allows multiple\ninvoices per order)","example":true}],"pointer":"/paths/~1api~1orders~1{code}~1invoice/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1{code}~1invoice/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_576"}},"schemaId":"schema_576","pointer":"/paths/~1api~1orders~1{code}~1invoice/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/orders/{code}/invoice","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000053","schemaId":"schema_523"}],"query":[{"name":"suppressExistenceCheck","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_576"}},"responseCodes":["201","422"],"pointer":"/api/orders/{code}/invoice","href":"invoices/createinvoicefromorder","openApiOperationId":"createInvoiceFromOrder","summary":"Invoice from order creation","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_576","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_576"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1invoice/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1invoice/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1orders~1{code}~1invoice/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1invoice/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1orders~1{code}~1invoice/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/createinvoicefromorder"}],"panels":[]}]},"httpPath":"/api/orders/{code}/invoice"},{"label":"Invoice from proforma invoice creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/createinvoicefromproformainvoice","routeSlug":"/shoptet-api/openapi/invoices/createinvoicefromproformainvoice","metadata":{"seo":{"title":"Invoice from proforma invoice creation","description":"Creating invoice from existing proforma invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInvoiceFromProformaInvoice","name":"Invoice from proforma invoice creation","isWebhook":false,"pointer":"/paths/~1api~1proforma-invoices~1{code}~1invoice/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice from proforma invoice creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creating invoice from existing proforma invoice."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Code of proforma invoice","required":true,"example":"2018000053"}],"pointer":"/paths/~1api~1proforma-invoices~1{code}~1invoice/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressExistenceCheck","in":"query","schemaId":"schema_529","description":"suppress checking of existing invoices per order (allows multiple\ninvoices per order)","example":true}],"pointer":"/paths/~1api~1proforma-invoices~1{code}~1invoice/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proforma-invoices~1{code}~1invoice/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_577"}},"schemaId":"schema_577","pointer":"/paths/~1api~1proforma-invoices~1{code}~1invoice/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proforma-invoices/{code}/invoice","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000053","schemaId":"schema_523"}],"query":[{"name":"suppressExistenceCheck","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_577"}},"responseCodes":["201"],"pointer":"/api/proforma-invoices/{code}/invoice","href":"invoices/createinvoicefromproformainvoice","openApiOperationId":"createInvoiceFromProformaInvoice","summary":"Invoice from proforma invoice creation","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_577"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575"}],"pointer":"/paths/~1api~1proforma-invoices~1{code}~1invoice/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/createinvoicefromproformainvoice"}],"panels":[]}]},"httpPath":"/api/proforma-invoices/{code}/invoice"},{"label":"Invoice link proforma invoices","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/invoicelinkproformainvoices","routeSlug":"/shoptet-api/openapi/invoices/invoicelinkproformainvoices","metadata":{"seo":{"title":"Invoice link proforma invoices","description":"Linking proforma invoices to invoice. Proforma invoices must be related to the order, must be in same currency as the order, must be valid and cannot be linked to another invoice. Multiple proforma invoices are allowed to link to the invoice.This endpoint has several sections, which are only sent when requested in the include parameter (seeRequested sections)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoiceLinkProformaInvoices","name":"Invoice link proforma invoices","isWebhook":false,"pointer":"/paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice link proforma invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linking proforma invoices to invoice. Proforma invoices must be related to the order, must be in same currency as the order, must be valid and cannot be linked to another invoice. Multiple proforma invoices are allowed to link to the invoice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles-of-working-with-api/Section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requested sections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Code of the invoice","required":true,"example":"2018000053"}],"pointer":"/paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"surchargeParameters"}],"pointer":"/paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_578"}},"schemaId":"schema_578","pointer":"/paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/invoices/{code}/link-proforma-invoice","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000053","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","required":false,"example":"surchargeParameters","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_578"}},"responseCodes":["200","404","409","422"],"pointer":"/api/invoices/{code}/link-proforma-invoice","href":"invoices/invoicelinkproformainvoices","openApiOperationId":"invoiceLinkProformaInvoices","summary":"Invoice link proforma invoices","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_578","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_578"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicelinkproformainvoices"}],"panels":[]}]},"httpPath":"/api/invoices/{code}/link-proforma-invoice"},{"label":"Invoice link proof payments","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/invoicelinkproofpayments","routeSlug":"/shoptet-api/openapi/invoices/invoicelinkproofpayments","metadata":{"seo":{"title":"Invoice link proof payments","description":"Linking proof payments to invoice. Proof payments must be related to the order, must be in same currencyas the order, must be valid and cannot be linked to another invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invoiceLinkProofPayments","name":"Invoice link proof payments","isWebhook":false,"pointer":"/paths/~1api~1invoices~1{code}~1link-proof-payment/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice link proof payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linking proof payments to invoice. Proof payments must be related to the order, must be in same currency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as the order, must be valid and cannot be linked to another invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Code of the invoice","required":true,"example":"2018000053"}],"pointer":"/paths/~1api~1invoices~1{code}~1link-proof-payment/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"surchargeParameters"}],"pointer":"/paths/~1api~1invoices~1{code}~1link-proof-payment/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1invoices~1{code}~1link-proof-payment/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_579"}},"schemaId":"schema_579","pointer":"/paths/~1api~1invoices~1{code}~1link-proof-payment/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/invoices/{code}/link-proof-payment","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000053","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","required":false,"example":"surchargeParameters","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_579"}},"responseCodes":["201","404","409","422"],"pointer":"/api/invoices/{code}/link-proof-payment","href":"invoices/invoicelinkproofpayments","openApiOperationId":"invoiceLinkProofPayments","summary":"Invoice link proof payments","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_579","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_579"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/invoicelinkproofpayments"}],"panels":[]}]},"httpPath":"/api/invoices/{code}/link-proof-payment"},{"label":"Download invoice as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/downloadinvoiceaspdf","routeSlug":"/shoptet-api/openapi/invoices/downloadinvoiceaspdf","metadata":{"seo":{"title":"Download invoice as PDF","description":"You can request the invoice as PDF file, response will be asapplication/octet-stream. You can download pdf documentsonly one-by-one for every e-shop. Parallel requests end with 423 Locked error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadInvoiceAsPdf","name":"Download invoice as PDF","isWebhook":false,"pointer":"/paths/~1api~1invoices~1{code}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download invoice as PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the invoice as PDF file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download pdf documents"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000004"}],"pointer":"/paths/~1api~1invoices~1{code}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/invoices/{code}/pdf","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000004","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/api/invoices/{code}/pdf","href":"invoices/downloadinvoiceaspdf","openApiOperationId":"downloadInvoiceAsPdf","summary":"Download invoice as PDF","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1invoices~1{code}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/downloadinvoiceaspdf"}],"panels":[]}]},"httpPath":"/api/invoices/{code}/pdf"},{"label":"Download invoice as ISDOC","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/downloadinvoiceasisdoc","routeSlug":"/shoptet-api/openapi/invoices/downloadinvoiceasisdoc","metadata":{"seo":{"title":"Download invoice as ISDOC","description":"You can request the invoice as ISDOC file, response will be asapplication/octet-stream. You can download the documentsonly one-by-one for every e-shop. Parallel requests end with 423 Locked error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadInvoiceAsIsdoc","name":"Download invoice as ISDOC","isWebhook":false,"pointer":"/paths/~1api~1invoices~1{code}~1isdoc/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download invoice as ISDOC","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the invoice as ISDOC file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download the documents"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000004"}],"pointer":"/paths/~1api~1invoices~1{code}~1isdoc/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1invoices~1{code}~1isdoc/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/invoices/{code}/isdoc","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000004","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/api/invoices/{code}/isdoc","href":"invoices/downloadinvoiceasisdoc","openApiOperationId":"downloadInvoiceAsIsdoc","summary":"Download invoice as ISDOC","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1isdoc/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1isdoc/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1invoices~1{code}~1isdoc/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1isdoc/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1isdoc/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1isdoc/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1invoices~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/downloadinvoiceasisdoc"}],"panels":[]}]},"httpPath":"/api/invoices/{code}/isdoc"},{"label":"Last invoice changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/invoices/getlastinvoicechanges","routeSlug":"/shoptet-api/openapi/invoices/getlastinvoicechanges","metadata":{"seo":{"title":"Last invoice changes","description":"Returns the list of invoices, which were changed (added/changed or deleted). Endpoint is intended to determinethe changes after you have loaded the complete list of invoices and you need to know if any of these was been changed (ordeleted). Guaranteed history is 30 days, the older data are deleted progressively."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLastInvoiceChanges","name":"Last invoice changes","isWebhook":false,"pointer":"/paths/~1api~1invoices~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last invoice changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of invoices, which were changed (added/changed or deleted). Endpoint is intended to determine"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the changes after you have loaded the complete list of invoices and you need to know if any of these was been changed (or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted). Guaranteed history is 30 days, the older data are deleted progressively."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each invoice in the log is only mentioned with its last change. For example, if the invoice was modified and then deleted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the log will only show information about its deletion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be filtered by changeType = edit/delete parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation is considered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action. So, when there is a new item created, it will be displayed like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime from which up to the present we are interested in the changes. + in the time zone"},"children":[]}]}]}],"required":true,"example":"2018-01-01T01:01:01+02:00"},{"name":"changeType","in":"query","schemaId":"schema_523","description":"Returning only edit or delete type changed records","example":"edit"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1invoices~1changes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1invoices~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/invoices/changes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":true,"example":"2018-01-01T01:01:01+02:00","schemaId":"schema_523"},{"name":"changeType","in":"query","required":false,"example":"edit","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/invoices/changes","href":"invoices/getlastinvoicechanges","openApiOperationId":"getLastInvoiceChanges","summary":"Last invoice changes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}},"schemaId":"schema_569"}],"pointer":"/paths/~1api~1invoices~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_569","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getlastinvoicechanges"}],"panels":[]}]},"httpPath":"/api/invoices/changes"}],"content":{"contentType":"group","meta":{"name":"Invoices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoices","showPageActions":true},{"nodeType":"markdoc","content":"Managing invoices in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/invoices","summary":"List of invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getlistofinvoices","deprecated":false},{"title":"/api/invoices/snapshot","summary":"List of all invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getlistofallinvoices","deprecated":false},{"title":"/api/invoices/{code}","summary":"Invoice detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoicedetail","deprecated":false},{"title":"/api/orders/{code}/invoice","summary":"Invoice from order creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/createinvoicefromorder","deprecated":false},{"title":"/api/proforma-invoices/{code}/invoice","summary":"Invoice from proforma invoice creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/createinvoicefromproformainvoice","deprecated":false},{"title":"/api/invoices/{code}/link-proforma-invoice","summary":"Invoice link proforma invoices","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/invoices/invoicelinkproformainvoices","deprecated":false},{"title":"/api/invoices/{code}/link-proof-payment","summary":"Invoice link proof payments","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/invoices/invoicelinkproofpayments","deprecated":false},{"title":"/api/invoices/{code}/pdf","summary":"Download invoice as PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/downloadinvoiceaspdf","deprecated":false},{"title":"/api/invoices/{code}/isdoc","summary":"Download invoice as ISDOC","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/downloadinvoiceasisdoc","deprecated":false},{"title":"/api/invoices/changes","summary":"Last invoice changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getlastinvoicechanges","deprecated":false}]}]}]}]}},{"type":"group","label":"Proforma invoices","link":"/shoptet-api/openapi/proforma-invoices","routeSlug":"/shoptet-api/openapi/proforma-invoices","items":[{"label":"Proforma invoice from order creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/createproformainvoicefromorder","routeSlug":"/shoptet-api/openapi/proforma-invoices/createproformainvoicefromorder","metadata":{"seo":{"title":"Proforma invoice from order creation","description":"Creating proforma invoice from existing order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProformaInvoiceFromOrder","name":"Proforma invoice from order creation","isWebhook":false,"pointer":"/paths/~1api_orders_{code}_proforma-invoice.yaml/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proforma invoice from order creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creating proforma invoice from existing order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Code of order","required":true,"example":"2018000053"}],"pointer":"/paths/~1api_orders_{code}_proforma-invoice.yaml/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressExistenceCheck","in":"query","schemaId":"schema_529","description":"suppress checking of existing proforma invoices per order (allows multiple\nproforma invoices per order)","example":true}],"pointer":"/paths/~1api_orders_{code}_proforma-invoice.yaml/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api_orders_{code}_proforma-invoice.yaml/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_580"}},"schemaId":"schema_580","pointer":"/paths/~1api_orders_{code}_proforma-invoice.yaml/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api_orders_{code}_proforma-invoice.yaml","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000053","schemaId":"schema_523"}],"query":[{"name":"suppressExistenceCheck","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_580"}},"responseCodes":["201","404","409","422"],"pointer":"/api_orders_{code}_proforma-invoice.yaml","href":"proforma-invoices/createproformainvoicefromorder","openApiOperationId":"createProformaInvoiceFromOrder","summary":"Proforma invoice from order creation","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_580","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_580"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_581"}},"schemaId":"schema_581"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_581","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_581"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proforma-invoices/createproformainvoicefromorder"}],"panels":[]}]},"httpPath":"/api_orders_{code}_proforma-invoice.yaml"},{"label":"List of proforma invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/getlistofproformainvoices","routeSlug":"/shoptet-api/openapi/proforma-invoices/getlistofproformainvoices","metadata":{"seo":{"title":"List of proforma invoices","description":"Returns the list of proforma invoices. Supports thePaging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProformaInvoices","name":"List of proforma invoices","isWebhook":false,"pointer":"/paths/~1api~1proforma-invoices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of proforma invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of proforma invoices. Supports the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isValid","in":"query","schemaId":"schema_542","description":"filtering according to document validity","example":true},{"name":"orderCode","in":"query","schemaId":"schema_523","description":"filtering according to number of order.","example":"2018000012"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filtering items created after or same as requested datetime. ISO"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8601 format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}],"example":"2017-02-28T17:04:47+0100"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filtering items created before or same as requested datetime. ISO"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8601 format (\"2017-12-12T22:08:01+0100\")"},"children":[]}]}]}],"example":"2017-02-28T17:04:47+0100"},{"name":"varSymbol","in":"query","schemaId":"schema_523","description":"filtering according to variable symbol of proforma invoice","example":"666"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 100.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1proforma-invoices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proforma-invoices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proforma-invoices","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"},{"name":"orderCode","in":"query","example":"2018000012","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"varSymbol","in":"query","example":"666","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/proforma-invoices","href":"proforma-invoices/getlistofproformainvoices","openApiOperationId":"getListOfProformaInvoices","summary":"List of proforma invoices","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_582"}},"schemaId":"schema_582"}],"pointer":"/paths/~1api~1proforma-invoices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_582","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_582"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proforma-invoices/getlistofproformainvoices"}],"panels":[]}]},"httpPath":"/api/proforma-invoices"},{"label":"List of all proforma invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/getlistofallproformainvoices","routeSlug":"/shoptet-api/openapi/proforma-invoices/getlistofallproformainvoices","metadata":{"seo":{"title":"List of all proforma invoices","description":"Using this endpoint, you can get list of all proforma invoices with detailed info of each proforma invoice (like in Proforma invoice detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllProformaInvoices","name":"List of all proforma invoices","isWebhook":false,"pointer":"/paths/~1api~1proforma-invoices~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all proforma invoices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all proforma invoices with detailed info of each proforma invoice (like in Proforma invoice detail endpoint) asynchronously. See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each proforma invoice taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One invoice in response has the same format as invoice detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/proformainvoicesnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proforma invoice snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has one section, which is only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"surchargeParameters"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"Export proforma invoices created after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"Export proforma invoices created before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"Export proforma invoices updated after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":"Export proforma invoices updated before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"Export proforma invoices with code after given value (given code included)","example":"0000000006"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"Export proforma invoices with code before given value (given code included)","example":"0000000006"},{"name":"proformaInvoiceCodeFrom","in":"query","schemaId":"schema_523","description":"Export invoices with proforma invoice code after given value","example":"2017000010"},{"name":"proformaInvoiceCodeTo","in":"query","schemaId":"schema_523","description":"Export invoices with proforma invoice code befor given value","example":"2017000010"},{"name":"isValid","in":"query","schemaId":"schema_542","description":"Filtering according to document validity","example":true},{"name":"paid","in":"query","schemaId":"schema_542","description":"Filtering according to if proforma invoice is paid","example":true},{"name":"currencyCode","in":"query","schemaId":"schema_523","description":"Export proforma invoices with given currency code, if given currency code does not exists, or is not valid, it will throw an exception","example":"CZK"}],"pointer":"/paths/~1api~1proforma-invoices~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proforma-invoices~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proforma-invoices/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"surchargeParameters","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"codeFrom","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"proformaInvoiceCodeFrom","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"proformaInvoiceCodeTo","in":"query","example":"2017000010","schemaId":"schema_523"},{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"},{"name":"paid","in":"query","example":true,"schemaId":"schema_542"},{"name":"currencyCode","in":"query","example":"CZK","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202","404"],"pointer":"/api/proforma-invoices/snapshot","href":"proforma-invoices/getlistofallproformainvoices","openApiOperationId":"getListOfAllProformaInvoices","summary":"List of all proforma invoices","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}},"schemaId":"schema_574"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1snapshot/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1snapshot/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1proforma-invoices~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_574","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_574"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1snapshot/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1snapshot/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proforma-invoices/getlistofallproformainvoices"}],"panels":[]}]},"httpPath":"/api/proforma-invoices/snapshot"},{"label":"Proforma invoice detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/getproformainvoicedetail","routeSlug":"/shoptet-api/openapi/proforma-invoices/getproformainvoicedetail","metadata":{"seo":{"title":"Proforma invoice detail","description":"Additional information about one proforma invoice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProformaInvoiceDetail","name":"Proforma invoice detail","isWebhook":false,"pointer":"/paths/~1api~1proforma-invoices~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proforma invoice detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about one proforma invoice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item surcharge parameters"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000035"}],"pointer":"/paths/~1api~1proforma-invoices~1{code}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"surchargeParameters"}],"pointer":"/paths/~1api~1proforma-invoices~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proforma-invoices~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proforma-invoices/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000035","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","required":false,"example":"surchargeParameters","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/proforma-invoices/{code}","href":"proforma-invoices/getproformainvoicedetail","openApiOperationId":"getProformaInvoiceDetail","summary":"Proforma invoice detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_581"}},"schemaId":"schema_581"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1proforma-invoices~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_581","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_581"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proforma-invoices/getproformainvoicedetail"}],"panels":[]}]},"httpPath":"/api/proforma-invoices/{code}"},{"label":"Download proforma invoice as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/downloadproformainvoicepdf","routeSlug":"/shoptet-api/openapi/proforma-invoices/downloadproformainvoicepdf","metadata":{"seo":{"title":"Download proforma invoice as PDF","description":"You can request the proforma invoice as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadProformaInvoicePdf","name":"Download proforma invoice as PDF","isWebhook":false,"pointer":"/paths/~1api~1proforma-invoices~1{code}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download proforma invoice as PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the proforma invoice as PDF file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download pdf documents"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2018000035"}],"pointer":"/paths/~1api~1proforma-invoices~1{code}~1pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proforma-invoices~1{code}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proforma-invoices/{code}/pdf","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2018000035","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/api/proforma-invoices/{code}/pdf","href":"proforma-invoices/downloadproformainvoicepdf","openApiOperationId":"downloadProformaInvoicePdf","summary":"Download proforma invoice as PDF","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proforma-invoices/downloadproformainvoicepdf"}],"panels":[]}]},"httpPath":"/api/proforma-invoices/{code}/pdf"},{"label":"Last proforma invoice changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proforma-invoices/getlastproformainvoicechanges","routeSlug":"/shoptet-api/openapi/proforma-invoices/getlastproformainvoicechanges","metadata":{"seo":{"title":"Last proforma invoice changes","description":"Returns the list of proforma invoices, which were changed. The Endpoint is intended to determinethe changes after you have loaded the list of proforma invoices and you need to know the changes. The guaranteed history of changes is 30 days."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLastProformaInvoiceChanges","name":"Last proforma invoice changes","isWebhook":false,"pointer":"/paths/~1api~1proforma-invoices~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last proforma invoice changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of proforma invoices, which were changed. The Endpoint is intended to determine"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the changes after you have loaded the list of proforma invoices and you need to know the changes. The guaranteed history of changes is 30 days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each proforma invoice is only given in the listing with its last change. For example, if the proforma invoices was modified and then deleted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the listing will only show information about its deletion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be filtered by changeType = edit/delete parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation is considered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action. So, when there is a new item created, it will be displayed like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime from which up to the present we are interested in the changes. + in the time zone"},"children":[]}]}]}],"required":true,"example":"2018-01-01T01:01:01+02:00"},{"name":"changeType","in":"query","schemaId":"schema_523","description":"Returning only edit or delete type changed records","example":"edit"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1proforma-invoices~1changes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proforma-invoices~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proforma-invoices/changes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":true,"example":"2018-01-01T01:01:01+02:00","schemaId":"schema_523"},{"name":"changeType","in":"query","required":false,"example":"edit","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/proforma-invoices/changes","href":"proforma-invoices/getlastproformainvoicechanges","openApiOperationId":"getLastProformaInvoiceChanges","summary":"Last proforma invoice changes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_583","exampleIds":["paths/~1api~1proforma-invoices~1changes/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_583","exampleIds":["paths/~1api~1proforma-invoices~1changes/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1proforma-invoices~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_583","exampleIds":["paths/~1api~1proforma-invoices~1changes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_583","exampleIds":["paths/~1api~1proforma-invoices~1changes/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proforma-invoices/getlastproformainvoicechanges"}],"panels":[]}]},"httpPath":"/api/proforma-invoices/changes"}],"content":{"contentType":"group","meta":{"name":"Proforma invoices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proforma invoices","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing proforma invoices in the e-shop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is the proforma invoice identifier. Although this is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usually a number, it is necessary to take into account that this might"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"also include letters, a dash, etc."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api_orders_{code}_proforma-invoice.yaml","summary":"Proforma invoice from order creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proforma-invoices/createproformainvoicefromorder","deprecated":false},{"title":"/api/proforma-invoices","summary":"List of proforma invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proforma-invoices/getlistofproformainvoices","deprecated":false},{"title":"/api/proforma-invoices/snapshot","summary":"List of all proforma invoices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proforma-invoices/getlistofallproformainvoices","deprecated":false},{"title":"/api/proforma-invoices/{code}","summary":"Proforma invoice detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proforma-invoices/getproformainvoicedetail","deprecated":false},{"title":"/api/proforma-invoices/{code}/pdf","summary":"Download proforma invoice as PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proforma-invoices/downloadproformainvoicepdf","deprecated":false},{"title":"/api/proforma-invoices/changes","summary":"Last proforma invoice changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proforma-invoices/getlastproformainvoicechanges","deprecated":false}]}]}]}]}},{"type":"group","label":"Proof payments","link":"/shoptet-api/openapi/proof-payments","routeSlug":"/shoptet-api/openapi/proof-payments","items":[{"label":"List of proof payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getlistofproofpayments","routeSlug":"/shoptet-api/openapi/proof-payments/getlistofproofpayments","metadata":{"seo":{"title":"List of proof payments","description":"The list of proof payments supports Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProofPayments","name":"List of proof payments","isWebhook":false,"pointer":"/paths/~1api~1proof-payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of proof payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of proof payments supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"code","in":"query","schemaId":"schema_523","description":"filtering according to proof payments code. Optional.","example":"P--2015000170-1"},{"name":"orderCode","in":"query","schemaId":"schema_523","description":"filtering according to order code. Optional.","example":"2015000001"},{"name":"proformaInvoiceCode","in":"query","schemaId":"schema_523","description":"filtering according to proforma invoice code. Optional.","example":"2015000170"},{"name":"invoiceCode","in":"query","schemaId":"schema_523","description":"filtering by invoice code","example":"2017100013"},{"name":"issueDate","in":"query","schemaId":"schema_523","description":"filtering according to date on which was proof payment issued. In\nISO 8601 format. Optional.","example":"2024-12-24T15:22:02+0200"},{"name":"isValid","in":"query","schemaId":"schema_542","description":"filtering according to proof payments validity. Optional.","example":true},{"name":"closed","in":"query","schemaId":"schema_542","description":"filtering by proof payment closed/open","example":true},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 100.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1proof-payments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proof-payments","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"code","in":"query","required":false,"example":"P--2015000170-1","schemaId":"schema_523"},{"name":"orderCode","in":"query","required":false,"example":"2015000001","schemaId":"schema_523"},{"name":"proformaInvoiceCode","in":"query","required":false,"example":"2015000170","schemaId":"schema_523"},{"name":"invoiceCode","in":"query","required":false,"example":"2017100013","schemaId":"schema_523"},{"name":"issueDate","in":"query","required":false,"example":"2024-12-24T15:22:02+0200","schemaId":"schema_523"},{"name":"isValid","in":"query","required":false,"example":true,"schemaId":"schema_542"},{"name":"closed","in":"query","required":false,"example":true,"schemaId":"schema_542"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/proof-payments","href":"proof-payments/getlistofproofpayments","openApiOperationId":"getListOfProofPayments","summary":"List of proof payments","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_584"}},"schemaId":"schema_584"}],"pointer":"/paths/~1api~1proof-payments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_584","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_584"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/getlistofproofpayments"}],"panels":[]}]},"httpPath":"/api/proof-payments"},{"label":"Proof payment insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/createproofpayment","routeSlug":"/shoptet-api/openapi/proof-payments/createproofpayment","metadata":{"seo":{"title":"Proof payment insertion","description":"Proof payment insertion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProofPayment","name":"Proof payment insertion","isWebhook":false,"pointer":"/paths/~1api~1proof-payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_585"}},"schemaId":"schema_585","pointer":"/paths/~1api~1proof-payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proof-payments","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_585"}},"responseCodes":["201","404","422"],"pointer":"/api/proof-payments","href":"proof-payments/createproofpayment","openApiOperationId":"createProofPayment","summary":"Proof payment insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_585","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_585"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}},"schemaId":"schema_586"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/createproofpayment"}],"panels":[]}]},"httpPath":"/api/proof-payments"},{"label":"Proof payment detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getproofpaymentdetail","routeSlug":"/shoptet-api/openapi/proof-payments/getproofpaymentdetail","metadata":{"seo":{"title":"Proof payment detail","description":"Additional information about one proof payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProofPaymentDetail","name":"Proof payment detail","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Additional information about one proof payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"P--2015000170-1"}],"pointer":"/paths/~1api~1proof-payments~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proof-payments/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"P--2015000170-1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/proof-payments/{code}","href":"proof-payments/getproofpaymentdetail","openApiOperationId":"getProofPaymentDetail","summary":"Proof payment detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}},"schemaId":"schema_586"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/getproofpaymentdetail"}],"panels":[]}]},"httpPath":"/api/proof-payments/{code}"},{"label":"Proof payment update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/updateproofpayment","routeSlug":"/shoptet-api/openapi/proof-payments/updateproofpayment","metadata":{"seo":{"title":"Proof payment update","description":"If the proof payment is closed, response code 409 is returned and thedocument cannot be updated. Proof payment is closed if:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProofPayment","name":"Proof payment update","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1{code}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the proof payment is closed, response code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document cannot be updated. Proof payment is closed if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proof payment is/was linked to the invoice or"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there is a manual lock of proof payment."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"P--2015000170-1"}],"pointer":"/paths/~1api~1proof-payments~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_587"}},"schemaId":"schema_587","pointer":"/paths/~1api~1proof-payments~1{code}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/proof-payments/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"P--2015000170-1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_587"}},"responseCodes":["200","404","409"],"pointer":"/api/proof-payments/{code}","href":"proof-payments/updateproofpayment","openApiOperationId":"updateProofPayment","summary":"Proof payment update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_587","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_587"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}},"schemaId":"schema_586"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Document closed","paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Record already changed"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Document closed","paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Record already changed"]}],"pointer":"/paths/~1api~1proof-payments~1{code}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Document closed","paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Record already changed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Document closed","paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Record already changed"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/updateproofpayment"}],"panels":[]}]},"httpPath":"/api/proof-payments/{code}"},{"label":"Proof payment deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/deleteproofpayment","routeSlug":"/shoptet-api/openapi/proof-payments/deleteproofpayment","metadata":{"seo":{"title":"Proof payment deletion","description":"If the proof payment is closed, response code 409 is returned and thedocument cannot be deleted. Proof payment is closed if:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProofPayment","name":"Proof payment deletion","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the proof payment is closed, response code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document cannot be deleted. Proof payment is closed if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proof payment is/was linked to the invoice or"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there is a manual lock of proof payment."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"P--2015000170-1"}],"pointer":"/paths/~1api~1proof-payments~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/proof-payments/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"P--2015000170-1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/proof-payments/{code}","href":"proof-payments/deleteproofpayment","openApiOperationId":"deleteProofPayment","summary":"Proof payment deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/deleteproofpayment"}],"panels":[]}]},"httpPath":"/api/proof-payments/{code}"},{"label":"List of all proof payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getlistofallproofpayments","routeSlug":"/shoptet-api/openapi/proof-payments/getlistofallproofpayments","metadata":{"seo":{"title":"List of all proof payments","description":"Using this endpoint, you can get list of all proof payments with detailed info of each proof payment (like in Proof payment Detail endpoint)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllProofPayments","name":"List of all proof payments","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all proof payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all proof payments with detailed info of each proof payment (like in Proof payment Detail endpoint)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each proof payment taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One proof payment in response has the same format as proof payment detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/proofpaymentsnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof payment snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"Export proof payments created after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"Export proof payments created before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"Export proof payments updated after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":"Export proof payments updated before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"taxDateFrom","in":"query","schemaId":"schema_523","description":"Export proof payments with tax date after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"taxDateTo","in":"query","schemaId":"schema_523","description":"Export proof payments with tax date before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"isValid","in":"query","schemaId":"schema_542","description":"Filtering according to document validity","example":true},{"name":"currencyCode","in":"query","schemaId":"schema_523","description":"Proof payment currency","example":"CZK"},{"name":"closed","in":"query","schemaId":"schema_542","description":"Is the proof payment closed?","example":true}],"pointer":"/paths/~1api~1proof-payments~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proof-payments/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"taxDateFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"taxDateTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"isValid","in":"query","example":true,"schemaId":"schema_542"},{"name":"currencyCode","in":"query","example":"CZK","schemaId":"schema_523"},{"name":"closed","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/proof-payments/snapshot","href":"proof-payments/getlistofallproofpayments","openApiOperationId":"getListOfAllProofPayments","summary":"List of all proof payments","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1proof-payments~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/getlistofallproofpayments"}],"panels":[]}]},"httpPath":"/api/proof-payments/snapshot"},{"label":"Proof payment detail by order code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyordercode","routeSlug":"/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyordercode","metadata":{"seo":{"title":"Proof payment detail by order code","description":"Proof payment detail by order code"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProofPaymentDetailByOrderCode","name":"Proof payment detail by order code","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1order~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment detail by order code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2015000001"}],"pointer":"/paths/~1api~1proof-payments~1order~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1order~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proof-payments/order/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2015000001","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/proof-payments/order/{code}","href":"proof-payments/getproofpaymentdetailbyordercode","openApiOperationId":"getProofPaymentDetailByOrderCode","summary":"Proof payment detail by order code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}},"schemaId":"schema_588"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1order~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_588","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/getproofpaymentdetailbyordercode"}],"panels":[]}]},"httpPath":"/api/proof-payments/order/{code}"},{"label":"Proof payment insertion by order code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/createproofpaymentbyordercode","routeSlug":"/shoptet-api/openapi/proof-payments/createproofpaymentbyordercode","metadata":{"seo":{"title":"Proof payment insertion by order code","description":"Proof payment insertion by order code"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProofPaymentByOrderCode","name":"Proof payment insertion by order code","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1order~1{code}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment insertion by order code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2015000001"}],"pointer":"/paths/~1api~1proof-payments~1order~1{code}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1order~1{code}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proof-payments/order/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2015000001","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["201","404","422"],"pointer":"/api/proof-payments/order/{code}","href":"proof-payments/createproofpaymentbyordercode","openApiOperationId":"createProofPaymentByOrderCode","summary":"Proof payment insertion by order code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}},"schemaId":"schema_586"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1order~1{code}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1order~1{code}/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/createproofpaymentbyordercode"}],"panels":[]}]},"httpPath":"/api/proof-payments/order/{code}"},{"label":"Proof payment detail by proforma invoice code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyproformainvoicecode","routeSlug":"/shoptet-api/openapi/proof-payments/getproofpaymentdetailbyproformainvoicecode","metadata":{"seo":{"title":"Proof payment detail by proforma invoice code","description":"Proof payment detail by proforma invoice code"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProofPaymentDetailByProformaInvoiceCode","name":"Proof payment detail by proforma invoice code","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1proforma-invoice~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment detail by proforma invoice code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2015000170"}],"pointer":"/paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proof-payments/proforma-invoice/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2015000170","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/proof-payments/proforma-invoice/{code}","href":"proof-payments/getproofpaymentdetailbyproformainvoicecode","openApiOperationId":"getProofPaymentDetailByProformaInvoiceCode","summary":"Proof payment detail by proforma invoice code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}},"schemaId":"schema_588"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_588","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/getproofpaymentdetailbyproformainvoicecode"}],"panels":[]}]},"httpPath":"/api/proof-payments/proforma-invoice/{code}"},{"label":"Proof payment insertion by proforma invoice code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/createproofpaymentbyproformainvoicecode","routeSlug":"/shoptet-api/openapi/proof-payments/createproofpaymentbyproformainvoicecode","metadata":{"seo":{"title":"Proof payment insertion by proforma invoice code","description":"Proof payment insertion by proforma invoice code"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProofPaymentByProformaInvoiceCode","name":"Proof payment insertion by proforma invoice code","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1proforma-invoice~1{code}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment insertion by proforma invoice code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2015000170"}],"pointer":"/paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proof-payments/proforma-invoice/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2015000170","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["201","404","422"],"pointer":"/api/proof-payments/proforma-invoice/{code}","href":"proof-payments/createproofpaymentbyproformainvoicecode","openApiOperationId":"createProofPaymentByProformaInvoiceCode","summary":"Proof payment insertion by proforma invoice code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}},"schemaId":"schema_586"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/createproofpaymentbyproformainvoicecode"}],"panels":[]}]},"httpPath":"/api/proof-payments/proforma-invoice/{code}"},{"label":"Proof payment document settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/proofpaymentdocumentsettings","routeSlug":"/shoptet-api/openapi/proof-payments/proofpaymentdocumentsettings","metadata":{"seo":{"title":"Proof payment document settings","description":"Using this endpoint, you can unlink an invoice from a proof of payment. After successfully unlinking the invoice, the price of the linked"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"proofPaymentDocumentSettings","name":"Proof payment document settings","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1{code}~1document-settings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment document settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Using this endpoint, you can unlink an invoice from a proof of payment.\nAfter successfully unlinking the invoice, the price of the linked\n\ninvoice will be recalculated and increased by the price of the proof of\npayment.\n\nLinking of the invoice to the proof of payment is not possible at this\nendpoint.\n\n\nYou can also close a proof of payment with this endpoint. You can open a\nproof of payment if it is not linked to any invoice.\n\nOtherwise, a response code 409 is returned and the document cannot be\nclosed.\n\n\nImportant note: If the document is closed, the invoice or proof of\npayment may have already been sent to the customer!"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"P--2015000170-1"}],"pointer":"/paths/~1api~1proof-payments~1{code}~1document-settings/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1{code}~1document-settings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_589"}},"schemaId":"schema_589","pointer":"/paths/~1api~1proof-payments~1{code}~1document-settings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proof-payments/{code}/document-settings","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"P--2015000170-1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_589"}},"responseCodes":["201","404","409"],"pointer":"/api/proof-payments/{code}/document-settings","href":"proof-payments/proofpaymentdocumentsettings","openApiOperationId":"proofPaymentDocumentSettings","summary":"Proof payment document settings","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_589","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_589"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}},"schemaId":"schema_586"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1{code}~1document-settings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_586","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_586"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/proofpaymentdocumentsettings"}],"panels":[]}]},"httpPath":"/api/proof-payments/{code}/document-settings"},{"label":"Download proof of payment as PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/downloadproofofpaymentpdf","routeSlug":"/shoptet-api/openapi/proof-payments/downloadproofofpaymentpdf","metadata":{"seo":{"title":"Download proof of payment as PDF","description":"You can request the proof of payment as PDF file, response will be asapplication/octet-stream. You can download pdf documents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadProofOfPaymentPdf","name":"Download proof of payment as PDF","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1{code}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download proof of payment as PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the proof of payment as PDF file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download pdf documents"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"P-2014000004-01"}],"pointer":"/paths/~1api~1proof-payments~1{code}~1pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1{code}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proof-payments/{code}/pdf","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"P-2014000004-01","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/proof-payments/{code}/pdf","href":"proof-payments/downloadproofofpaymentpdf","openApiOperationId":"downloadProofOfPaymentPdf","summary":"Download proof of payment as PDF","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1pdf/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1pdf/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1{code}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1pdf/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1pdf/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/downloadproofofpaymentpdf"}],"panels":[]}]},"httpPath":"/api/proof-payments/{code}/pdf"},{"label":"Download proof payment as ISDOC","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/downloadproofpaymentasisdoc","routeSlug":"/shoptet-api/openapi/proof-payments/downloadproofpaymentasisdoc","metadata":{"seo":{"title":"Download proof payment as ISDOC","description":"You can request the proof payment as ISDOC file, response will be asapplication/octet-stream. You can download the documentsonly one-by-one for every e-shop. Parallel requests end with 423 Locked error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadProofPaymentAsIsdoc","name":"Download proof payment as ISDOC","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1{code}~1isdoc/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download proof payment as ISDOC","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request the proof payment as ISDOC file, response will be as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/octet-stream. You can download the documents"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only one-by-one for every e-shop. Parallel requests end with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423 Locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"P-2015000248-01"}],"pointer":"/paths/~1api~1proof-payments~1{code}~1isdoc/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1{code}~1isdoc/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proof-payments/{code}/isdoc","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"P-2015000248-01","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/api/proof-payments/{code}/isdoc","href":"proof-payments/downloadproofpaymentasisdoc","openApiOperationId":"downloadProofPaymentAsIsdoc","summary":"Download proof payment as ISDOC","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1{code}~1isdoc/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/downloadproofpaymentasisdoc"}],"panels":[]}]},"httpPath":"/api/proof-payments/{code}/isdoc"},{"label":"Last proof payments changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/getlastproofpaymentschanges","routeSlug":"/shoptet-api/openapi/proof-payments/getlastproofpaymentschanges","metadata":{"seo":{"title":"Last proof payments changes","description":"Returns the list of proof payments, which were changed. The Endpoint is intended to determinethe changes after you have loaded the list of proof payments and you need to know the changes. The guaranteed history of changes is 30 days."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLastProofPaymentsChanges","name":"Last proof payments changes","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last proof payments changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of proof payments, which were changed. The Endpoint is intended to determine"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the changes after you have loaded the list of proof payments and you need to know the changes. The guaranteed history of changes is 30 days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each proof payment is only given in the listing with its last change. For example, if the proof payment was modified and then deleted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the listing will only show information about its deletion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be filtered by changeType = edit/delete parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation is considered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action. So, when there is a new item created, it will be displayed like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime from which up to the present we are interested in the changes. + in the time zone"},"children":[]}]}]}],"required":true,"example":"2018-01-01T01:01:01+02:00"},{"name":"changeType","in":"query","schemaId":"schema_523","description":"Returning only edit or delete type changed records","example":"edit"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1proof-payments~1changes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/proof-payments/changes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":true,"example":"2018-01-01T01:01:01+02:00","schemaId":"schema_523"},{"name":"changeType","in":"query","required":false,"example":"edit","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/proof-payments/changes","href":"proof-payments/getlastproofpaymentschanges","openApiOperationId":"getLastProofPaymentsChanges","summary":"Last proof payments changes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590","exampleIds":["paths/~1api~1proof-payments~1changes/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_590","exampleIds":["paths/~1api~1proof-payments~1changes/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_590","exampleIds":["paths/~1api~1proof-payments~1changes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_590","exampleIds":["paths/~1api~1proof-payments~1changes/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/getlastproofpaymentschanges"}],"panels":[]}]},"httpPath":"/api/proof-payments/changes"},{"label":"Credit note from proof of payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/proof-payments/createcreditnotefromproofofpayment","routeSlug":"/shoptet-api/openapi/proof-payments/createcreditnotefromproofofpayment","metadata":{"seo":{"title":"Credit note from proof of payment","description":"Creating credit note from existing proof of payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCreditNoteFromProofOfPayment","name":"Credit note from proof of payment","isWebhook":false,"pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit note from proof of payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creating credit note from existing proof of payment.\n\nIt will create a credit note from the given proof of payment. It will\nautomatically take all proof of payment items and add them to the credit\nnote."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Proof of payment code","required":true,"example":"P-2014000004-01"}],"pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_564"}},"schemaId":"schema_564","pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proof-payments/{code}/credit-note","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"P-2014000004-01","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_564"}},"responseCodes":["201","404","409","422"],"pointer":"/api/proof-payments/{code}/credit-note","href":"proof-payments/createcreditnotefromproofofpayment","openApiOperationId":"createCreditNoteFromProofOfPayment","summary":"Credit note from proof of payment","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_564","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_564"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict with already created invoice","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1proof-payments~1{code}~1credit-note/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proof-payments/createcreditnotefromproofofpayment"}],"panels":[]}]},"httpPath":"/api/proof-payments/{code}/credit-note"}],"content":{"contentType":"group","meta":{"name":"Proof payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is the proof payments identifier. Although this is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usually a number, it is necessary to take into account that this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"might also include letters, a dash, etc."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/proof-payments","summary":"List of proof payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-payments/getlistofproofpayments","deprecated":false},{"title":"/api/proof-payments","summary":"Proof payment insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proof-payments/createproofpayment","deprecated":false},{"title":"/api/proof-payments/{code}","summary":"Proof payment detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-payments/getproofpaymentdetail","deprecated":false},{"title":"/api/proof-payments/{code}","summary":"Proof payment update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/proof-payments/updateproofpayment","deprecated":false},{"title":"/api/proof-payments/{code}","summary":"Proof payment deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/proof-payments/deleteproofpayment","deprecated":false},{"title":"/api/proof-payments/snapshot","summary":"List of all proof payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-payments/getlistofallproofpayments","deprecated":false},{"title":"/api/proof-payments/order/{code}","summary":"Proof payment detail by order code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-payments/getproofpaymentdetailbyordercode","deprecated":false},{"title":"/api/proof-payments/order/{code}","summary":"Proof payment insertion by order code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proof-payments/createproofpaymentbyordercode","deprecated":false},{"title":"/api/proof-payments/proforma-invoice/{code}","summary":"Proof payment detail by proforma invoice code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-payments/getproofpaymentdetailbyproformainvoicecode","deprecated":false},{"title":"/api/proof-payments/proforma-invoice/{code}","summary":"Proof payment insertion by proforma invoice code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proof-payments/createproofpaymentbyproformainvoicecode","deprecated":false},{"title":"/api/proof-payments/{code}/document-settings","summary":"Proof payment document settings","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proof-payments/proofpaymentdocumentsettings","deprecated":false},{"title":"/api/proof-payments/{code}/pdf","summary":"Download proof of payment as PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-payments/downloadproofofpaymentpdf","deprecated":false},{"title":"/api/proof-payments/{code}/isdoc","summary":"Download proof payment as ISDOC","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-payments/downloadproofpaymentasisdoc","deprecated":false},{"title":"/api/proof-payments/changes","summary":"Last proof payments changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/proof-payments/getlastproofpaymentschanges","deprecated":false},{"title":"/api/proof-payments/{code}/credit-note","summary":"Credit note from proof of payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proof-payments/createcreditnotefromproofofpayment","deprecated":false}]}]}]}]}},{"type":"separator","label":"Products","content":null},{"type":"group","label":"Alternative products","link":"/shoptet-api/openapi/alternative-products","routeSlug":"/shoptet-api/openapi/alternative-products","items":[{"label":"List of product alternative products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/alternative-products/getlistofproductalternativeproducts","routeSlug":"/shoptet-api/openapi/alternative-products/getlistofproductalternativeproducts","metadata":{"seo":{"title":"List of product alternative products","description":"Returns list of alternative products related to product defined byguid, list is ordered by priority parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductAlternativeProducts","name":"List of product alternative products","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of product alternative products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns list of alternative products related to product defined by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", list is ordered by priority parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pair reciprocally"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settings > Product > Related and Alternative products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is enabled, list of"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"items will be enriched by items that has called product in own"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative table."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"visible","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only visible products are returned (those, which does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visibility: hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/{guid}/alternativeProducts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[{"name":"visible","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/{guid}/alternativeProducts","href":"alternative-products/getlistofproductalternativeproducts","openApiOperationId":"getListOfProductAlternativeProducts","summary":"List of product alternative products","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591"}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alternative-products/getlistofproductalternativeproducts"}],"panels":[]}]},"httpPath":"/api/products/{guid}/alternativeProducts"},{"label":"Add alternative product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/alternative-products/addalternativeproduct","routeSlug":"/shoptet-api/openapi/alternative-products/addalternativeproduct","metadata":{"seo":{"title":"Add alternative product","description":"This method add given product, defined with guid at the end of thealternative product list. After product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addAlternativeProduct","name":"Add alternative product","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add alternative product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method add given product, defined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternative product list. After product"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is successfully saved, complete list of alternative product is returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_592"}},"schemaId":"schema_592","pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/{guid}/alternativeProducts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_592"}},"responseCodes":["200"],"pointer":"/api/products/{guid}/alternativeProducts","href":"alternative-products/addalternativeproduct","openApiOperationId":"addAlternativeProduct","summary":"Add alternative product","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_592","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_592"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591"}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alternative-products/addalternativeproduct"}],"panels":[]}]},"httpPath":"/api/products/{guid}/alternativeProducts"},{"label":"Set alternative products","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/alternative-products/setalternativeproducts","routeSlug":"/shoptet-api/openapi/alternative-products/setalternativeproducts","metadata":{"seo":{"title":"Set alternative products","description":"This method set given products (minimum 0, maximum 50), defined withguid to the alternative product list. After product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setAlternativeProducts","name":"Set alternative products","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set alternative products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method set given products (minimum 0, maximum 50), defined with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the alternative product list. After product"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is successfully saved, complete list of alternative product is returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_593"}},"schemaId":"schema_593","pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/products/{guid}/alternativeProducts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_593"}},"responseCodes":["200"],"pointer":"/api/products/{guid}/alternativeProducts","href":"alternative-products/setalternativeproducts","openApiOperationId":"setAlternativeProducts","summary":"Set alternative products","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_593","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_593"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591"}],"pointer":"/paths/~1api~1products~1{guid}~1alternativeProducts/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alternative-products/setalternativeproducts"}],"panels":[]}]},"httpPath":"/api/products/{guid}/alternativeProducts"}],"content":{"contentType":"group","meta":{"name":"Alternative products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alternative products","showPageActions":true},{"nodeType":"markdoc","content":"Managing alternative products."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/{guid}/alternativeProducts","summary":"List of product alternative products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alternative-products/getlistofproductalternativeproducts","deprecated":false},{"title":"/api/products/{guid}/alternativeProducts","summary":"Add alternative product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alternative-products/addalternativeproduct","deprecated":false},{"title":"/api/products/{guid}/alternativeProducts","summary":"Set alternative products","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alternative-products/setalternativeproducts","deprecated":false}]}]}]}]}},{"type":"group","label":"Brands","link":"/shoptet-api/openapi/brands","routeSlug":"/shoptet-api/openapi/brands","items":[{"label":"List of brands","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/getlistofbrands","routeSlug":"/shoptet-api/openapi/brands/getlistofbrands","metadata":{"seo":{"title":"List of brands","description":"Returns the list of brands. Supports the Paging"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListofBrands","name":"List of brands","isWebhook":false,"pointer":"/paths/~1api~1brands/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of brands","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of brands. Supports the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 500. Max value is 1000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1brands/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1brands/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/brands","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/brands","href":"brands/getlistofbrands","openApiOperationId":"getListofBrands","summary":"List of brands","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594"}],"pointer":"/paths/~1api~1brands/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_594"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brands/getlistofbrands"}],"panels":[]}]},"httpPath":"/api/brands"},{"label":"Creation of brand","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/createbrand","routeSlug":"/shoptet-api/openapi/brands/createbrand","metadata":{"seo":{"title":"Creation of brand","description":"Creation of brand"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBrand","name":"Creation of brand","isWebhook":false,"pointer":"/paths/~1api~1brands/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of brand","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1brands/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_595"}},"schemaId":"schema_595","pointer":"/paths/~1api~1brands/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/brands","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_595"}},"responseCodes":["201"],"pointer":"/api/brands","href":"brands/createbrand","openApiOperationId":"createBrand","summary":"Creation of brand","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_595","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_595"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}},"schemaId":"schema_596"}],"pointer":"/paths/~1api~1brands/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_596","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brands/createbrand"}],"panels":[]}]},"httpPath":"/api/brands"},{"label":"Detail of brand","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/getdetailofbrand","routeSlug":"/shoptet-api/openapi/brands/getdetailofbrand","metadata":{"seo":{"title":"Detail of brand","description":"Detail of brand"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfBrand","name":"Detail of brand","isWebhook":false,"pointer":"/paths/~1api~1brands~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of brand","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"brand GUID","required":true,"example":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"pointer":"/paths/~1api~1brands~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1brands~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/brands/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/brands/{code}","href":"brands/getdetailofbrand","openApiOperationId":"getDetailOfBrand","summary":"Detail of brand","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}},"schemaId":"schema_596"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1brands~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_596","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brands/getdetailofbrand"}],"panels":[]}]},"httpPath":"/api/brands/{code}"},{"label":"Update of brand","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/updatebrand","routeSlug":"/shoptet-api/openapi/brands/updatebrand","metadata":{"seo":{"title":"Update of brand","description":"Update of brand"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBrand","name":"Update of brand","isWebhook":false,"pointer":"/paths/~1api~1brands~1{code}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of brand","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"brand GUID","required":true,"example":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"pointer":"/paths/~1api~1brands~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1brands~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_597"}},"schemaId":"schema_597","pointer":"/paths/~1api~1brands~1{code}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/brands/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_597"}},"responseCodes":["200","404"],"pointer":"/api/brands/{code}","href":"brands/updatebrand","openApiOperationId":"updateBrand","summary":"Update of brand","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_597","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_597"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}},"schemaId":"schema_596"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1brands~1{code}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_596","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brands/updatebrand"}],"panels":[]}]},"httpPath":"/api/brands/{code}"},{"label":"Deletion of brand","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/deletebrand","routeSlug":"/shoptet-api/openapi/brands/deletebrand","metadata":{"seo":{"title":"Deletion of brand","description":"If the brand cannot be deleted, because it is used by some product, a409 code is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBrand","name":"Deletion of brand","isWebhook":false,"pointer":"/paths/~1api~1brands~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of brand","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the brand cannot be deleted, because it is used by some product, a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 code is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleteUsed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value allows deletion of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand used by products."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"brand GUID","required":true,"example":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"pointer":"/paths/~1api~1brands~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deleteUsed","in":"query","schemaId":"schema_529","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allows deletion of brand used by products if set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1api~1brands~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1brands~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/brands/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005","schemaId":"schema_523"}],"query":[{"name":"deleteUsed","in":"query","required":false,"example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/brands/{code}","href":"brands/deletebrand","openApiOperationId":"deleteBrand","summary":"Deletion of brand","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1brands~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1{code}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brands/deletebrand"}],"panels":[]}]},"httpPath":"/api/brands/{code}"},{"label":"BATCH creation of brands","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/brands/createbrandbatch","routeSlug":"/shoptet-api/openapi/brands/createbrandbatch","metadata":{"seo":{"title":"BATCH creation of brands","description":"This endpoint allows you to create multiple brands at once. Batchcreation is processed asynchronously in same way as for example productssnapshot, but it does not have resultUrl in response. Instead, you can checkattribute log which contains successfully created brands and errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBrandBatch","name":"BATCH creation of brands","isWebhook":false,"pointer":"/paths/~1api~1brands~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BATCH creation of brands","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to create multiple brands at once. Batch"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation is processed asynchronously in same way as for example products"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snapshot, but it does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in response. Instead, you can check"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"log"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains successfully created brands and errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File with data for update must be in JSONL ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") format. Each line must contain one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand in JSON format. Maximum size of file is 100MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structure of JSON row is same as structure of JSON for single brand"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creation above. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/batch/brandbatchcreate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand batch create schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous job process jsonl file row by row and try to validate and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"save data. If there is any error, row is skipped and error is logged,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but it does not stop processing of other rows. In Log, every product is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identified by its position in file (starting from 1)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1brands~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","pointer":"/paths/~1api~1brands~1batch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/brands/batch","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_544"}},"responseCodes":["202","404","409"],"pointer":"/api/brands/batch","href":"brands/createbrandbatch","openApiOperationId":"createBrandBatch","summary":"BATCH creation of brands","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1brands~1batch/post/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1brands~1batch/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1batch/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1batch/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1brands~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"404","exampleIds":["paths/~1api~1brands~1batch/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1brands~1batch/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1batch/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1brands~1batch/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brands/createbrandbatch"}],"panels":[]}]},"httpPath":"/api/brands/batch"}],"content":{"contentType":"group","meta":{"name":"Brands"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brands","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing brands in the e-shop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"indexName"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead. Parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts both:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guid string style, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"d467bfbe-4334-11ef-ad70-0242ac1f0005"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and index"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name string style, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"willy-wonka"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The index name string style is deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - use guid style."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/brands","summary":"List of brands","prefix":{"name":"get","color":"get"},"badges":[],"link":"/brands/getlistofbrands","deprecated":false},{"title":"/api/brands","summary":"Creation of brand","prefix":{"name":"post","color":"post"},"badges":[],"link":"/brands/createbrand","deprecated":false},{"title":"/api/brands/{code}","summary":"Detail of brand","prefix":{"name":"get","color":"get"},"badges":[],"link":"/brands/getdetailofbrand","deprecated":false},{"title":"/api/brands/{code}","summary":"Update of brand","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/brands/updatebrand","deprecated":false},{"title":"/api/brands/{code}","summary":"Deletion of brand","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/brands/deletebrand","deprecated":false},{"title":"/api/brands/batch","summary":"BATCH creation of brands","prefix":{"name":"post","color":"post"},"badges":[],"link":"/brands/createbrandbatch","deprecated":false}]}]}]}]}},{"type":"group","label":"Price lists","link":"/shoptet-api/openapi/price-lists","routeSlug":"/shoptet-api/openapi/price-lists","items":[{"label":"List of price lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/getlistofpricelists","routeSlug":"/shoptet-api/openapi/price-lists/getlistofpricelists","metadata":{"seo":{"title":"List of price lists","description":"Listing of all price lists set up in e-shop. Does not contain the paging, always lists all price lists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfPriceLists","name":"List of price lists","isWebhook":false,"pointer":"/paths/~1api~1pricelists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of price lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Listing of all price lists set up in e-shop. Does not contain the\npaging, always lists all price lists."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pricelists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pricelists","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/pricelists","href":"price-lists/getlistofpricelists","openApiOperationId":"getListOfPriceLists","summary":"List of price lists","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}},"schemaId":"schema_598"}],"pointer":"/paths/~1api~1pricelists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_598","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_598"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-lists/getlistofpricelists"}],"panels":[]}]},"httpPath":"/api/pricelists"},{"label":"Pricelist insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/createpricelist","routeSlug":"/shoptet-api/openapi/price-lists/createpricelist","metadata":{"seo":{"title":"Pricelist insertion","description":"Pricelist insertion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPricelist","name":"Pricelist insertion","isWebhook":false,"pointer":"/paths/~1api~1pricelists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pricelist insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pricelists/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_599"}},"schemaId":"schema_599","pointer":"/paths/~1api~1pricelists/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/pricelists","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_599"}},"responseCodes":["201"],"pointer":"/api/pricelists","href":"price-lists/createpricelist","openApiOperationId":"createPricelist","summary":"Pricelist insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_599","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_599"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_600"}},"schemaId":"schema_600"}],"pointer":"/paths/~1api~1pricelists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_600","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_600"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-lists/createpricelist"}],"panels":[]}]},"httpPath":"/api/pricelists"},{"label":"Pricelist detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/getpricelistdetail","routeSlug":"/shoptet-api/openapi/price-lists/getpricelistdetail","metadata":{"seo":{"title":"Pricelist detail","description":"Price list detail with product prices (variants) and info on discounts and limitations of purchase (minimum and maximum price)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPricelistDetail","name":"Pricelist detail","isWebhook":false,"pointer":"/paths/~1api~1pricelists~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pricelist detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Price list detail with product prices (variants) and info on discounts and limitations of purchase (minimum and maximum price)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"Price list ID","required":true,"example":1}],"pointer":"/paths/~1api~1pricelists~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"code","in":"query","schemaId":"schema_523","description":"Product variant code","example":"106/BIL"},{"name":"guid","in":"query","schemaId":"schema_523","description":"Product GUID","example":"94fe7ffc-7481-11e8-8216-002590dad85e"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 100.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1pricelists~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pricelists~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pricelists/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[{"name":"code","in":"query","example":"106/BIL","schemaId":"schema_523"},{"name":"guid","in":"query","example":"94fe7ffc-7481-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/pricelists/{id}","href":"price-lists/getpricelistdetail","openApiOperationId":"getPricelistDetail","summary":"Pricelist detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}},"schemaId":"schema_601"}],"pointer":"/paths/~1api~1pricelists~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_601","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_601"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-lists/getpricelistdetail"}],"panels":[]}]},"httpPath":"/api/pricelists/{id}"},{"label":"Update pricelist","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/updatepricelist","routeSlug":"/shoptet-api/openapi/price-lists/updatepricelist","metadata":{"seo":{"title":"Update pricelist","description":"This endpoint allows updating price fields and other attributes from apricelist of a product (variant)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePricelist","name":"Update pricelist","isWebhook":false,"pointer":"/paths/~1api~1pricelists~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update pricelist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows updating price fields and other attributes from a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricelist of a product (variant)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request multiple updates at once; the maximum is 300 updates per"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request must contain a product variant code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and at least one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderableAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send only fields you want to change, the others will stay untouched. Be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"aware of the difference between"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not providing a field: the field will not be changed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"providing e. g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.price.buyPrice: null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remove the price"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case the request will be properly formatted, but an error occurs for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of the records, the correct records"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be updated, the response will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and there will be records"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for each failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"record. If all records are incorrect, the response code will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 BAD REQUEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vatRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, current data for product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(or variant) will be recalculated. (even through untouched by your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly sets price of product, without recalculating."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets price of product, respecting it is price"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" VAT and thus recalculating if needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets price of product, respecting it is price"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" VAT and thus recalculating if needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note, that you can change "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for default price list! For"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"others price lists, value stays "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-vat payer e-shops, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vatRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"forbidden to use and fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithoutVat"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all works the same."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to change the currency of the prices, you will need to have the Currencies module (Cizí měny) activated on the customer's e-shop."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that if you change the currency code of the price list, all prices will not be recalculated to the new currency; only the currency code will be changed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_523","description":"Pricelist id","required":true,"example":"1"}],"pointer":"/paths/~1api~1pricelists~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pricelists~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_602"}},"schemaId":"schema_602","pointer":"/paths/~1api~1pricelists~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/pricelists/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_602"}},"responseCodes":["200","400","404"],"pointer":"/api/pricelists/{id}","href":"price-lists/updatepricelist","openApiOperationId":"updatePricelist","summary":"Update pricelist","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_602","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_602"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/buy-price-and-purchase-price","paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate","paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate-purchase-price"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/buy-price-and-purchase-price","paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate","paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate-purchase-price"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1pricelists~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/buy-price-and-purchase-price","paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate","paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate-purchase-price"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/buy-price-and-purchase-price","paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate","paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate-purchase-price"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-lists/updatepricelist"}],"panels":[]}]},"httpPath":"/api/pricelists/{id}"},{"label":"Pricelist delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/deletepricelist","routeSlug":"/shoptet-api/openapi/price-lists/deletepricelist","metadata":{"seo":{"title":"Pricelist delete","description":"Deletion of pricelist can fail with error 423 in case of runningimport."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePricelist","name":"Pricelist delete","isWebhook":false,"pointer":"/paths/~1api~1pricelists~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pricelist delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion of pricelist can fail with error "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"423"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in case of running"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"import."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_523","description":"pricelist ID (number)","required":true,"example":"1"}],"pointer":"/paths/~1api~1pricelists~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pricelists~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/pricelists/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","422","423"],"pointer":"/api/pricelists/{id}","href":"price-lists/deletepricelist","openApiOperationId":"deletePricelist","summary":"Pricelist delete","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/delete/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/delete/responses/422/content/application~1json/example"]},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/delete/responses/423/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/delete/responses/423/content/application~1json/example"]}],"pointer":"/paths/~1api~1pricelists~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/delete/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/delete/responses/422/content/application~1json/example"]}}},{"code":"423","schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/delete/responses/423/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pricelists~1{id}/delete/responses/423/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-lists/deletepricelist"}],"panels":[]}]},"httpPath":"/api/pricelists/{id}"},{"label":"List of all price list details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/getlistofallpricelistdetails","routeSlug":"/shoptet-api/openapi/price-lists/getlistofallpricelistdetails","metadata":{"seo":{"title":"List of all price list details","description":"Using this endpoint, you can get list of all price list details with information on each price (like in Price list Detail endpoint) asynchronously. See how Asynchronous requests work on our developer’s portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllPricelistDetails","name":"List of all price list details","isWebhook":false,"pointer":"/paths/~1api~1pricelists~1{id}~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all price list details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all price list details with information on each price (like in Price list Detail endpoint) asynchronously. See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer’s portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each price list taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One price list in response has the same format as price list detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/pricelistsnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price list snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"Price list ID","required":true,"example":1}],"pointer":"/paths/~1api~1pricelists~1{id}~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"Export price list items with code after given value","example":"0000000006"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"Export price list items with code before given value","example":"0000000006"},{"name":"actionPriceDateFrom","in":"query","schemaId":"schema_523","description":"Export price list items with active action price date after date","example":"2019-09-05"},{"name":"actionPriceDateTo","in":"query","schemaId":"schema_523","description":"Export price list items with active action price before date","example":"2019-09-05"},{"name":"vatRate","in":"query","schemaId":"schema_523","description":"Export price list items with given vat rate","example":"21.0"},{"name":"currencyCode","in":"query","schemaId":"schema_523","description":"Export price list items with given currency code","example":"CZK"},{"name":"orderableMinAmount","in":"query","schemaId":"schema_603","description":"Export price list items with orderable minimal amount","example":10},{"name":"orderableMinAmountFrom","in":"query","schemaId":"schema_603","description":"Export price list items with orderable minimal amount amount after\ngiven value","example":10},{"name":"orderableMinAmountTo","in":"query","schemaId":"schema_603","description":"Export price list items with orderable minimal amount before given\nvalue","example":100},{"name":"orderableMaxAmount","in":"query","schemaId":"schema_603","description":"Export price list items with orderable maximal amount","example":20},{"name":"orderableMaxAmountFrom","in":"query","schemaId":"schema_603","description":"Export price list items with orderable maximal amount after given\nvalue","example":20},{"name":"orderableMaxAmountTo","in":"query","schemaId":"schema_603","description":"Export price list items with orderable maximal amount before given\nvalue","example":200}],"pointer":"/paths/~1api~1pricelists~1{id}~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pricelists~1{id}~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pricelists/{id}/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[{"name":"codeFrom","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"actionPriceDateFrom","in":"query","example":"2019-09-05","schemaId":"schema_523"},{"name":"actionPriceDateTo","in":"query","example":"2019-09-05","schemaId":"schema_523"},{"name":"vatRate","in":"query","example":"21.0","schemaId":"schema_523"},{"name":"currencyCode","in":"query","example":"CZK","schemaId":"schema_523"},{"name":"orderableMinAmount","in":"query","example":10,"schemaId":"schema_603"},{"name":"orderableMinAmountFrom","in":"query","example":10,"schemaId":"schema_603"},{"name":"orderableMinAmountTo","in":"query","example":100,"schemaId":"schema_603"},{"name":"orderableMaxAmount","in":"query","example":20,"schemaId":"schema_603"},{"name":"orderableMaxAmountFrom","in":"query","example":20,"schemaId":"schema_603"},{"name":"orderableMaxAmountTo","in":"query","example":200,"schemaId":"schema_603"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/pricelists/{id}/snapshot","href":"price-lists/getlistofallpricelistdetails","openApiOperationId":"getListOfAllPricelistDetails","summary":"List of all price list details","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1pricelists~1{id}~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-lists/getlistofallpricelistdetails"}],"panels":[]}]},"httpPath":"/api/pricelists/{id}/snapshot"},{"label":"Batch pricelist update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/price-lists/updatepricelistbatch","routeSlug":"/shoptet-api/openapi/price-lists/updatepricelistbatch","metadata":{"seo":{"title":"Batch pricelist update","description":"This endpoint allows updating multiple prices at once. Price fields and other attributes from a pricelist of a product (variant) can be updated. Batch update is processed asynchronously in same way as for example products snapshot, but it does not have resultUrl with prices to download in response. Instead, you can check attribute log which contains successfully updated prices and errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePricelistBatch","name":"Batch pricelist update","isWebhook":false,"pointer":"/paths/~1api~1pricelists~1{id}~1batch/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch pricelist update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows updating multiple prices at once. Price fields and other attributes from a pricelist of a product (variant) can be updated. Batch update is processed asynchronously in same way as for example products snapshot, but it does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with prices to download in response. Instead, you can check attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"log"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains successfully updated prices and errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File with data for update must be in JSONL ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") format. Each line must contain one pricelist price in JSON format. Maximum size of file is 100MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structure of JSON row is same as structure of JSON for single pricelist update. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.docs.shoptet.com/shoptet-api/openapi/price-lists/updatepricelist"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricelist update schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous job process jsonl file row by row and try to validate and save data. If there is any error, row is skipped and error is logged, but it does not stop processing of other rows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Log, every product is identified by its position in file (starting from 1)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request must contain a product variant code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and at least one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderableAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects. Send only fields you want to change, the others will stay untouched. Be aware of the difference between"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not providing a field: the field will not be changed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"providing e. g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.price.buyPrice: null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remove the price"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vatRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, current data for product (or variant) will be recalculated. (even through untouched by your request)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly sets price of product, without recalculating."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets price of product, respecting it is price "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" VAT and thus recalculating if needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets price of product, respecting it is price "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" VAT and thus recalculating if needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note, that you can change "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for default price list! For others price lists, value stays "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-vat payer e-shops, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vatRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are forbidden to use and fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all works the same."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to change the currency of the prices, you will need to have the Currencies module activated on the customer's e-shop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that if you change the currency code of the price list, all prices will not be recalculated to the new currency; only the currency code will be changed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"Pricelist id","required":true,"example":"1"}],"pointer":"/paths/~1api~1pricelists~1{id}~1batch/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pricelists~1{id}~1batch/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","pointer":"/paths/~1api~1pricelists~1{id}~1batch/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/pricelists/{id}/batch","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"1","schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_544"}},"responseCodes":["202","404","409"],"pointer":"/api/pricelists/{id}/batch","href":"price-lists/updatepricelistbatch","openApiOperationId":"updatePricelistBatch","summary":"Batch pricelist update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_604"}},"schemaId":"schema_604"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1pricelists~1{id}~1batch/patch/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1pricelists~1{id}~1batch/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1pricelists~1{id}~1batch/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1pricelists~1{id}~1batch/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1pricelists~1{id}~1batch/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_604","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_604"}}},{"code":"404","exampleIds":["paths/~1api~1pricelists~1{id}~1batch/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1pricelists~1{id}~1batch/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_568","exampleIds":["paths/~1api~1pricelists~1{id}~1batch/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1pricelists~1{id}~1batch/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/price-lists/updatepricelistbatch"}],"panels":[]}]},"httpPath":"/api/pricelists/{id}/batch"}],"content":{"contentType":"group","meta":{"name":"Price lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Price lists","showPageActions":true},{"nodeType":"markdoc","content":"Price lists are used for setting up different prices for products for\ndifferent customer groups."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/pricelists","summary":"List of price lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/price-lists/getlistofpricelists","deprecated":false},{"title":"/api/pricelists","summary":"Pricelist insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/price-lists/createpricelist","deprecated":false},{"title":"/api/pricelists/{id}","summary":"Pricelist detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/price-lists/getpricelistdetail","deprecated":false},{"title":"/api/pricelists/{id}","summary":"Update pricelist","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/price-lists/updatepricelist","deprecated":false},{"title":"/api/pricelists/{id}","summary":"Pricelist delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/price-lists/deletepricelist","deprecated":false},{"title":"/api/pricelists/{id}/snapshot","summary":"List of all price list details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/price-lists/getlistofallpricelistdetails","deprecated":false},{"title":"/api/pricelists/{id}/batch","summary":"Batch pricelist update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/price-lists/updatepricelistbatch","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/shoptet-api/openapi/products","routeSlug":"/shoptet-api/openapi/products","items":[{"label":"List of products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getlistofproducts","routeSlug":"/shoptet-api/openapi/products/getlistofproducts","metadata":{"seo":{"title":"List of products","description":"Returns the list of products - only basic info and GUID, using this you can determine the detailswith another API call. Endpoint supports Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProducts","name":"List of products","isWebhook":false,"pointer":"/paths/~1api~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of products - only basic info and GUID, using this you can determine the details"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with another API call. Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are sent only when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you state the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter within the URL, then information about main product image will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"also be part of the response. For more information about the chapter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Product-images"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product images"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note it is better to use List of all products endpoint for getting all products from eshop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request parameter to get the list of specific products. Product codes/GUIDs are separated by a comma. If you use this query parameter, other filters are not applied, and the set of particular products is returned. Please note that these parameters "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepts max. 50 product codes/GUIDs in request parameter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and cannot be combined."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"availabilityId","in":"query","schemaId":"schema_522","description":"product availability id. Optional.","example":1},{"name":"availabilityWhenSoldOutId","in":"query","schemaId":"schema_522","description":"product availability id when not stocked. Optional.","example":-2},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"date of product creation, lower limit. Optional.","example":"2017-02-28T17:04:47+0100"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"date of product creation, upper limit. Optional.","example":"2028-02-28T17:04:47+0100"},{"name":"visibility","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility (visible, hidden, only for logged-in users...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Optional."},"children":[]}]}]}],"example":"visible"},{"name":"type","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product type (product, service, bazar...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Optional."},"children":[]}]}]}],"example":"product"},{"name":"brandName","in":"query","schemaId":"schema_523","description":"product brand (manufacturer) name. Optional.","example":"Storm"},{"name":"brandCode","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product brand (manufacturer) code from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/brands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional."},"children":[]}]}]}],"example":"storm"},{"name":"defaultCategoryGuid","in":"query","schemaId":"schema_523","description":"product default category. Optional.","example":"5c499a23-70ac-11e9-9208-08002774f818"},{"name":"categoryGuid","in":"query","schemaId":"schema_523","description":"product category - only the products added to specific category will\nbe included. Optional.","example":"5c499a23-70ac-11e9-9208-08002774f818"},{"name":"flag","in":"query","schemaId":"schema_523","description":"product flag - only products with selected flag will be included","example":"action"},{"name":"include","in":"query","schemaId":"schema_523","description":"optional parts of response","example":"images"},{"name":"productCodes","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define the output set of products. Use max. 50 product codes separated by a comma. No additional filters take"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effect. Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"example":"15/ZLU,15/ZEL,27/XL,33/FIA,DS53437473,428"},{"name":"productGuids","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define the output set of products. Use max. 50 product GUIDs separated by a comma. No additional filters take"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effect. Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"example":"356eb81e-d966-11e0-b04f-57a43310b768,519d8f84-1609-11f0-bcf6-06999863e34a,519d8f84-1609-11f0-bcf6-06999863e34a"},{"name":"supplierGuid","in":"query","schemaId":"schema_523","description":"supplier GUID - only products with selected supplier will be\nincluded","example":"16a67ec6-d957-11e0-b04f-57a43310b768"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"date of product last update, lower limit. Optional.","example":"2017-02-28T17:04:47+0100"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":"date of product last update, upper limit. Optional.","example":"2028-02-28T17:04:47+0100"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 1000.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1products/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"availabilityId","in":"query","example":1,"schemaId":"schema_522"},{"name":"availabilityWhenSoldOutId","in":"query","example":-2,"schemaId":"schema_522"},{"name":"creationTimeFrom","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2028-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"visibility","in":"query","example":"visible","schemaId":"schema_523"},{"name":"type","in":"query","example":"product","schemaId":"schema_523"},{"name":"brandName","in":"query","example":"Storm","schemaId":"schema_523"},{"name":"brandCode","in":"query","example":"storm","schemaId":"schema_523"},{"name":"defaultCategoryGuid","in":"query","example":"5c499a23-70ac-11e9-9208-08002774f818","schemaId":"schema_523"},{"name":"categoryGuid","in":"query","example":"5c499a23-70ac-11e9-9208-08002774f818","schemaId":"schema_523"},{"name":"flag","in":"query","example":"action","schemaId":"schema_523"},{"name":"include","in":"query","example":"images","schemaId":"schema_523"},{"name":"productCodes","in":"query","example":"15/ZLU,15/ZEL,27/XL,33/FIA,DS53437473,428","schemaId":"schema_523"},{"name":"productGuids","in":"query","example":"356eb81e-d966-11e0-b04f-57a43310b768,519d8f84-1609-11f0-bcf6-06999863e34a,519d8f84-1609-11f0-bcf6-06999863e34a","schemaId":"schema_523"},{"name":"supplierGuid","in":"query","example":"16a67ec6-d957-11e0-b04f-57a43310b768","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2028-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/products","href":"products/getlistofproducts","openApiOperationId":"getListOfProducts","summary":"List of products","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_605"}},"schemaId":"schema_605"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_605","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_605"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1products/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getlistofproducts"}],"panels":[]}]},"httpPath":"/api/products"},{"label":"Product insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/createproduct","routeSlug":"/shoptet-api/openapi/products/createproduct","metadata":{"seo":{"title":"Product insertion","description":"This endpoint allows you to insert products into Shoptet. You can use itfor an import from an external system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProduct","name":"Product insertion","isWebhook":false,"pointer":"/paths/~1api~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to insert products into Shoptet. You can use it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for an import from an external system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request is sent in JSON format in its body. For detailed description of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"items, which can be provided, see the right-most pane, section"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Request\" » \"Attributes\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a product without variants, add one variant to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"variants"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array — it will be created as a single-variant product with the values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified in that variant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a product with multiple variants, each variant must have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a unique combination of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. color:black + size:XXL vs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"color:yellow + size:XXL). Two variants with identical parameter combinations"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are not allowed. Also, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nameIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be unique within a single variant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. two "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters in one variant is not allowed)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of variants per product is 512."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,warranty,sortVariants,relatedVideos,perPricelistPrices"}],"pointer":"/paths/~1api~1products/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_606"}},"schemaId":"schema_606","pointer":"/paths/~1api~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,warranty,sortVariants,relatedVideos,perPricelistPrices","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_606"}},"responseCodes":["201","403","422"],"pointer":"/api/products","href":"products/createproduct","openApiOperationId":"createProduct","summary":"Product insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_606","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_606"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_607"}},"schemaId":"schema_607"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products/post/responses/403/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_607","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_607"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products/post/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1products/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/createproduct"}],"panels":[]}]},"httpPath":"/api/products"},{"label":"Product copy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/productcopy","routeSlug":"/shoptet-api/openapi/products/productcopy","metadata":{"seo":{"title":"Product copy","description":"This endpoint allows you to copy a product identified by a GUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"productCopy","name":"Product copy","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product copy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to copy a product identified by a GUID.\n\nThe new product will have the same attributes as the original product. Many settings can be copied from the original product,but some settings require an active module. See the details below.\n\nBy default, all parameters are copied and set to true unless specified otherwise. If you only want to copy certain parameters, select those you want to copy and set the others to false. If you wish to copy all parameters, you don't need to include them in the request list at all.\n\nImportant note: If you previously had any active modules (such as Heureka, Seznam, GlobalSaleVat) that are no longer active, the resulting data may differ slightly because data requiring an active module will not be copied in this case."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1copy/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_608"}},"schemaId":"schema_608","pointer":"/paths/~1api~1products~1{guid}~1copy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/{guid}/copy","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_608"}},"responseCodes":["201","403","404","422"],"pointer":"/api/products/{guid}/copy","href":"products/productcopy","openApiOperationId":"productCopy","summary":"Product copy","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_608","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_608"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}},"schemaId":"schema_609"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1{guid}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_609","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1copy/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productcopy"}],"panels":[]}]},"httpPath":"/api/products/{guid}/copy"},{"label":"List of all products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getlistofallproducts","routeSlug":"/shoptet-api/openapi/products/getlistofallproducts","metadata":{"seo":{"title":"List of all products","description":"Using this endpoint, you can get list of all products with detailed info of each product (like in Product Detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllProducts","name":"List of all products","isWebhook":false,"pointer":"/paths/~1api~1products~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all products with detailed info of each product (like in Product Detail endpoint) asynchronously. See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each product taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One product in response has the same format as product detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/productsnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are exported only when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain the list of all product images. For more information about the chapter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#product-images"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product images"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variantParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain a field of variant parameters and a variant description, as they are visible to customers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allCategories"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain information on all the categories that the product was assigned into"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flags"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details on product designation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descriptiveParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain descriptive parameters of the product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"measureUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain measure unit info of every variant."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain surcharge parameters of the product."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setItems"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain items, products, in set."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain filtering parameters of the product."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recyclingFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain recycling fee."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consumptionTax"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain consumption tax. Requires the \"Consumption tax\" module to be enabled on the current e-shop."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warranty"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export will also contain product warranty."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sortVariants"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product variants will be sorted as in administration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gifts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of gifts (variants) related to product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternativeProducts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain alternative products."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relatedProducts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain related products."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relatedVideos"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain related videos."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relatedFiles"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain related files."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"perStockAmounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain amounts/claims per individual stocks. Requires the \"stock\" module to be enabled on the current e-shop."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"perPricelistPrices"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain prices per individual price lists."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request parameter to get the list of specific products. Product codes/GUIDs are separated by a comma. If you use this query parameter, other filters are not applied, and the set of particular products is returned. Please note that these parameters "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepts max. 50 product codes/GUIDs in request parameter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and cannot be combined."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,warranty,sortVariants,gifts,alternativeProducts,relatedProducts,relatedVideos,relatedFiles,perStockAmounts,perPricelistPrices"},{"name":"productCodes","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define the output set of products. Use max. 50 product codes separated by a comma. No additional filters take"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effect. Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"example":"15/ZLU,15/ZEL,27/XL,33/FIA,DS53437473,428"},{"name":"productGuids","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define the output set of products. Use max. 50 product GUIDs separated by a comma. No additional filters take"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effect. Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"example":"356eb81e-d966-11e0-b04f-57a43310b768,519d8f84-1609-11f0-bcf6-06999863e34a,519d8f84-1609-11f0-bcf6-06999863e34a"},{"name":"availabilityId","in":"query","schemaId":"schema_522","description":"product availability id. Optional.","example":1},{"name":"availabilityWhenSoldOutId","in":"query","schemaId":"schema_522","description":"product availability id when not stocked. Optional.","example":-2},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"date of product creation, lower limit. Optional.","example":"2017-02-28T17:04:47+0100"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"date of product creation, upper limit. Optional.","example":"2028-02-28T17:04:47+0100"},{"name":"visibility","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility (visible, hidden, only for logged-in users...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Optional."},"children":[]}]}]}],"example":"visible"},{"name":"type","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product type (product, service, bazar...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Optional."},"children":[]}]}]}],"example":"product"},{"name":"brandName","in":"query","schemaId":"schema_523","description":"product brand (manufacturer) name. Optional.","example":"Storm"},{"name":"brandCode","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product brand (manufacturer) code from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/brands"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional."},"children":[]}]}]}],"example":"storm"},{"name":"defaultCategoryGuid","in":"query","schemaId":"schema_523","description":"product default category. Optional.","example":"5c499a23-70ac-11e9-9208-08002774f818"},{"name":"categoryGuid","in":"query","schemaId":"schema_523","description":"product category - only the products added to specific category will\nbe included. Optional.","example":"5c499a23-70ac-11e9-9208-08002774f818"},{"name":"flag","in":"query","schemaId":"schema_523","description":"product flag - only products with selected flag will be included","example":"action"},{"name":"supplierGuid","in":"query","schemaId":"schema_523","description":"supplier GUID - only products with selected supplier will be\nincluded","example":"16a67ec6-d957-11e0-b04f-57a43310b768"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"date of product last update, lower limit. Optional.","example":"2017-02-28T17:04:47+0100"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":"date of product last update, upper limit. Optional.","example":"2028-02-28T17:04:47+0100"}],"pointer":"/paths/~1api~1products~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,warranty,sortVariants,gifts,alternativeProducts,relatedProducts,relatedVideos,relatedFiles,perStockAmounts,perPricelistPrices","schemaId":"schema_523"},{"name":"productCodes","in":"query","example":"15/ZLU,15/ZEL,27/XL,33/FIA,DS53437473,428","schemaId":"schema_523"},{"name":"productGuids","in":"query","example":"356eb81e-d966-11e0-b04f-57a43310b768,519d8f84-1609-11f0-bcf6-06999863e34a,519d8f84-1609-11f0-bcf6-06999863e34a","schemaId":"schema_523"},{"name":"availabilityId","in":"query","example":1,"schemaId":"schema_522"},{"name":"availabilityWhenSoldOutId","in":"query","example":-2,"schemaId":"schema_522"},{"name":"creationTimeFrom","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2028-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"visibility","in":"query","example":"visible","schemaId":"schema_523"},{"name":"type","in":"query","example":"product","schemaId":"schema_523"},{"name":"brandName","in":"query","example":"Storm","schemaId":"schema_523"},{"name":"brandCode","in":"query","example":"storm","schemaId":"schema_523"},{"name":"defaultCategoryGuid","in":"query","example":"5c499a23-70ac-11e9-9208-08002774f818","schemaId":"schema_523"},{"name":"categoryGuid","in":"query","example":"5c499a23-70ac-11e9-9208-08002774f818","schemaId":"schema_523"},{"name":"flag","in":"query","example":"action","schemaId":"schema_523"},{"name":"supplierGuid","in":"query","example":"16a67ec6-d957-11e0-b04f-57a43310b768","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2017-02-28T17:04:47+0100","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2028-02-28T17:04:47+0100","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202","400","403"],"pointer":"/api/products/snapshot","href":"products/getlistofallproducts","openApiOperationId":"getListOfAllProducts","summary":"List of all products","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1snapshot/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1snapshot/get/responses/400/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1snapshot/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1snapshot/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1snapshot/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1snapshot/get/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1snapshot/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1snapshot/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getlistofallproducts"}],"panels":[]}]},"httpPath":"/api/products/snapshot"},{"label":"List of all products and pricelist prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getlistofallproductsandpricelistprices","routeSlug":"/shoptet-api/openapi/products/getlistofallproductsandpricelistprices","metadata":{"seo":{"title":"List of all products and pricelist prices","description":"Using this endpoint, you can get list of all products with basic data such as product guid, id, code and its prices across all pricelists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllProductsAndPricelistPrices","name":"List of all products and pricelist prices","isWebhook":false,"pointer":"/paths/~1api~1products~1snapshot~1pricelists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all products and pricelist prices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all products with basic data such as product guid, id, code and its prices across all pricelists."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each product taking one line of output file. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/productpricelistsnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product price list snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1snapshot~1pricelists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/snapshot/pricelists","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/products/snapshot/pricelists","href":"products/getlistofallproductsandpricelistprices","openApiOperationId":"getListOfAllProductsAndPricelistPrices","summary":"List of all products and pricelist prices","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1products~1snapshot~1pricelists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getlistofallproductsandpricelistprices"}],"panels":[]}]},"httpPath":"/api/products/snapshot/pricelists"},{"label":"Product detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getproductdetail","routeSlug":"/shoptet-api/openapi/products/getproductdetail","metadata":{"seo":{"title":"Product detail","description":"Returns detailed information about one product. The product includes the variant field. In case the product comes in variants,the field contains all the available variants. If the product does not have any variants, it contains only one variantwith product information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductDetail","name":"Product detail","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns detailed information about one product. The product includes the variant field. In case the product comes in variants,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the field contains all the available variants. If the product does not have any variants, it contains only one variant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with product information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are sent only when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain the list of all product images. For more information about the chapter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Product-images"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product images"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variantParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain a field of variant parameters and a variant description, as they are visible to customers."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allCategories"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain information on all the categories that the product was assigned into"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flags"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details on product designation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descriptiveParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain descriptive parameters of the product"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"measureUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain measure unit info of every variant."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain surcharge parameters of the product."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setItems"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain items, products, in set."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain filtering parameters of the product."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recyclingFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain recycling fee."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consumptionTax"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain consumption tax. Requires the \"Consumption tax\" module to be enabled on the current e-shop."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warranty"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain product warranty."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sortVariants"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product variants will be sorted as in administration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gifts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product gifts, will be sorted as in administration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"alternativeProducts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain alternative products."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relatedProducts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain related products."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relatedVideos"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain related videos."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"relatedFiles"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain related files."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"perStockAmounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain amounts/claims per individual stocks. Requires the \"stock\" module to be enabled on the current e-shop."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"perPricelistPrices"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response will also contain prices per individual price lists."},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,warranty,sortVariants,gifts,alternativeProducts,relatedProducts,relatedVideos,relatedFiles,perStockAmounts,perPricelistPrices"}],"pointer":"/paths/~1api~1products~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,warranty,sortVariants,gifts,alternativeProducts,relatedProducts,relatedVideos,relatedFiles,perStockAmounts,perPricelistPrices","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/products/{guid}","href":"products/getproductdetail","openApiOperationId":"getProductDetail","summary":"Product detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_610"}},"schemaId":"schema_610"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1{guid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_610","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_610"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproductdetail"}],"panels":[]}]},"httpPath":"/api/products/{guid}"},{"label":"Product update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/updateproduct","routeSlug":"/shoptet-api/openapi/products/updateproduct","metadata":{"seo":{"title":"Product update","description":"This endpoint allows you to update a product identified by its guid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProduct","name":"Product update","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to update a product identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request is sent in JSON format in its body. For detailed description of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"items which can be updated and their format, check the right-most pane,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"section \"Request\" » \"Attributes\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating variants"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update an existing variant. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or does not match any existing variant, a new variant is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To rename a variant code, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to identify the variant and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newCode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the new code value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant parameters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must contain ALL parameters the variant should have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after the update. Omitting an existing parameter will delete it — e.g."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if a variant has \"color:black\" and you send only \"size:XL\", \"color\" will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of variants per product is 512."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product's categories are being updated by another concurrent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request at the same time, a 423 code is returned. Retry the request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"bffa3b98-d968-11e0-b04f-57a43310b768"}],"pointer":"/paths/~1api~1products~1{guid}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,consumptionTax"}],"pointer":"/paths/~1api~1products~1{guid}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","pointer":"/paths/~1api~1products~1{guid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"bffa3b98-d968-11e0-b04f-57a43310b768","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,consumptionTax","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_611"}},"responseCodes":["200","403","422","423"],"pointer":"/api/products/{guid}","href":"products/updateproduct","openApiOperationId":"updateProduct","summary":"Product update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_611"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}},"schemaId":"schema_609"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/403/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/422/content/application~1json/example"]},{"code":"423","description":"Locked","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/423/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/423/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1{guid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_609","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/422/content/application~1json/example"]}}},{"code":"423","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/423/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/patch/responses/423/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/updateproduct"}],"panels":[]}]},"httpPath":"/api/products/{guid}"},{"label":"Product deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/deleteproduct","routeSlug":"/shoptet-api/openapi/products/deleteproduct","metadata":{"seo":{"title":"Product deletion","description":"Deletes product as per entered guid. If successful, returns the code200."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProduct","name":"Product deletion","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes product as per entered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If successful, returns the code"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product does not exist within the e-shop, a 404 code is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product cannot be deleted, because it is part of set or used as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gift to some product, a 409 code is returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/products/{guid}","href":"products/deleteproduct","openApiOperationId":"deleteProduct","summary":"Product deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1{guid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/deleteproduct"}],"panels":[]}]},"httpPath":"/api/products/{guid}"},{"label":"Product BATCH delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/productbatchdelete","routeSlug":"/shoptet-api/openapi/products/productbatchdelete","metadata":{"seo":{"title":"Product BATCH delete","description":"This endpoint allows you to delete multiple products or product variants at once. Batchdelete is processed asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"productBatchDelete","name":"Product BATCH delete","isWebhook":false,"pointer":"/paths/~1api~1products~1batch/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product BATCH delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to delete multiple products or product variants at once. Batch"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delete is processed asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File with data must be in JSONL ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") format. Each line must contain one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item in JSON format. Maximum size of file is 100MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each JSON row must contain either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (to delete a whole product) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (to delete a single variant)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a product has only one variant, providing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deletes the whole product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous job processes the jsonl file row by row and tries to validate and delete each item. If there is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any error, the row is skipped and the error is logged, but processing of other rows continues."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Log, every item is identified by its position in file (starting from 1)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/batch/productbatchdeleteschema"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product batch delete schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1batch/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","pointer":"/paths/~1api~1products~1batch/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/batch","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_544"}},"responseCodes":["202","404","409"],"pointer":"/api/products/batch","href":"products/productbatchdelete","openApiOperationId":"productBatchDelete","summary":"Product BATCH delete","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_604"}},"schemaId":"schema_604"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1products~1batch/delete/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1products~1batch/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1products~1batch/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1products~1batch/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1batch/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_604","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_604"}}},{"code":"404","exampleIds":["paths/~1api~1products~1batch/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1products~1batch/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_568","exampleIds":["paths/~1api~1products~1batch/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1products~1batch/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productbatchdelete"}],"panels":[]}]},"httpPath":"/api/products/batch"},{"label":"Product BATCH update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/productbatchupdate","routeSlug":"/shoptet-api/openapi/products/productbatchupdate","metadata":{"seo":{"title":"Product BATCH update","description":"This endpoint allows you to update multiple products at once. Batchupdate is processed asynchronously in same way as for example productssnapshot, but it does not have resultUrl with products to download in response.Instead, you can check attribute log which contains successfully updated products and errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"productBatchUpdate","name":"Product BATCH update","isWebhook":false,"pointer":"/paths/~1api~1products~1batch/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product BATCH update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to update multiple products at once. Batch"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update is processed asynchronously in same way as for example products"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snapshot, but it does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with products to download in response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead, you can check attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"log"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains successfully updated products and errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File with data for update must be in JSONL ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") format. Each line must contain one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product in JSON format. Maximum size of file is 100MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structure of JSON row is same as structure of JSON for single product update above. You can add one extra optional attribute"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"language\" which defines language of updating product, so you are able to update multiple language attributes (i.e. \"name\", \"description\" etc.)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of one product in one batch file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If language is not defined, default language of shop is used. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/batch/productbatchupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product batch update schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous job process jsonl file row by row and try to validate and save data. If there is any error, row is skipped and error is logged,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but it does not stop processing of other rows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Log, every product is identified by its position in file (starting from 1)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1batch/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","pointer":"/paths/~1api~1products~1batch/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/batch","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_544"}},"responseCodes":["202","404","409"],"pointer":"/api/products/batch","href":"products/productbatchupdate","openApiOperationId":"productBatchUpdate","summary":"Product BATCH update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1products~1batch/patch/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1products~1batch/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1batch/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1batch/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1batch/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"404","exampleIds":["paths/~1api~1products~1batch/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1products~1batch/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1batch/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1batch/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productbatchupdate"}],"panels":[]}]},"httpPath":"/api/products/batch"},{"label":"Product image BATCH delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/productimagebatchdelete","routeSlug":"/shoptet-api/openapi/products/productimagebatchdelete","metadata":{"seo":{"title":"Product image BATCH delete","description":"This endpoint allows you to delete multiple product images at once. Batch delete is processedasynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"productImageBatchDelete","name":"Product image BATCH delete","isWebhook":false,"pointer":"/paths/~1api~1products~1images~1batch/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product image BATCH delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to delete multiple product images at once. Batch delete is processed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File with data must be in JSONL ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") format. Each line must contain one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item in JSON format. Maximum size of file is 100MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each JSON row must contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gallery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop360"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Optionally it may contain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the image file name). When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, only that image is deleted. When"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imageName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted, all images of the product in the given gallery are deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body may contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"removeReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that applies to the whole batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", images referenced by product variants are deleted and the variant reference is cleared"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a referenced single image is refused (the row is logged as an error), and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenced images are skipped when deleting all images of a gallery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous job processes the jsonl file row by row and tries to validate and delete each item. If there is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any error (e.g. unknown product or image), the row is skipped and the error is logged, but processing of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other rows continues."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Log, every item is identified by its position in file (starting from 1)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1images~1batch/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_612"}},"schemaId":"schema_612","pointer":"/paths/~1api~1products~1images~1batch/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/images/batch","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_612"}},"responseCodes":["202","404","409"],"pointer":"/api/products/images/batch","href":"products/productimagebatchdelete","openApiOperationId":"productImageBatchDelete","summary":"Product image BATCH delete","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_612","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_612"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_604"}},"schemaId":"schema_604"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1products~1images~1batch/delete/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1products~1images~1batch/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1products~1images~1batch/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1products~1images~1batch/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1images~1batch/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_604","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_604"}}},{"code":"404","exampleIds":["paths/~1api~1products~1images~1batch/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1products~1images~1batch/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_568","exampleIds":["paths/~1api~1products~1images~1batch/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1products~1images~1batch/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/productimagebatchdelete"}],"panels":[]}]},"httpPath":"/api/products/images/batch"},{"label":"Product detail by code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getproductdetailbycode","routeSlug":"/shoptet-api/openapi/products/getproductdetailbycode","metadata":{"seo":{"title":"Product detail by code","description":"Retrieve details about one product. Optional sections can be requestedusing ?include= parameterThe response format is the same as for Product detail endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductDetailByCode","name":"Product detail by code","isWebhook":false,"pointer":"/paths/~1api~1products~1code~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product detail by code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve details about one product. Optional sections can be requested"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response format is the same as for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/products/getlistofproducts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product detail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"product or variant code.","required":true,"example":"133"}],"pointer":"/paths/~1api~1products~1code~1{code}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,perStockAmounts,sortVariants,perPricelistPrices"}],"pointer":"/paths/~1api~1products~1code~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1code~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/code/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"133","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,recyclingFee,consumptionTax,perStockAmounts,sortVariants,perPricelistPrices","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/products/code/{code}","href":"products/getproductdetailbycode","openApiOperationId":"getProductDetailByCode","summary":"Product detail by code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_610"}},"schemaId":"schema_610"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1code~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_610","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_610"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproductdetailbycode"}],"panels":[]}]},"httpPath":"/api/products/code/{code}"},{"label":"Product update by code","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/updateproductbycode","routeSlug":"/shoptet-api/openapi/products/updateproductbycode","metadata":{"seo":{"title":"Product update by code","description":"This endpoint allows you to update products identified by a product codein Shoptet."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductByCode","name":"Product update by code","isWebhook":false,"pointer":"/paths/~1api~1products~1code~1{code}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product update by code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to update products identified by a product code"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in Shoptet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request is sent in JSON format in its body. For detailed description of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"items, which can be updated and their format,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"check the right-most pane, section \"Request\" » \"Attributes\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product variant can be updated by specifying its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not specified or not existing, new variant will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you want to change "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of variant, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to specify variant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be changed and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"newCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for specifying new code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should contain ALL parameters that the edited variant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should contain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means, if you have for example \"color:black\" in variant and you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specify only new parameter \"velikost\", parameter color will be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that any product's variant can be edited by this endpoint,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not only the one in url"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Product or variant code","required":true,"example":"00351"}],"pointer":"/paths/~1api~1products~1code~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,perStockAmounts,perPricelistPrices,recyclingFee,consumptionTax"}],"pointer":"/paths/~1api~1products~1code~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1code~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_611"}},"schemaId":"schema_611","pointer":"/paths/~1api~1products~1code~1{code}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/code/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"00351","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","example":"images,variantParameters,allCategories,flags,descriptiveParameters,measureUnit,surchargeParameters,setItems,filteringParameters,perStockAmounts,perPricelistPrices,recyclingFee,consumptionTax","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_611"}},"responseCodes":["200","403","422"],"pointer":"/api/products/code/{code}","href":"products/updateproductbycode","openApiOperationId":"updateProductByCode","summary":"Product update by code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_611","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_611"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}},"schemaId":"schema_609"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/patch/responses/403/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1code~1{code}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_609","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_609"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/patch/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/updateproductbycode"}],"panels":[]}]},"httpPath":"/api/products/code/{code}"},{"label":"Product variant deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/deleteproductvariant","routeSlug":"/shoptet-api/openapi/products/deleteproductvariant","metadata":{"seo":{"title":"Product variant deletion","description":"Deletes product variant as per entered code. If this is the lastproduct variant, the entire product is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProductVariant","name":"Product variant deletion","isWebhook":false,"pointer":"/paths/~1api~1products~1code~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product variant deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes product variant as per entered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this is the last"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product variant, the entire product is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If successful, returns the code 200."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product variant does not exist within the e-shop, a 404 code is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the product variant cannot be deleted, because it is part of set or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used as a gift to some product, a 409 code is returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"product variant code.","required":true,"example":"112"}],"pointer":"/paths/~1api~1products~1code~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1code~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/code/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"112","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/products/code/{code}","href":"products/deleteproductvariant","openApiOperationId":"deleteProductVariant","summary":"Product variant deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1code~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1code~1{code}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/deleteproductvariant"}],"panels":[]}]},"httpPath":"/api/products/code/{code}"},{"label":"Unlink all product related files","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/unlinkallproductrelatedfiles","routeSlug":"/shoptet-api/openapi/products/unlinkallproductrelatedfiles","metadata":{"seo":{"title":"Unlink all product related files","description":"Unlink all related files linked to a specific product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlinkAllProductRelatedFiles","name":"Unlink all product related files","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1related-files/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlink all product related files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Unlink all related files linked to a specific product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1related-files/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1related-files/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/{guid}/related-files","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/products/{guid}/related-files","href":"products/unlinkallproductrelatedfiles","openApiOperationId":"unlinkAllProductRelatedFiles","summary":"Unlink all product related files","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1{guid}~1related-files/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/unlinkallproductrelatedfiles"}],"panels":[]}]},"httpPath":"/api/products/{guid}/related-files"},{"label":"Last product changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/products/getlastproductchanges","routeSlug":"/shoptet-api/openapi/products/getlastproductchanges","metadata":{"seo":{"title":"Last product changes","description":"Returns the list of products, which were changed (added/edited or deleted). Endpoint is intended to determinethe changes after you have loaded the complete list of products and you need to know if any of these have been changed.Guaranteed history is 30 days, older data are deleted progressively."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLastProductChanges","name":"Last product changes","isWebhook":false,"pointer":"/paths/~1api~1products~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last product changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of products, which were changed (added/edited or deleted). Endpoint is intended to determine"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the changes after you have loaded the complete list of products and you need to know if any of these have been changed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guaranteed history is 30 days, older data are deleted progressively."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each product in the log is mentioned only with its last change. For example, if the product was modified and then deleted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the log will show only information about its deletion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be filtered by changeType = edit/delete parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation is considered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action. So, when there is a new item created, it will be displayed like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of object attributes with information about changes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Causes product change"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creationTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changeTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shortDescription"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"metaDescription"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"internalNote"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defaultCategory"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only category - product relation change"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defaultCategory.guid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defaultCategory.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only supplier - product relation change"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplier.guid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplier.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only brand - product relation change"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand.code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"categories"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only product - category relation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"categories.guid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"categories.parentGuid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"categories.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for relative url. Domain change no"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flags"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flags.code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flags.title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flags.dateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flags.dateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.ean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.stock"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.unit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.weight"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.visible"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.minStockSupply"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.negativeStockAllowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.amountDecimalPlaces"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.price"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.includingVat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.vatRate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.currencyCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.actionPrice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.commonPrice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.manufacturerCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.pluCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.isbn"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.serialNo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.mpn"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.availability"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.availabilityWhenSoldOut"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.image"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.measureUnit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.measureUnit.measureAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.measureUnit.measureUnitId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.measureUnit.packagingAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.measureUnit.packagingUnitId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.measureUnit.measureUnitName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.measureUnit.packagingUnitName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.measureUnit.measurePrice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variants.recyclingFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images.priority"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images.description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images.changeTime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images.seoName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images.cdnName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"images.signedCdnNames"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descriptiveParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descriptiveParameters.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descriptiveParameters.value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descriptiveParameters.description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descriptiveParameters.priority"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.displayName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.priority"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.includingVat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.values.valueIndex"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.values.description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.values.price"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.values.priority"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"surchargeParameters.values.visible"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setItems"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setItems.guid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setItems.code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"setItems.amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only relation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.displayName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.priority"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.googleMapping"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only relation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.values.valueIndex"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.values.name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.values.priority"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.values.color"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filteringParameters.values.image"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warranty"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only relation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warranty.inMonths"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warranty.description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime from which up to the present we are interested in the changes. + in the time zone"},"children":[]}]}]}],"required":true,"example":"2018-01-01T01:01:01+02:00"},{"name":"changeType","in":"query","schemaId":"schema_523","description":"Returning only edit or delete type changed records","example":"edit"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 1000.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1products~1changes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/changes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":true,"example":"2018-01-01T01:01:01+02:00","schemaId":"schema_523"},{"name":"changeType","in":"query","required":false,"example":"edit","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/changes","href":"products/getlastproductchanges","openApiOperationId":"getLastProductChanges","summary":"Last product changes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_613"}},"schemaId":"schema_613"}],"pointer":"/paths/~1api~1products~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_613","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_613"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getlastproductchanges"}],"panels":[]}]},"httpPath":"/api/products/changes"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Managing products in the e-shop and also its related modules."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products","summary":"List of products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getlistofproducts","deprecated":false},{"title":"/api/products","summary":"Product insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/createproduct","deprecated":false},{"title":"/api/products/{guid}/copy","summary":"Product copy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/productcopy","deprecated":false},{"title":"/api/products/snapshot","summary":"List of all products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getlistofallproducts","deprecated":false},{"title":"/api/products/snapshot/pricelists","summary":"List of all products and pricelist prices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getlistofallproductsandpricelistprices","deprecated":false},{"title":"/api/products/{guid}","summary":"Product detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getproductdetail","deprecated":false},{"title":"/api/products/{guid}","summary":"Product update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/products/updateproduct","deprecated":false},{"title":"/api/products/{guid}","summary":"Product deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/deleteproduct","deprecated":false},{"title":"/api/products/batch","summary":"Product BATCH delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/productbatchdelete","deprecated":false},{"title":"/api/products/batch","summary":"Product BATCH update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/products/productbatchupdate","deprecated":false},{"title":"/api/products/images/batch","summary":"Product image BATCH delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/productimagebatchdelete","deprecated":false},{"title":"/api/products/code/{code}","summary":"Product detail by code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getproductdetailbycode","deprecated":false},{"title":"/api/products/code/{code}","summary":"Product update by code","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/products/updateproductbycode","deprecated":false},{"title":"/api/products/code/{code}","summary":"Product variant deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/deleteproductvariant","deprecated":false},{"title":"/api/products/{guid}/related-files","summary":"Unlink all product related files","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/unlinkallproductrelatedfiles","deprecated":false},{"title":"/api/products/changes","summary":"Last product changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getlastproductchanges","deprecated":false}]}]}]}]}},{"type":"group","label":"Product availabilities","link":"/shoptet-api/openapi/product-availabilities","routeSlug":"/shoptet-api/openapi/product-availabilities","items":[{"label":"List of products availabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-availabilities/getlistofproductsavailabilities","routeSlug":"/shoptet-api/openapi/product-availabilities/getlistofproductsavailabilities","metadata":{"seo":{"title":"List of products availabilities","description":"Returns the list of product availabilities within the e-shop and default availabilities ids."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductsAvailabilities","name":"List of products availabilities","isWebhook":false,"pointer":"/paths/~1api~1products~1availabilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of products availabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of product availabilities within the e-shop and default availabilities ids."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1availabilities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/availabilities","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/availabilities","href":"product-availabilities/getlistofproductsavailabilities","openApiOperationId":"getListOfProductsAvailabilities","summary":"List of products availabilities","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_614"}},"schemaId":"schema_614"}],"pointer":"/paths/~1api~1products~1availabilities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_614","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_614"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-availabilities/getlistofproductsavailabilities"}],"panels":[]}]},"httpPath":"/api/products/availabilities"},{"label":"Product availability creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-availabilities/createproductavailability","routeSlug":"/shoptet-api/openapi/product-availabilities/createproductavailability","metadata":{"seo":{"title":"Product availability creation","description":"Creates a new product availability."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductAvailability","name":"Product availability creation","isWebhook":false,"pointer":"/paths/~1api~1products~1availabilities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product availability creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new product availability."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1availabilities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_615"}},"schemaId":"schema_615","pointer":"/paths/~1api~1products~1availabilities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/availabilities","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_615"}},"responseCodes":["201","422"],"pointer":"/api/products/availabilities","href":"product-availabilities/createproductavailability","openApiOperationId":"createProductAvailability","summary":"Product availability creation","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_615","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_615"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_616"}},"schemaId":"schema_616"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1availabilities/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_616","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_616"}}},{"code":"422","schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-availabilities/createproductavailability"}],"panels":[]}]},"httpPath":"/api/products/availabilities"},{"label":"Update of product availability","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-availabilities/updateproductavailability","routeSlug":"/shoptet-api/openapi/product-availabilities/updateproductavailability","metadata":{"seo":{"title":"Update of product availability","description":"Updates a product availability."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductAvailability","name":"Update of product availability","isWebhook":false,"pointer":"/paths/~1api~1products~1availabilities~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of product availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a product availability."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"product availability ID","required":true,"example":123}],"pointer":"/paths/~1api~1products~1availabilities~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1availabilities~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_618"}},"schemaId":"schema_618","pointer":"/paths/~1api~1products~1availabilities~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/availabilities/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":123,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_618"}},"responseCodes":["200","404","422"],"pointer":"/api/products/availabilities/{id}","href":"product-availabilities/updateproductavailability","openApiOperationId":"updateProductAvailability","summary":"Update of product availability","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_618","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_618"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_616"}},"schemaId":"schema_616"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1availabilities~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_616","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_616"}}},{"code":"404","schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-availabilities/updateproductavailability"}],"panels":[]}]},"httpPath":"/api/products/availabilities/{id}"},{"label":"Deletion of product availability","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-availabilities/deleteproductavailability","routeSlug":"/shoptet-api/openapi/product-availabilities/deleteproductavailability","metadata":{"seo":{"title":"Deletion of product availability","description":"Deletes a product availability."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProductAvailability","name":"Deletion of product availability","isWebhook":false,"pointer":"/paths/~1api~1products~1availabilities~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of product availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a product availability."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"product availability ID","required":true,"example":123}],"pointer":"/paths/~1api~1products~1availabilities~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1availabilities~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/availabilities/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":123,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/products/availabilities/{id}","href":"product-availabilities/deleteproductavailability","openApiOperationId":"deleteProductAvailability","summary":"Deletion of product availability","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_619","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_619","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/422/content/application~1json/example"]}},"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1availabilities~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_619","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_619","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1products~1availabilities~1{id}/delete/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-availabilities/deleteproductavailability"}],"panels":[]}]},"httpPath":"/api/products/availabilities/{id}"}],"content":{"contentType":"group","meta":{"name":"Product availabilities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product availabilities","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/availabilities","summary":"List of products availabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-availabilities/getlistofproductsavailabilities","deprecated":false},{"title":"/api/products/availabilities","summary":"Product availability creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-availabilities/createproductavailability","deprecated":false},{"title":"/api/products/availabilities/{id}","summary":"Update of product availability","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/product-availabilities/updateproductavailability","deprecated":false},{"title":"/api/products/availabilities/{id}","summary":"Deletion of product availability","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-availabilities/deleteproductavailability","deprecated":false}]}]}]}]}},{"type":"group","label":"Product gifts","link":"/shoptet-api/openapi/product-gifts","routeSlug":"/shoptet-api/openapi/product-gifts","items":[{"label":"List of product gifts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-gifts/getlistofproductgifts","routeSlug":"/shoptet-api/openapi/product-gifts/getlistofproductgifts","metadata":{"seo":{"title":"List of product gifts","description":"Returns list of gifts related (product variants) to product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductGifts","name":"List of product gifts","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1gifts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of product gifts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of gifts related (product variants) to product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/{guid}/gifts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/{guid}/gifts","href":"product-gifts/getlistofproductgifts","openApiOperationId":"getListOfProductGifts","summary":"List of product gifts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}},"schemaId":"schema_620"}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_620","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-gifts/getlistofproductgifts"}],"panels":[]}]},"httpPath":"/api/products/{guid}/gifts"},{"label":"Insertion gift product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-gifts/createproductgift","routeSlug":"/shoptet-api/openapi/product-gifts/createproductgift","metadata":{"seo":{"title":"Insertion gift product","description":"Insertion gift product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductGift","name":"Insertion gift product","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1gifts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insertion gift product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_621"}},"schemaId":"schema_621","pointer":"/paths/~1api~1products~1{guid}~1gifts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/{guid}/gifts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_621"}},"responseCodes":["201"],"pointer":"/api/products/{guid}/gifts","href":"product-gifts/createproductgift","openApiOperationId":"createProductGift","summary":"Insertion gift product","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_621","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_621"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}},"schemaId":"schema_620"}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_620","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-gifts/createproductgift"}],"panels":[]}]},"httpPath":"/api/products/{guid}/gifts"},{"label":"Setting gifts to product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-gifts/setgiftstoproduct","routeSlug":"/shoptet-api/openapi/product-gifts/setgiftstoproduct","metadata":{"seo":{"title":"Setting gifts to product","description":"Setting gifts to product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setGiftsToProduct","name":"Setting gifts to product","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1gifts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Setting gifts to product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_622"}},"schemaId":"schema_622","pointer":"/paths/~1api~1products~1{guid}~1gifts/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/products/{guid}/gifts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_622"}},"responseCodes":["200"],"pointer":"/api/products/{guid}/gifts","href":"product-gifts/setgiftstoproduct","openApiOperationId":"setGiftsToProduct","summary":"Setting gifts to product","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_622","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_622"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}},"schemaId":"schema_620"}],"pointer":"/paths/~1api~1products~1{guid}~1gifts/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_620","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_620"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-gifts/setgiftstoproduct"}],"panels":[]}]},"httpPath":"/api/products/{guid}/gifts"}],"content":{"contentType":"group","meta":{"name":"Product gifts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product gifts","showPageActions":true},{"nodeType":"markdoc","content":"Managing product gifts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/{guid}/gifts","summary":"List of product gifts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-gifts/getlistofproductgifts","deprecated":false},{"title":"/api/products/{guid}/gifts","summary":"Insertion gift product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-gifts/createproductgift","deprecated":false},{"title":"/api/products/{guid}/gifts","summary":"Setting gifts to product","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-gifts/setgiftstoproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Product images","link":"/shoptet-api/openapi/product-images","routeSlug":"/shoptet-api/openapi/product-images","items":[{"label":"List of product images","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/getlistofproductimages","routeSlug":"/shoptet-api/openapi/product-images/getlistofproductimages","metadata":{"seo":{"title":"List of product images","description":"Returns list of product's images."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductImages","name":"List of product images","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of product images","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns list of product's images."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data from this endpoint and from product's detail endpoint (list named"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter) are the same."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when working only with product images to save time."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product's guid","required":true,"example":"92ca3575-7481-11e8-8216-002590dad85e"},{"name":"gallery","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gallery identifier - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for normal and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop360"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 360"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"photos"},"children":[]}]}]}],"required":true,"example":"shop"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/{guid}/images/{gallery}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"92ca3575-7481-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"gallery","in":"path","required":true,"example":"shop","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/{guid}/images/{gallery}","href":"product-images/getlistofproductimages","openApiOperationId":"getListOfProductImages","summary":"List of product images","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_623"}},"schemaId":"schema_623"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_623","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_623"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-images/getlistofproductimages"}],"panels":[]}]},"httpPath":"/api/products/{guid}/images/{gallery}"},{"label":"Delete all product images in gallery","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/deleteallproductimagesingallery","routeSlug":"/shoptet-api/openapi/product-images/deleteallproductimagesingallery","metadata":{"seo":{"title":"Delete all product images in gallery","description":"Deletes all product's images by gallery name. If removeReferenceparameter is not present or set to false and if image is referenced"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAllProductImagesInGallery","name":"Delete all product images in gallery","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all product images in gallery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes all product's images by gallery name. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"removeReference"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter is not present or set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and if image is referenced"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as variant image, then image will be skipped and present in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"removeReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, then this reference will be removed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the image."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status code. If any image deletion failed, it will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"noted in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section in response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product's guid","required":true,"example":"94fe7ffc-7481-11e8-8216-002590dad85e"},{"name":"gallery","in":"path","schemaId":"schema_523","description":"Gallery name (shop or shop360)","required":true,"example":"shop"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"removeReference","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If product's variant image reference should be removed. Default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/{guid}/images/{gallery}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"94fe7ffc-7481-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"gallery","in":"path","required":true,"example":"shop","schemaId":"schema_523"}],"query":[{"name":"removeReference","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/{guid}/images/{gallery}","href":"product-images/deleteallproductimagesingallery","openApiOperationId":"deleteAllProductImagesInGallery","summary":"Delete all product images in gallery","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550","exampleIds":["paths/~1api~1products~1{guid}~1images~1{gallery}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_550","exampleIds":["paths/~1api~1products~1{guid}~1images~1{gallery}/delete/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","exampleIds":["paths/~1api~1products~1{guid}~1images~1{gallery}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550","exampleIds":["paths/~1api~1products~1{guid}~1images~1{gallery}/delete/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-images/deleteallproductimagesingallery"}],"panels":[]}]},"httpPath":"/api/products/{guid}/images/{gallery}"},{"label":"Product images update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/getproductimagesupdate","routeSlug":"/shoptet-api/openapi/product-images/getproductimagesupdate","metadata":{"seo":{"title":"Product images update","description":"Using this endpoint you can modify product images attributes, such as description and priority (order). Maximum of 100 images can be sent at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductImagesUpdate","name":"Product images update","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product images update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Using this endpoint you can modify product images attributes, such as\ndescription and priority (order). Maximum of 100 images can be sent at\nonce."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product's guid","required":true,"example":"95b84d4b-7481-11e8-8216-002590dad85e"},{"name":"gallery","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gallery identifier - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for normal and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop360"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 360"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"photos"},"children":[]}]}]}],"required":true,"example":"shop"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_624"}},"schemaId":"schema_624","pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/{guid}/images/{gallery}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"95b84d4b-7481-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"gallery","in":"path","required":true,"example":"shop","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_624"}},"responseCodes":["200"],"pointer":"/api/products/{guid}/images/{gallery}","href":"product-images/getproductimagesupdate","openApiOperationId":"getProductImagesUpdate","summary":"Product images update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_624","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_624"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_625"}},"schemaId":"schema_625"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_625","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_625"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-images/getproductimagesupdate"}],"panels":[]}]},"httpPath":"/api/products/{guid}/images/{gallery}"},{"label":"Product images insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/createproductimages","routeSlug":"/shoptet-api/openapi/product-images/createproductimages","metadata":{"seo":{"title":"Product images insertion","description":"Using this endpoint you can upload new images to a product. This is anasynchronous request,"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductImages","name":"Product images insertion","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product images insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint you can upload new images to a product. This is an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asynchronous request,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"developer's portal. Maximum of 100 images can be sent at once."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product's guid","required":true,"example":"95b84d4b-7481-11e8-8216-002590dad85e"},{"name":"gallery","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gallery identifier - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for normal and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop360"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 360"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"photos"},"children":[]}]}]}],"required":true,"example":"shop"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_626"}},"schemaId":"schema_626","pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/{guid}/images/{gallery}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"95b84d4b-7481-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"gallery","in":"path","required":true,"example":"shop","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_626"}},"responseCodes":["202"],"pointer":"/api/products/{guid}/images/{gallery}","href":"product-images/createproductimages","openApiOperationId":"createProductImages","summary":"Product images insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_626","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_626"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-images/createproductimages"}],"panels":[]}]},"httpPath":"/api/products/{guid}/images/{gallery}"},{"label":"Product images source update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/updateproductimagessource","routeSlug":"/shoptet-api/openapi/product-images/updateproductimagessource","metadata":{"seo":{"title":"Product images source update","description":"Using this endpoint you can modify product image attributes and alsoupload a new image and replace the existing one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductImagesSource","name":"Product images source update","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1source/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product images source update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint you can modify product image attributes and also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upload a new image and replace the existing one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an asynchronous request, see how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product's guid","required":true,"example":"95b84d4b-7481-11e8-8216-002590dad85e"},{"name":"gallery","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gallery identifier - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for normal and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shop360"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 360"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"photos"},"children":[]}]}]}],"required":true,"example":"shop"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1source/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1source/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_627"}},"schemaId":"schema_627","pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1source/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/{guid}/images/{gallery}/source","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"95b84d4b-7481-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"gallery","in":"path","required":true,"example":"shop","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_627"}},"responseCodes":["202"],"pointer":"/api/products/{guid}/images/{gallery}/source","href":"product-images/updateproductimagessource","openApiOperationId":"updateProductImagesSource","summary":"Product images source update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_627","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_627"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1source/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-images/updateproductimagessource"}],"panels":[]}]},"httpPath":"/api/products/{guid}/images/{gallery}/source"},{"label":"Delete one product image","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-images/deleteoneproductimage","routeSlug":"/shoptet-api/openapi/product-images/deleteoneproductimage","metadata":{"seo":{"title":"Delete one product image","description":"Deletes product's image. If removeReference parameter is not presentor set to false and if image is referenced"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOneProductImage","name":"Delete one product image","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1{imageName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete one product image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes product's image. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"removeReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is not present"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and if image is referenced"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as variant image, then image won't be deleted and response will have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"removeReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to true, then this reference will be removed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the image."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product's guid","required":true,"example":"92d77e60-7481-11e8-8216-002590dad85e"},{"name":"gallery","in":"path","schemaId":"schema_523","description":"Gallery name (shop or shop360)","required":true,"example":"shop"},{"name":"imageName","in":"path","schemaId":"schema_523","description":"Filename","required":true,"example":"52.png"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1{imageName}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"removeReference","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If product's variant image reference should be removed. Default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1{imageName}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1{imageName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/{guid}/images/{gallery}/{imageName}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"92d77e60-7481-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"gallery","in":"path","required":true,"example":"shop","schemaId":"schema_523"},{"name":"imageName","in":"path","required":true,"example":"52.png","schemaId":"schema_523"}],"query":[{"name":"removeReference","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/{guid}/images/{gallery}/{imageName}","href":"product-images/deleteoneproductimage","openApiOperationId":"deleteOneProductImage","summary":"Delete one product image","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"}],"pointer":"/paths/~1api~1products~1{guid}~1images~1{gallery}~1{imageName}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-images/deleteoneproductimage"}],"panels":[]}]},"httpPath":"/api/products/{guid}/images/{gallery}/{imageName}"}],"content":{"contentType":"group","meta":{"name":"Product images"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product images","showPageActions":true},{"nodeType":"markdoc","content":"Managing product images."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/{guid}/images/{gallery}","summary":"List of product images","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-images/getlistofproductimages","deprecated":false},{"title":"/api/products/{guid}/images/{gallery}","summary":"Delete all product images in gallery","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-images/deleteallproductimagesingallery","deprecated":false},{"title":"/api/products/{guid}/images/{gallery}","summary":"Product images update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/product-images/getproductimagesupdate","deprecated":false},{"title":"/api/products/{guid}/images/{gallery}","summary":"Product images insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-images/createproductimages","deprecated":false},{"title":"/api/products/{guid}/images/{gallery}/source","summary":"Product images source update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/product-images/updateproductimagessource","deprecated":false},{"title":"/api/products/{guid}/images/{gallery}/{imageName}","summary":"Delete one product image","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-images/deleteoneproductimage","deprecated":false}]}]}]}]}},{"type":"group","label":"Related products","link":"/shoptet-api/openapi/related-products","routeSlug":"/shoptet-api/openapi/related-products","items":[{"label":"List of product related products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/related-products/getlistofproductrelatedproducts","routeSlug":"/shoptet-api/openapi/related-products/getlistofproductrelatedproducts","metadata":{"seo":{"title":"List of product related products","description":"Returns list of related products related to product defined by guid,list is ordered by priority parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductRelatedProducts","name":"List of product related products","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of product related products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns list of related products related to product defined by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list is ordered by priority parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pair reciprocally"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settings > Product > Related and Alternative products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is enabled, list of"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"items will be enriched by items that has called product in own related"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"table."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"visible","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only visible products are returned (those, which does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visibility: hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/{guid}/relatedProducts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[{"name":"visible","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/{guid}/relatedProducts","href":"related-products/getlistofproductrelatedproducts","openApiOperationId":"getListOfProductRelatedProducts","summary":"List of product related products","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591"}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/related-products/getlistofproductrelatedproducts"}],"panels":[]}]},"httpPath":"/api/products/{guid}/relatedProducts"},{"label":"Add related product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/related-products/addrelatedproduct","routeSlug":"/shoptet-api/openapi/related-products/addrelatedproduct","metadata":{"seo":{"title":"Add related product","description":"This method add given product, defined with guid at the end of therelated product list. After product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addRelatedProduct","name":"Add related product","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add related product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method add given product, defined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the end of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"related product list. After product"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is successfully saved, complete list of related product is returned in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_628"}},"schemaId":"schema_628","pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/{guid}/relatedProducts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_628"}},"responseCodes":["200"],"pointer":"/api/products/{guid}/relatedProducts","href":"related-products/addrelatedproduct","openApiOperationId":"addRelatedProduct","summary":"Add related product","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_628","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_628"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591"}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/related-products/addrelatedproduct"}],"panels":[]}]},"httpPath":"/api/products/{guid}/relatedProducts"},{"label":"Set related products","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/related-products/setrelatedproducts","routeSlug":"/shoptet-api/openapi/related-products/setrelatedproducts","metadata":{"seo":{"title":"Set related products","description":"This method set given products (minimum 0, maximum 50), defined withguid to the related product list. After product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setRelatedProducts","name":"Set related products","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set related products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method set given products (minimum 0, maximum 50), defined with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the related product list. After product"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is successfully saved, complete list of related product is returned in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_629"}},"schemaId":"schema_629","pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/products/{guid}/relatedProducts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_629"}},"responseCodes":["200"],"pointer":"/api/products/{guid}/relatedProducts","href":"related-products/setrelatedproducts","openApiOperationId":"setRelatedProducts","summary":"Set related products","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_629","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_629"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591"}],"pointer":"/paths/~1api~1products~1{guid}~1relatedProducts/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/related-products/setrelatedproducts"}],"panels":[]}]},"httpPath":"/api/products/{guid}/relatedProducts"}],"content":{"contentType":"group","meta":{"name":"Related products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Related products","showPageActions":true},{"nodeType":"markdoc","content":"Managing related products."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/{guid}/relatedProducts","summary":"List of product related products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/related-products/getlistofproductrelatedproducts","deprecated":false},{"title":"/api/products/{guid}/relatedProducts","summary":"Add related product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/related-products/addrelatedproduct","deprecated":false},{"title":"/api/products/{guid}/relatedProducts","summary":"Set related products","prefix":{"name":"put","color":"put"},"badges":[],"link":"/related-products/setrelatedproducts","deprecated":false}]}]}]}]}},{"type":"group","label":"Product related files","link":"/shoptet-api/openapi/product-related-files","routeSlug":"/shoptet-api/openapi/product-related-files","items":[{"label":"Product related file link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-related-files/createrelatedfilelink","routeSlug":"/shoptet-api/openapi/product-related-files/createrelatedfilelink","metadata":{"seo":{"title":"Product related file link","description":"Linking related file from temporary storage to product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRelatedFileLink","name":"Product related file link","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1related-files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product related file link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Linking related file from temporary storage to product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1related-files/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1related-files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_630"}},"schemaId":"schema_630","pointer":"/paths/~1api~1products~1{guid}~1related-files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/{guid}/related-files","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_630"}},"responseCodes":["200"],"pointer":"/api/products/{guid}/related-files","href":"product-related-files/createrelatedfilelink","openApiOperationId":"createRelatedFileLink","summary":"Product related file link","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_630","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_630"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_631"}},"schemaId":"schema_631"}],"pointer":"/paths/~1api~1products~1{guid}~1related-files/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_631","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_631"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-related-files/createrelatedfilelink"}],"panels":[]}]},"httpPath":"/api/products/{guid}/related-files"},{"label":"Delete one product related file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-related-files/deleteoneproductrelatedfile","routeSlug":"/shoptet-api/openapi/product-related-files/deleteoneproductrelatedfile","metadata":{"seo":{"title":"Delete one product related file","description":"Deletes product's related file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOneProductRelatedFile","name":"Delete one product related file","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1related-files~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete one product related file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes product's related file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Product's guid","required":true,"example":"92d77e60-7481-11e8-8216-002590dad85e"},{"name":"id","in":"path","schemaId":"schema_522","description":"Related file id","required":true,"example":232}],"pointer":"/paths/~1api~1products~1{guid}~1related-files~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1{guid}~1related-files~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/{guid}/related-files/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"92d77e60-7481-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":232,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/products/{guid}/related-files/{id}","href":"product-related-files/deleteoneproductrelatedfile","openApiOperationId":"deleteOneProductRelatedFile","summary":"Delete one product related file","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-related-files/deleteoneproductrelatedfile"}],"panels":[]}]},"httpPath":"/api/products/{guid}/related-files/{id}"}],"content":{"contentType":"group","meta":{"name":"Product related files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product related files","showPageActions":true},{"nodeType":"markdoc","content":"Managing product related files."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/{guid}/related-files","summary":"Product related file link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-related-files/createrelatedfilelink","deprecated":false},{"title":"/api/products/{guid}/related-files/{id}","summary":"Delete one product related file","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-related-files/deleteoneproductrelatedfile","deprecated":false}]}]}]}]}},{"type":"group","label":"Product sets","link":"/shoptet-api/openapi/product-sets","routeSlug":"/shoptet-api/openapi/product-sets","items":[{"label":"Add item to product-set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-sets/additemtoproductset","routeSlug":"/shoptet-api/openapi/product-sets/additemtoproductset","metadata":{"seo":{"title":"Add item to product-set","description":"This method adding product defined by product variant code to the bundle (product set). Product defined in url by guid, must be set as type : product-set.When successfully saved, complete list of products in the set is returned in response.It is not allowed to add a product of the product-set type to an existing product set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addItemToProductSet","name":"Add item to product-set","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1set/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add item to product-set","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method adding product defined by product variant "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the bundle (product set). Product defined in url by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", must be set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When successfully saved, complete list of products in the set is returned in response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is not allowed to add a product of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type to an existing product set."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product guid - Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1set/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_632"}},"schemaId":"schema_632","pointer":"/paths/~1api~1products~1{guid}~1set/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/{guid}/set","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_632"}},"responseCodes":["200","422"],"pointer":"/api/products/{guid}/set","href":"product-sets/additemtoproductset","openApiOperationId":"addItemToProductSet","summary":"Add item to product-set","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_632","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_632"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_633"}},"schemaId":"schema_633"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1set/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1set/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1{guid}~1set/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_633","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_633"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1set/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1{guid}~1set/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-sets/additemtoproductset"}],"panels":[]}]},"httpPath":"/api/products/{guid}/set"},{"label":"Set product-set items","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/product-sets/setproductsetitems","routeSlug":"/shoptet-api/openapi/product-sets/setproductsetitems","metadata":{"seo":{"title":"Set product-set items","description":"This method set given products (minimum 0, maximum 50), defined by product variant code to the bundle of products (product-set).Product defined in url by guid, must be set as type : product-set. When successfully saved, complete list of products in the set is returned in response.It is not allowed to add a product of the product-set type to an existing product set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setProductSetItems","name":"Set product-set items","isWebhook":false,"pointer":"/paths/~1api~1products~1{guid}~1set/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set product-set items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method set given products (minimum 0, maximum 50), defined by product variant "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the bundle of products (product-set)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product defined in url by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", must be set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" : "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When successfully saved, complete list of products in the set is returned in response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is not allowed to add a product of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type to an existing product set."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product guid - Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1products~1{guid}~1set/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_634"}},"schemaId":"schema_634","pointer":"/paths/~1api~1products~1{guid}~1set/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/products/{guid}/set","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_634"}},"responseCodes":["200"],"pointer":"/api/products/{guid}/set","href":"product-sets/setproductsetitems","openApiOperationId":"setProductSetItems","summary":"Set product-set items","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_634","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_634"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_633"}},"schemaId":"schema_633"}],"pointer":"/paths/~1api~1products~1{guid}~1set/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_633","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_633"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-sets/setproductsetitems"}],"panels":[]}]},"httpPath":"/api/products/{guid}/set"}],"content":{"contentType":"group","meta":{"name":"Product sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product sets","showPageActions":true},{"nodeType":"markdoc","content":"Managing product sets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/{guid}/set","summary":"Add item to product-set","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-sets/additemtoproductset","deprecated":false},{"title":"/api/products/{guid}/set","summary":"Set product-set items","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-sets/setproductsetitems","deprecated":false}]}]}]}]}},{"type":"separator","label":"Delivery","content":null},{"type":"group","label":"Delivery","link":"/shoptet-api/openapi/delivery","routeSlug":"/shoptet-api/openapi/delivery","items":[{"label":"List of shipments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getlistofshipments","routeSlug":"/shoptet-api/openapi/delivery/getlistofshipments","metadata":{"seo":{"title":"List of shipments","description":"Returns a paginated list of shipments. Optionally filter by status or order code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfShipments","name":"List of shipments","isWebhook":false,"pointer":"/paths/~1api~1shipments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of shipments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of shipments. Optionally filter by status or order code."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering by shipment status. Optional. For possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/shipment-statuses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"example":"closed"},{"name":"orderCode","in":"query","schemaId":"schema_523","description":"filtering according to order code. Optional.","example":"2024000008"}],"pointer":"/paths/~1api~1shipments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","required":false,"example":"closed","schemaId":"schema_523"},{"name":"orderCode","in":"query","required":false,"example":"2024000008","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipments","href":"delivery/getlistofshipments","openApiOperationId":"getListOfShipments","summary":"List of shipments","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_635"}},"schemaId":"schema_635"}],"pointer":"/paths/~1api~1shipments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_635","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_635"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/getlistofshipments"}],"panels":[]}]},"httpPath":"/api/shipments"},{"label":"Creation of shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/createshipment","routeSlug":"/shoptet-api/openapi/delivery/createshipment","metadata":{"seo":{"title":"Creation of shipment","description":"In the packages field, you can send an object containing threecombinations of child fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShipment","name":"Creation of shipment","isWebhook":false,"pointer":"/paths/~1api~1shipments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, you can send an object containing three"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"combinations of child fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderPackagingId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"packaging"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"width"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"height"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"depth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_636"}},"schemaId":"schema_636","pointer":"/paths/~1api~1shipments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_636"}},"responseCodes":["201","422"],"pointer":"/api/shipments","href":"delivery/createshipment","openApiOperationId":"createShipment","summary":"Creation of shipment","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_636","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_636"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_637"}},"schemaId":"schema_637"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments/post/responses/422/content/application~1json; charset=utf-8/examples/example1"]}},"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments/post/responses/422/content/application~1json; charset=utf-8/examples/example1"]}],"pointer":"/paths/~1api~1shipments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_637","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_637"}}},{"code":"422","schemaId":"schema_638","exampleIds":["paths/~1api~1shipments/post/responses/422/content/application~1json; charset=utf-8/examples/example1"],"mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments/post/responses/422/content/application~1json; charset=utf-8/examples/example1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/createshipment"}],"panels":[]}]},"httpPath":"/api/shipments"},{"label":"Detail of shipment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getshipmentdetail","routeSlug":"/shoptet-api/openapi/delivery/getshipmentdetail","metadata":{"seo":{"title":"Detail of shipment","description":"Returns detail of a single shipment identified by its GUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipmentDetail","name":"Detail of shipment","isWebhook":false,"pointer":"/paths/~1api~1shipments~1{guid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of shipment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detail of a single shipment identified by its GUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Shipment GUID.","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1shipments~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipments~1{guid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/shipments/{guid}","href":"delivery/getshipmentdetail","openApiOperationId":"getShipmentDetail","summary":"Detail of shipment","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_639"}},"schemaId":"schema_639"},{"code":"404","description":"Not Found","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1{guid}/get/responses/404/content/application~1json; charset=utf-8/examples/example1"]}},"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1{guid}/get/responses/404/content/application~1json; charset=utf-8/examples/example1"]}],"pointer":"/paths/~1api~1shipments~1{guid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_639","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_639"}}},{"code":"404","schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1{guid}/get/responses/404/content/application~1json; charset=utf-8/examples/example1"],"mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1{guid}/get/responses/404/content/application~1json; charset=utf-8/examples/example1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/getshipmentdetail"}],"panels":[]}]},"httpPath":"/api/shipments/{guid}"},{"label":"Shipment cancellation request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/shipmentcancellationrequest","routeSlug":"/shoptet-api/openapi/delivery/shipmentcancellationrequest","metadata":{"seo":{"title":"Shipment cancellation request","description":"Requests cancellation of shipment. Cancellation request, if valid, isaccepted via API - it means we try to process this request within thecarrier. The final state of this request can be checked in the Shipmentdetail endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"shipmentCancellationRequest","name":"Shipment cancellation request","isWebhook":false,"pointer":"/paths/~1api~1shipments~1{guid}~1cancel-request/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment cancellation request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests cancellation of shipment. Cancellation request, if valid, is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepted via API - it means we try to process this request within the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"carrier. The final state of this request can be checked in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/delivery/getshipmentdetail"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Shipment GUID.","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1shipments~1{guid}~1cancel-request/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipments~1{guid}~1cancel-request/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/{guid}/cancel-request","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202","404","422"],"pointer":"/api/shipments/{guid}/cancel-request","href":"delivery/shipmentcancellationrequest","openApiOperationId":"shipmentCancellationRequest","summary":"Shipment cancellation request","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"404","description":"Not Found","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_640"}},"schemaId":"schema_640"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_641"}},"schemaId":"schema_641"}],"pointer":"/paths/~1api~1shipments~1{guid}~1cancel-request/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"404","schemaId":"schema_640","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_640"}}},{"code":"422","schemaId":"schema_641","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_641"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/shipmentcancellationrequest"}],"panels":[]}]},"httpPath":"/api/shipments/{guid}/cancel-request"},{"label":"Shipment shipping options by order code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getshipmentshippingoptionsbyordercode","routeSlug":"/shoptet-api/openapi/delivery/getshipmentshippingoptionsbyordercode","metadata":{"seo":{"title":"Shipment shipping options by order code","description":"Returns available shipping options for the given order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipmentShippingOptionsByOrderCode","name":"Shipment shipping options by order code","isWebhook":false,"pointer":"/paths/~1api~1shipments~1order~1{code}~1shipping-options/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipment shipping options by order code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns available shipping options for the given order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Order code.","required":true,"example":"2024000008"}],"pointer":"/paths/~1api~1shipments~1order~1{code}~1shipping-options/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipments~1order~1{code}~1shipping-options/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments/order/{code}/shipping-options","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2024000008","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/shipments/order/{code}/shipping-options","href":"delivery/getshipmentshippingoptionsbyordercode","openApiOperationId":"getShipmentShippingOptionsByOrderCode","summary":"Shipment shipping options by order code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_642"}},"schemaId":"schema_642"},{"code":"404","description":"Not Found","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_643"}},"schemaId":"schema_643"}],"pointer":"/paths/~1api~1shipments~1order~1{code}~1shipping-options/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_642","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_642"}}},{"code":"404","schemaId":"schema_643","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_643"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/getshipmentshippingoptionsbyordercode"}],"panels":[]}]},"httpPath":"/api/shipments/order/{code}/shipping-options"},{"label":"List of shipment carriers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getlistofshipmentcarriers","routeSlug":"/shoptet-api/openapi/delivery/getlistofshipmentcarriers","metadata":{"seo":{"title":"List of shipment carriers","description":"List of all active shipment carriers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfShipmentCarriers","name":"List of shipment carriers","isWebhook":false,"pointer":"/paths/~1api~1shipments~1carriers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of shipment carriers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of all active shipment carriers.\n\nThe list can be filtered according to carrier type (branch)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_523","description":"Carrier type (branch) filtering."}],"pointer":"/paths/~1api~1shipments~1carriers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipments~1carriers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments/carriers","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","required":false,"schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/shipments/carriers","href":"delivery/getlistofshipmentcarriers","openApiOperationId":"getListOfShipmentCarriers","summary":"List of shipment carriers","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_644"}},"schemaId":"schema_644"}],"pointer":"/paths/~1api~1shipments~1carriers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_644","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_644"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/getlistofshipmentcarriers"}],"panels":[]}]},"httpPath":"/api/shipments/carriers"},{"label":"Detail of shipment carrier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/getshipmentcarrierdetail","routeSlug":"/shoptet-api/openapi/delivery/getshipmentcarrierdetail","metadata":{"seo":{"title":"Detail of shipment carrier","description":"Returns detail of a single shipment carrier identified by its numeric ID and type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShipmentCarrierDetail","name":"Detail of shipment carrier","isWebhook":false,"pointer":"/paths/~1api~1shipments~1carriers~1{code}~1{type}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of shipment carrier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detail of a single shipment carrier identified by its numeric ID and type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Shipment carrier identifier.","required":true,"example":"110"},{"name":"type","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of shipment carrier, for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/shipment-carrier-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment carrier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"required":true,"example":"integration"}],"pointer":"/paths/~1api~1shipments~1carriers~1{code}~1{type}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipments~1carriers~1{code}~1{type}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipments/carriers/{code}/{type}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"110","schemaId":"schema_523"},{"name":"type","in":"path","required":true,"example":"integration","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/shipments/carriers/{code}/{type}","href":"delivery/getshipmentcarrierdetail","openApiOperationId":"getShipmentCarrierDetail","summary":"Detail of shipment carrier","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_645"}},"schemaId":"schema_645"},{"code":"404","description":"Not Found","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_646"}},"schemaId":"schema_646"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_647"}},"schemaId":"schema_647"}],"pointer":"/paths/~1api~1shipments~1carriers~1{code}~1{type}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_645","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_645"}}},{"code":"404","schemaId":"schema_646","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_646"}}},{"code":"422","schemaId":"schema_647","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_647"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/getshipmentcarrierdetail"}],"panels":[]}]},"httpPath":"/api/shipments/carriers/{code}/{type}"},{"label":"Close carrier shipments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/closecarriershipments","routeSlug":"/shoptet-api/openapi/delivery/closecarriershipments","metadata":{"seo":{"title":"Close carrier shipments","description":"Closes (moves to transportation stage) of all created shipments for given carrier ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"closeCarrierShipments","name":"Close carrier shipments","isWebhook":false,"pointer":"/paths/~1api~1shipments~1carriers~1{code}~1close/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close carrier shipments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Closes (moves to transportation stage) of all created shipments for\ngiven carrier ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Shipment carrier identifier.","required":true,"example":"110"}],"pointer":"/paths/~1api~1shipments~1carriers~1{code}~1close/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipments~1carriers~1{code}~1close/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/carriers/{code}/close","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"110","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202","404","422"],"pointer":"/api/shipments/carriers/{code}/close","href":"delivery/closecarriershipments","openApiOperationId":"closeCarrierShipments","summary":"Close carrier shipments","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted"},{"code":"404","description":"Not Found","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_648"}},"schemaId":"schema_648"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_649"}},"schemaId":"schema_649"}],"pointer":"/paths/~1api~1shipments~1carriers~1{code}~1close/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"404","schemaId":"schema_648","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_648"}}},{"code":"422","schemaId":"schema_649","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_649"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/closecarriershipments"}],"panels":[]}]},"httpPath":"/api/shipments/carriers/{code}/close"},{"label":"Creation of shipment by order code","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/delivery/createshipmentbyordercode","routeSlug":"/shoptet-api/openapi/delivery/createshipmentbyordercode","metadata":{"seo":{"title":"Creation of shipment by order code","description":"[DEPRECATED] Use POST /api/shipments instead. Creates a new shipment for the order identified by its code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShipmentByOrderCode","name":"Creation of shipment by order code","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1shipments~1order~1{code}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of shipment by order code","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[DEPRECATED] Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/shipments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Creates a new shipment for the order identified by its code."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"Order code.","required":true,"example":"2024000008"}],"pointer":"/paths/~1api~1shipments~1order~1{code}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipments~1order~1{code}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipments/order/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"2024000008","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["201","404","422"],"pointer":"/api/shipments/order/{code}","href":"delivery/createshipmentbyordercode","openApiOperationId":"createShipmentByOrderCode","summary":"Creation of shipment by order code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_637","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_637","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/201/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipments~1order~1{code}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_637","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_637","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/201/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_638","exampleIds":["paths/~1api~1shipments~1order~1{code}/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/delivery/createshipmentbyordercode"}],"panels":[]}]},"httpPath":"/api/shipments/order/{code}"}],"content":{"contentType":"group","meta":{"name":"Delivery"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery","showPageActions":true},{"nodeType":"markdoc","content":"Managing shipments and carriers in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipments","summary":"List of shipments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery/getlistofshipments","deprecated":false},{"title":"/api/shipments","summary":"Creation of shipment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/delivery/createshipment","deprecated":false},{"title":"/api/shipments/{guid}","summary":"Detail of shipment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery/getshipmentdetail","deprecated":false},{"title":"/api/shipments/{guid}/cancel-request","summary":"Shipment cancellation request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/delivery/shipmentcancellationrequest","deprecated":false},{"title":"/api/shipments/order/{code}/shipping-options","summary":"Shipment shipping options by order code","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery/getshipmentshippingoptionsbyordercode","deprecated":false},{"title":"/api/shipments/carriers","summary":"List of shipment carriers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery/getlistofshipmentcarriers","deprecated":false},{"title":"/api/shipments/carriers/{code}/{type}","summary":"Detail of shipment carrier","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delivery/getshipmentcarrierdetail","deprecated":false},{"title":"/api/shipments/carriers/{code}/close","summary":"Close carrier shipments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/delivery/closecarriershipments","deprecated":false},{"title":"/api/shipments/order/{code}","summary":"Creation of shipment by order code","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/delivery/createshipmentbyordercode","deprecated":true}]}]}]}]}},{"type":"separator","label":"Customers","content":null},{"type":"group","label":"Customers","link":"/shoptet-api/openapi/customers","routeSlug":"/shoptet-api/openapi/customers","items":[{"label":"List of customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getlistofcustomers","routeSlug":"/shoptet-api/openapi/customers/getlistofcustomers","metadata":{"seo":{"title":"List of customers","description":"Listing of customers. Supports the Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfCustomers","name":"List of customers","isWebhook":false,"pointer":"/paths/~1api~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing of customers. Supports the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filtering as per customer’s e-mails. An accurate match is searched"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for, regardless of capitalization."},"children":[]}]}]}],"example":"john@example.com"},{"name":"phone","in":"query","schemaId":"schema_523","description":"","example":"+420123456789"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 1000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1customers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","example":"john@example.com","schemaId":"schema_523"},{"name":"phone","in":"query","example":"+420123456789","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers","href":"customers/getlistofcustomers","openApiOperationId":"getListOfCustomers","summary":"List of customers","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_650"}},"schemaId":"schema_650"}],"pointer":"/paths/~1api~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_650","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_650"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getlistofcustomers"}],"panels":[]}]},"httpPath":"/api/customers"},{"label":"Creation of customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/createcustomer","routeSlug":"/shoptet-api/openapi/customers/createcustomer","metadata":{"seo":{"title":"Creation of customer","description":"Creation of customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomer","name":"Creation of customer","isWebhook":false,"pointer":"/paths/~1api~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressMandatoryFieldsCheck","in":"query","schemaId":"schema_529","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suppress checking if new customer has filled all mandatory fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from eshop settings "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settings -> Customers -> Mandatory fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppressing this check can cause worse customer experience in order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process for customers without all mandatory fields! However this can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be useful for migration customers from older system without all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"necessary fields."},"children":[]}]}]}],"example":false},{"name":"sendRegistrationEmail","in":"query","schemaId":"schema_529","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to true, registration emails are sent to the customer. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of email depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerGroup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" settings. If the group"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requires verification, the customer receives an email indicating"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that the registration is pending administrator approval (typically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group). Otherwise, the customer receives a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard registration confirmation email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer group has email notifications enabled for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"administrator, a copy of the email is also sent to them (again,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"typically for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group)."},"children":[]}]}]}],"example":false},{"name":"language","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the language in which the email should be sent to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer, provided that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendRegistrationEmail = true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Foreign Languages\" module is enabled on the current e-shop."},"children":[]}]}]}],"example":"cs"}],"pointer":"/paths/~1api~1customers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_651"}},"schemaId":"schema_651","pointer":"/paths/~1api~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customers","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"suppressMandatoryFieldsCheck","in":"query","example":false,"schemaId":"schema_529"},{"name":"sendRegistrationEmail","in":"query","required":false,"example":false,"schemaId":"schema_529"},{"name":"language","in":"query","required":false,"example":"cs","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_651"}},"responseCodes":["201"],"pointer":"/api/customers","href":"customers/createcustomer","openApiOperationId":"createCustomer","summary":"Creation of customer","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_651","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_651"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_652"}},"schemaId":"schema_652"}],"pointer":"/paths/~1api~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_652","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_652"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomer"}],"panels":[]}]},"httpPath":"/api/customers"},{"label":"List of all customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getlistofallcustomers","routeSlug":"/shoptet-api/openapi/customers/getlistofallcustomers","metadata":{"seo":{"title":"List of all customers","description":"Using this endpoint, you can get list of all customers with detailed info of each customer (like in Customer Detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllCustomers","name":"List of all customers","isWebhook":false,"pointer":"/paths/~1api~1customers~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all customers with detailed info of each customer (like in Customer Detail endpoint) asynchronously. See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each customer taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One customer in response has the same format as customer detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/customersnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"Export customers created after date","example":"2014-09-05T00:00:00+0100"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"Export customers created before date","example":"2019-09-05T00:00:00+0100"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"Export customers changed after date","example":"2017-01-01T00:00:00+0100"},{"name":"changeTimeTo","in":"query","schemaId":"schema_523","description":"Export customers changed before date","example":"2018-12-31T00:00:00+0100"}],"pointer":"/paths/~1api~1customers~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00+0100","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2019-09-05T00:00:00+0100","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2017-01-01T00:00:00+0100","schemaId":"schema_523"},{"name":"changeTimeTo","in":"query","example":"2018-12-31T00:00:00+0100","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/customers/snapshot","href":"customers/getlistofallcustomers","openApiOperationId":"getListOfAllCustomers","summary":"List of all customers","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1customers~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getlistofallcustomers"}],"panels":[]}]},"httpPath":"/api/customers/snapshot"},{"label":"Customer detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getcustomerdetail","routeSlug":"/shoptet-api/openapi/customers/getcustomerdetail","metadata":{"seo":{"title":"Customer detail","description":"Additional information about one customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomerDetail","name":"Customer detail","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Additional information about one customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"443cad54-73bc-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1customers~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"443cad54-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/customers/{guid}","href":"customers/getcustomerdetail","openApiOperationId":"getCustomerDetail","summary":"Customer detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_652"}},"schemaId":"schema_652"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1customers~1{guid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_652","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_652"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomerdetail"}],"panels":[]}]},"httpPath":"/api/customers/{guid}"},{"label":"Update of customer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/updatecustomer","routeSlug":"/shoptet-api/openapi/customers/updatecustomer","metadata":{"seo":{"title":"Update of customer","description":"Update of customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomer","name":"Update of customer","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"443cad54-73bc-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1customers~1{guid}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_653"}},"schemaId":"schema_653","pointer":"/paths/~1api~1customers~1{guid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/customers/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"443cad54-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_653"}},"responseCodes":["200","422"],"pointer":"/api/customers/{guid}","href":"customers/updatecustomer","openApiOperationId":"updateCustomer","summary":"Update of customer","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_653","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_653"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_652"}},"schemaId":"schema_652"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1customers~1{guid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_652","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_652"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/updatecustomer"}],"panels":[]}]},"httpPath":"/api/customers/{guid}"},{"label":"Deletion of customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/deletecustomer","routeSlug":"/shoptet-api/openapi/customers/deletecustomer","metadata":{"seo":{"title":"Deletion of customer","description":"Deletion of customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomer","name":"Deletion of customer","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"747fb32d-73bc-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1customers~1{guid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/customers/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"747fb32d-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}","href":"customers/deletecustomer","openApiOperationId":"deleteCustomer","summary":"Deletion of customer","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1customers~1{guid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/deletecustomer"}],"panels":[]}]},"httpPath":"/api/customers/{guid}"},{"label":"Last customer changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getlastcustomerchanges","routeSlug":"/shoptet-api/openapi/customers/getlastcustomerchanges","metadata":{"seo":{"title":"Last customer changes","description":"Returns the list of customers who have been changed (added/changed or deleted). The Endpoint is intendedto determine the changes after you have loaded the complete list of customers and you need to know, ifany of these has been changed (or added or deleted). Guaranteed history is 30 days, the older data aredeleted progressively."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLastCustomerChanges","name":"Last customer changes","isWebhook":false,"pointer":"/paths/~1api~1customers~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last customer changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of customers who have been changed (added/changed or deleted). The Endpoint is intended"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to determine the changes after you have loaded the complete list of customers and you need to know, if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any of these has been changed (or added or deleted). Guaranteed history is 30 days, the older data are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted progressively."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each customer in the log is only mentioned with their last change. For example, if the customer was modified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and then deleted, the log will only show information about the deletion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be filtered by changeType = edit/delete parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation is considered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action. So, when there is a new item created, it will be displayed like"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime from which up to the present we are interested in the changes. + in the time zone"},"children":[]}]}]}],"required":true,"example":"2018-01-01T01:01:01+02:00"},{"name":"changeType","in":"query","schemaId":"schema_523","description":"Returning only edit or delete type changed records","example":"edit"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1customers~1changes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/changes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":true,"example":"2018-01-01T01:01:01+02:00","schemaId":"schema_523"},{"name":"changeType","in":"query","required":false,"example":"edit","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/changes","href":"customers/getlastcustomerchanges","openApiOperationId":"getLastCustomerChanges","summary":"Last customer changes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_654"}},"schemaId":"schema_654"}],"pointer":"/paths/~1api~1customers~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_654","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_654"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getlastcustomerchanges"}],"panels":[]}]},"httpPath":"/api/customers/changes"},{"label":"List of customer regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customers/getlistofcustomerregions","routeSlug":"/shoptet-api/openapi/customers/getlistofcustomerregions","metadata":{"seo":{"title":"List of customer regions","description":"Returns the list of customer regions. The regions are ordered by id. The list is not paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfCustomerRegions","name":"List of customer regions","isWebhook":false,"pointer":"/paths/~1api~1customers~1regions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of customer regions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of customer regions. The regions are ordered by id. The list is not paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1regions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/regions","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/regions","href":"customers/getlistofcustomerregions","openApiOperationId":"getListOfCustomerRegions","summary":"List of customer regions","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_655"}},"schemaId":"schema_655"}],"pointer":"/paths/~1api~1customers~1regions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_655","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_655"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getlistofcustomerregions"}],"panels":[]}]},"httpPath":"/api/customers/regions"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":"Managing customers in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customers","summary":"List of customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getlistofcustomers","deprecated":false},{"title":"/api/customers","summary":"Creation of customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/createcustomer","deprecated":false},{"title":"/api/customers/snapshot","summary":"List of all customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getlistofallcustomers","deprecated":false},{"title":"/api/customers/{guid}","summary":"Customer detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getcustomerdetail","deprecated":false},{"title":"/api/customers/{guid}","summary":"Update of customer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customers/updatecustomer","deprecated":false},{"title":"/api/customers/{guid}","summary":"Deletion of customer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers/deletecustomer","deprecated":false},{"title":"/api/customers/changes","summary":"Last customer changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getlastcustomerchanges","deprecated":false},{"title":"/api/customers/regions","summary":"List of customer regions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/getlistofcustomerregions","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer accounts","link":"/shoptet-api/openapi/customer-accounts","routeSlug":"/shoptet-api/openapi/customer-accounts","items":[{"label":"List of customer accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/getlistofcustomeraccounts","routeSlug":"/shoptet-api/openapi/customer-accounts/getlistofcustomeraccounts","metadata":{"seo":{"title":"List of customer accounts","description":"List of customer accounts supports the Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfCustomerAccounts","name":"List of customer accounts","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of customer accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of customer accounts supports the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 1000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/{guid}/accounts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"}],"query":[{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/accounts","href":"customer-accounts/getlistofcustomeraccounts","openApiOperationId":"getListOfCustomerAccounts","summary":"List of customer accounts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_656"}},"schemaId":"schema_656"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_656","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_656"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-accounts/getlistofcustomeraccounts"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/accounts"},{"label":"Creation of customer account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/createcustomeraccount","routeSlug":"/shoptet-api/openapi/customer-accounts/createcustomeraccount","metadata":{"seo":{"title":"Creation of customer account","description":"Creation of customer account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomerAccount","name":"Creation of customer account","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of customer account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_657"}},"schemaId":"schema_657","pointer":"/paths/~1api~1customers~1{guid}~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customers/{guid}/accounts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_657"}},"responseCodes":["201"],"pointer":"/api/customers/{guid}/accounts","href":"customer-accounts/createcustomeraccount","openApiOperationId":"createCustomerAccount","summary":"Creation of customer account","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_657","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_657"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}},"schemaId":"schema_658"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_658","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-accounts/createcustomeraccount"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/accounts"},{"label":"Detail of customer account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/getdetailofcustomeraccount","routeSlug":"/shoptet-api/openapi/customer-accounts/getdetailofcustomeraccount","metadata":{"seo":{"title":"Detail of customer account","description":"Detail of customer account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfCustomerAccount","name":"Detail of customer account","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of customer account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"accountGuid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"460e4fbe-b7a9-11ea-82ab-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/{guid}/accounts/{accountGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"accountGuid","in":"path","required":true,"example":"460e4fbe-b7a9-11ea-82ab-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/accounts/{accountGuid}","href":"customer-accounts/getdetailofcustomeraccount","openApiOperationId":"getDetailOfCustomerAccount","summary":"Detail of customer account","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}},"schemaId":"schema_658"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_658","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-accounts/getdetailofcustomeraccount"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/accounts/{accountGuid}"},{"label":"Update of customer account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/updatecustomeraccount","routeSlug":"/shoptet-api/openapi/customer-accounts/updatecustomeraccount","metadata":{"seo":{"title":"Update of customer account","description":"Update of customer account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomerAccount","name":"Update of customer account","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of customer account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"accountGuid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"460e4fbe-b7a9-11ea-82ab-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_659"}},"schemaId":"schema_659","pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/customers/{guid}/accounts/{accountGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"accountGuid","in":"path","required":true,"example":"460e4fbe-b7a9-11ea-82ab-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_659"}},"responseCodes":["200"],"pointer":"/api/customers/{guid}/accounts/{accountGuid}","href":"customer-accounts/updatecustomeraccount","openApiOperationId":"updateCustomerAccount","summary":"Update of customer account","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_659","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_659"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}},"schemaId":"schema_658"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_658","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_658"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-accounts/updatecustomeraccount"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/accounts/{accountGuid}"},{"label":"Deletion of customer account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-accounts/deletecustomeraccount","routeSlug":"/shoptet-api/openapi/customer-accounts/deletecustomeraccount","metadata":{"seo":{"title":"Deletion of customer account","description":"Deletion of customer account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomerAccount","name":"Deletion of customer account","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of customer account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"accountGuid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"460e4fbe-b7a9-11ea-82ab-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/customers/{guid}/accounts/{accountGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"accountGuid","in":"path","required":true,"example":"460e4fbe-b7a9-11ea-82ab-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/accounts/{accountGuid}","href":"customer-accounts/deletecustomeraccount","openApiOperationId":"deleteCustomerAccount","summary":"Deletion of customer account","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1customers~1{guid}~1accounts~1{accountGuid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-accounts/deletecustomeraccount"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/accounts/{accountGuid}"}],"content":{"contentType":"group","meta":{"name":"Customer accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer accounts","showPageActions":true},{"nodeType":"markdoc","content":"Managing customer accounts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customers/{guid}/accounts","summary":"List of customer accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-accounts/getlistofcustomeraccounts","deprecated":false},{"title":"/api/customers/{guid}/accounts","summary":"Creation of customer account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-accounts/createcustomeraccount","deprecated":false},{"title":"/api/customers/{guid}/accounts/{accountGuid}","summary":"Detail of customer account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-accounts/getdetailofcustomeraccount","deprecated":false},{"title":"/api/customers/{guid}/accounts/{accountGuid}","summary":"Update of customer account","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customer-accounts/updatecustomeraccount","deprecated":false},{"title":"/api/customers/{guid}/accounts/{accountGuid}","summary":"Deletion of customer account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customer-accounts/deletecustomeraccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer delivery addresses","link":"/shoptet-api/openapi/customer-delivery-addresses","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses","items":[{"label":"List of customer delivery addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/gelistofcustomerdeliveryaddresses","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/gelistofcustomerdeliveryaddresses","metadata":{"seo":{"title":"List of customer delivery addresses","description":"List of customer delivery addresses, supports the Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"geListOfCustomerDeliveryAddresses","name":"List of customer delivery addresses","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of customer delivery addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of customer delivery addresses, supports the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 1000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/{guid}/delivery-addresses","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"}],"query":[{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/delivery-addresses","href":"customer-delivery-addresses/gelistofcustomerdeliveryaddresses","openApiOperationId":"geListOfCustomerDeliveryAddresses","summary":"List of customer delivery addresses","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_660"}},"schemaId":"schema_660"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_660","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_660"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-delivery-addresses/gelistofcustomerdeliveryaddresses"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/delivery-addresses"},{"label":"Creation of delivery address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/createdeliveryaddress","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/createdeliveryaddress","metadata":{"seo":{"title":"Creation of delivery address","description":"Creation of delivery address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDeliveryAddress","name":"Creation of delivery address","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of delivery address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_661"}},"schemaId":"schema_661","pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customers/{guid}/delivery-addresses","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_661"}},"responseCodes":["201","422"],"pointer":"/api/customers/{guid}/delivery-addresses","href":"customer-delivery-addresses/createdeliveryaddress","openApiOperationId":"createDeliveryAddress","summary":"Creation of delivery address","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_661","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_661"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662"}},"schemaId":"schema_662"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}~1delivery-addresses/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}~1delivery-addresses/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_662","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}~1delivery-addresses/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1customers~1{guid}~1delivery-addresses/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-delivery-addresses/createdeliveryaddress"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/delivery-addresses"},{"label":"Detail of customer delivery address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/getdetailofcustomerdeliveryaddress","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/getdetailofcustomerdeliveryaddress","metadata":{"seo":{"title":"Detail of customer delivery address","description":"Detail of customer delivery address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfCustomerDeliveryAddress","name":"Detail of customer delivery address","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of customer delivery address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"addressGuid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2592b624-b73f-11ea-8a73-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/{guid}/delivery-addresses/{addressGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"addressGuid","in":"path","required":true,"example":"2592b624-b73f-11ea-8a73-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/delivery-addresses/{addressGuid}","href":"customer-delivery-addresses/getdetailofcustomerdeliveryaddress","openApiOperationId":"getDetailOfCustomerDeliveryAddress","summary":"Detail of customer delivery address","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662"}},"schemaId":"schema_662"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_662","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-delivery-addresses/getdetailofcustomerdeliveryaddress"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/delivery-addresses/{addressGuid}"},{"label":"Update of customer delivery address","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/updatecustomerdeliveryaddress","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/updatecustomerdeliveryaddress","metadata":{"seo":{"title":"Update of customer delivery address","description":"Update of customer delivery address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomerDeliveryAddress","name":"Update of customer delivery address","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of customer delivery address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"addressGuid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2592b624-b73f-11ea-8a73-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_663"}},"schemaId":"schema_663","pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/customers/{guid}/delivery-addresses/{addressGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"addressGuid","in":"path","required":true,"example":"2592b624-b73f-11ea-8a73-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_663"}},"responseCodes":["200"],"pointer":"/api/customers/{guid}/delivery-addresses/{addressGuid}","href":"customer-delivery-addresses/updatecustomerdeliveryaddress","openApiOperationId":"updateCustomerDeliveryAddress","summary":"Update of customer delivery address","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_663","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_663"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662"}},"schemaId":"schema_662"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_662","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_662"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-delivery-addresses/updatecustomerdeliveryaddress"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/delivery-addresses/{addressGuid}"},{"label":"Deletion of customer delivery address","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-delivery-addresses/deletecustomerdeliveryaddress","routeSlug":"/shoptet-api/openapi/customer-delivery-addresses/deletecustomerdeliveryaddress","metadata":{"seo":{"title":"Deletion of customer delivery address","description":"Deletion of customer delivery address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomerDeliveryAddress","name":"Deletion of customer delivery address","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of customer delivery address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"addressGuid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"2592b624-b73f-11ea-8a73-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/customers/{guid}/delivery-addresses/{addressGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"addressGuid","in":"path","required":true,"example":"2592b624-b73f-11ea-8a73-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/delivery-addresses/{addressGuid}","href":"customer-delivery-addresses/deletecustomerdeliveryaddress","openApiOperationId":"deleteCustomerDeliveryAddress","summary":"Deletion of customer delivery address","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1customers~1{guid}~1delivery-addresses~1{addressGuid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-delivery-addresses/deletecustomerdeliveryaddress"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/delivery-addresses/{addressGuid}"}],"content":{"contentType":"group","meta":{"name":"Customer delivery addresses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer delivery addresses","showPageActions":true},{"nodeType":"markdoc","content":"Managing customer delivery addresses."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customers/{guid}/delivery-addresses","summary":"List of customer delivery addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-delivery-addresses/gelistofcustomerdeliveryaddresses","deprecated":false},{"title":"/api/customers/{guid}/delivery-addresses","summary":"Creation of delivery address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-delivery-addresses/createdeliveryaddress","deprecated":false},{"title":"/api/customers/{guid}/delivery-addresses/{addressGuid}","summary":"Detail of customer delivery address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-delivery-addresses/getdetailofcustomerdeliveryaddress","deprecated":false},{"title":"/api/customers/{guid}/delivery-addresses/{addressGuid}","summary":"Update of customer delivery address","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customer-delivery-addresses/updatecustomerdeliveryaddress","deprecated":false},{"title":"/api/customers/{guid}/delivery-addresses/{addressGuid}","summary":"Deletion of customer delivery address","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customer-delivery-addresses/deletecustomerdeliveryaddress","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer groups","link":"/shoptet-api/openapi/customer-groups","routeSlug":"/shoptet-api/openapi/customer-groups","items":[{"label":"List of customer groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-groups/getlistofcustomergroups","routeSlug":"/shoptet-api/openapi/customer-groups/getlistofcustomergroups","metadata":{"seo":{"title":"List of customer groups","description":"Returns list of customer groups ordered by priority. List is not paginated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfCustomerGroups","name":"List of customer groups","isWebhook":false,"pointer":"/paths/~1api~1customers~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of customer groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of customer groups ordered by priority. List is not paginated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/groups","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/groups","href":"customer-groups/getlistofcustomergroups","openApiOperationId":"getListOfCustomerGroups","summary":"List of customer groups","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_664"}},"schemaId":"schema_664"}],"pointer":"/paths/~1api~1customers~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_664","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_664"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-groups/getlistofcustomergroups"}],"panels":[]}]},"httpPath":"/api/customers/groups"},{"label":"Creation of customer group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-groups/createcustomergroup","routeSlug":"/shoptet-api/openapi/customer-groups/createcustomergroup","metadata":{"seo":{"title":"Creation of customer group","description":"Creates a new customer group with specified settings. The customer group name must be unique. Returns the full list of customer groups including the newly created one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomerGroup","name":"Creation of customer group","isWebhook":false,"pointer":"/paths/~1api~1customers~1groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of customer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new customer group with specified settings. The customer group name must be unique. Returns the full list of customer groups including the newly created one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To use wholesale features ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registrationAllowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tableLayout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullProfileRequired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module must be active in the e-shop."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_665"}},"schemaId":"schema_665","pointer":"/paths/~1api~1customers~1groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customers/groups","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_665"}},"responseCodes":["201","403","422"],"pointer":"/api/customers/groups","href":"customer-groups/createcustomergroup","openApiOperationId":"createCustomerGroup","summary":"Creation of customer group","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_665","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_665"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_666"}},"schemaId":"schema_666"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups/post/responses/403/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1customers~1groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_666","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_666"}}},{"code":"403","schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups/post/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-groups/createcustomergroup"}],"panels":[]}]},"httpPath":"/api/customers/groups"},{"label":"Deletion of customer group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-groups/deletecustomergroup","routeSlug":"/shoptet-api/openapi/customer-groups/deletecustomergroup","metadata":{"seo":{"title":"Deletion of customer group","description":"Is not possible to delete default customer group. Deletion of customer group will not delete customers assigned to this group, but they will be assigned to default customer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomerGroup","name":"Deletion of customer group","isWebhook":false,"pointer":"/paths/~1api~1customers~1groups~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of customer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Is not possible to delete default customer group. Deletion of customer group will not delete customers assigned to this group, but they will be assigned to default customer group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"","required":true,"example":1}],"pointer":"/paths/~1api~1customers~1groups~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1groups~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/customers/groups/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/customers/groups/{id}","href":"customer-groups/deletecustomergroup","openApiOperationId":"deleteCustomerGroup","summary":"Deletion of customer group","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_667"}},"schemaId":"schema_667"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/delete/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/delete/responses/422/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/delete/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1customers~1groups~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_667","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_667"}}},{"code":"404","schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/delete/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/delete/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/delete/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-groups/deletecustomergroup"}],"panels":[]}]},"httpPath":"/api/customers/groups/{id}"},{"label":"Update of customer group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-groups/updatecustomergroup","routeSlug":"/shoptet-api/openapi/customer-groups/updatecustomergroup","metadata":{"seo":{"title":"Update of customer group","description":"Updates an existing customer group with specified settings. Returns the full list of customer groups including the updated one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomerGroup","name":"Update of customer group","isWebhook":false,"pointer":"/paths/~1api~1customers~1groups~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of customer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing customer group with specified settings. Returns the full list of customer groups including the updated one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To use wholesale features ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registrationAllowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tableLayout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fullProfileRequired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module must be active in the e-shop."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"Customer group ID","required":true,"example":1}],"pointer":"/paths/~1api~1customers~1groups~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_523","description":"Specifies the language of updated customer group. If not provided, the default language of the e-shop will be used.\nThis parameter is relevant only if the \"Foreign Languages\" module is enabled on the current e-shop.","example":"cs"}],"pointer":"/paths/~1api~1customers~1groups~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1groups~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_668"}},"schemaId":"schema_668","pointer":"/paths/~1api~1customers~1groups~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/customers/groups/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[{"name":"language","in":"query","required":false,"example":"cs","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_668"}},"responseCodes":["200","403","404","422"],"pointer":"/api/customers/groups/{id}","href":"customer-groups/updatecustomergroup","openApiOperationId":"updateCustomerGroup","summary":"Update of customer group","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_668","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_668"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_666"}},"schemaId":"schema_666"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1customers~1groups~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_666","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_666"}}},{"code":"403","schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1customers~1groups~1{id}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-groups/updatecustomergroup"}],"panels":[]}]},"httpPath":"/api/customers/groups/{id}"}],"content":{"contentType":"group","meta":{"name":"Customer groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer groups","showPageActions":true},{"nodeType":"markdoc","content":"Managing customer groups in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customers/groups","summary":"List of customer groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-groups/getlistofcustomergroups","deprecated":false},{"title":"/api/customers/groups","summary":"Creation of customer group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-groups/createcustomergroup","deprecated":false},{"title":"/api/customers/groups/{id}","summary":"Deletion of customer group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customer-groups/deletecustomergroup","deprecated":false},{"title":"/api/customers/groups/{id}","summary":"Update of customer group","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customer-groups/updatecustomergroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer remarks","link":"/shoptet-api/openapi/customer-remarks","routeSlug":"/shoptet-api/openapi/customer-remarks","items":[{"label":"List of customer remarks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/getlistofcustomerremarks","routeSlug":"/shoptet-api/openapi/customer-remarks/getlistofcustomerremarks","metadata":{"seo":{"title":"List of customer remarks","description":"List of customer remarks, supports the Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfCustomerRemarks","name":"List of customer remarks","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1remarks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of customer remarks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of customer remarks, supports the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 1000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/{guid}/remarks","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"}],"query":[{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/remarks","href":"customer-remarks/getlistofcustomerremarks","openApiOperationId":"getListOfCustomerRemarks","summary":"List of customer remarks","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_669"}},"schemaId":"schema_669"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_669","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_669"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-remarks/getlistofcustomerremarks"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/remarks"},{"label":"Creation of customer remark","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/createcustomerremark","routeSlug":"/shoptet-api/openapi/customer-remarks/createcustomerremark","metadata":{"seo":{"title":"Creation of customer remark","description":"Creation of customer remark"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomerRemark","name":"Creation of customer remark","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1remarks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of customer remark","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_670"}},"schemaId":"schema_670","pointer":"/paths/~1api~1customers~1{guid}~1remarks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customers/{guid}/remarks","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_670"}},"responseCodes":["201"],"pointer":"/api/customers/{guid}/remarks","href":"customer-remarks/createcustomerremark","openApiOperationId":"createCustomerRemark","summary":"Creation of customer remark","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_670","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_670"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}},"schemaId":"schema_671"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_671","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-remarks/createcustomerremark"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/remarks"},{"label":"Detail of customer remark","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/getdetailofcustomerremark","routeSlug":"/shoptet-api/openapi/customer-remarks/getdetailofcustomerremark","metadata":{"seo":{"title":"Detail of customer remark","description":"Detail of customer remark"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfCustomerRemark","name":"Detail of customer remark","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of customer remark","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"id","in":"path","schemaId":"schema_523","description":"","required":true,"example":"1"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customers/{guid}/remarks/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":"1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/remarks/{id}","href":"customer-remarks/getdetailofcustomerremark","openApiOperationId":"getDetailOfCustomerRemark","summary":"Detail of customer remark","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}},"schemaId":"schema_671"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_671","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-remarks/getdetailofcustomerremark"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/remarks/{id}"},{"label":"Update of customer remark","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/updatecustomerremark","routeSlug":"/shoptet-api/openapi/customer-remarks/updatecustomerremark","metadata":{"seo":{"title":"Update of customer remark","description":"Update of customer remark"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomerRemark","name":"Update of customer remark","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of customer remark","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"id","in":"path","schemaId":"schema_523","description":"","required":true,"example":"1"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_672"}},"schemaId":"schema_672","pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/customers/{guid}/remarks/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":"1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_672"}},"responseCodes":["200"],"pointer":"/api/customers/{guid}/remarks/{id}","href":"customer-remarks/updatecustomerremark","openApiOperationId":"updateCustomerRemark","summary":"Update of customer remark","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_672","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_672"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}},"schemaId":"schema_671"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_671","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_671"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-remarks/updatecustomerremark"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/remarks/{id}"},{"label":"Deletion of customer remark","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/customer-remarks/deletecustomerremark","routeSlug":"/shoptet-api/openapi/customer-remarks/deletecustomerremark","metadata":{"seo":{"title":"Deletion of customer remark","description":"Deletion of customer remark"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomerRemark","name":"Deletion of customer remark","isWebhook":false,"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of customer remark","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91"},{"name":"id","in":"path","schemaId":"schema_523","description":"","required":true,"example":"1"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/customers/{guid}/remarks/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"45f0cc8c-b7a9-11ea-a7a1-08002746ad91","schemaId":"schema_523"},{"name":"id","in":"path","required":true,"example":"1","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/customers/{guid}/remarks/{id}","href":"customer-remarks/deletecustomerremark","openApiOperationId":"deleteCustomerRemark","summary":"Deletion of customer remark","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1customers~1{guid}~1remarks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customer-remarks/deletecustomerremark"}],"panels":[]}]},"httpPath":"/api/customers/{guid}/remarks/{id}"}],"content":{"contentType":"group","meta":{"name":"Customer remarks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer remarks","showPageActions":true},{"nodeType":"markdoc","content":"Managing customer remarks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customers/{guid}/remarks","summary":"List of customer remarks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-remarks/getlistofcustomerremarks","deprecated":false},{"title":"/api/customers/{guid}/remarks","summary":"Creation of customer remark","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customer-remarks/createcustomerremark","deprecated":false},{"title":"/api/customers/{guid}/remarks/{id}","summary":"Detail of customer remark","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customer-remarks/getdetailofcustomerremark","deprecated":false},{"title":"/api/customers/{guid}/remarks/{id}","summary":"Update of customer remark","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customer-remarks/updatecustomerremark","deprecated":false},{"title":"/api/customers/{guid}/remarks/{id}","summary":"Deletion of customer remark","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customer-remarks/deletecustomerremark","deprecated":false}]}]}]}]}},{"type":"separator","label":"Content","content":null},{"type":"group","label":"Articles","link":"/shoptet-api/openapi/articles","routeSlug":"/shoptet-api/openapi/articles","items":[{"label":"List of articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getlistofarticles","routeSlug":"/shoptet-api/openapi/articles/getlistofarticles","metadata":{"seo":{"title":"List of articles","description":"Returns a list of articles with basic info. Supports Paging"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfArticles","name":"List of articles","isWebhook":false,"pointer":"/paths/~1api~1articles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of articles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of articles with basic info. Supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 10.","example":10},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1articles/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/articles","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":10,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/articles","href":"articles/getlistofarticles","openApiOperationId":"getListOfArticles","summary":"List of articles","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_673"}},"schemaId":"schema_673"}],"pointer":"/paths/~1api~1articles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_673","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_673"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/getlistofarticles"}],"panels":[]}]},"httpPath":"/api/articles"},{"label":"Insert of article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/createarticle","routeSlug":"/shoptet-api/openapi/articles/createarticle","metadata":{"seo":{"title":"Insert of article","description":"Creates a new article."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createArticle","name":"Insert of article","isWebhook":false,"pointer":"/paths/~1api~1articles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert of article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new article."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674"}},"schemaId":"schema_674","pointer":"/paths/~1api~1articles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/articles","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_674"}},"responseCodes":["201","422"],"pointer":"/api/articles","href":"articles/createarticle","openApiOperationId":"createArticle","summary":"Insert of article","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_674","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_674"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675"}},"schemaId":"schema_675"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1articles/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1articles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_675","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1articles/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/createarticle"}],"panels":[]}]},"httpPath":"/api/articles"},{"label":"List of all articles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getlistallarticles","routeSlug":"/shoptet-api/openapi/articles/getlistallarticles","metadata":{"seo":{"title":"List of all articles","description":"Using this endpoint, you can get list of all articles with detailed info of each article (like in Detail of article endpoint) asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListAllArticles","name":"List of all articles","isWebhook":false,"pointer":"/paths/~1api~1articles~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all articles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all articles with detailed info of each article (like in Detail of article endpoint) asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each article taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One article in response has the same format as article detail response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/articlesnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Article snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"idFrom","in":"query","schemaId":"schema_522","description":"Export articles with id bigger or equal than given value","example":1},{"name":"idTo","in":"query","schemaId":"schema_522","description":"Export articles with id lower or equal than given value","example":10},{"name":"articleLanguage","in":"query","schemaId":"schema_523","description":"Export articles written in given language","example":"cs"},{"name":"publishDateFrom","in":"query","schemaId":"schema_523","description":"Export articles published after given datetime","example":"2014-09-05T00:00:00%2B0000"},{"name":"publishDateTo","in":"query","schemaId":"schema_523","description":"Export articles published before given datetime","example":"2014-11-05T00:00:00%2B0000"},{"name":"changeDateFrom","in":"query","schemaId":"schema_523","description":"Export articles updated after given datetime","example":"2014-09-05T00:00:00%2B0000"},{"name":"changeDateTo","in":"query","schemaId":"schema_523","description":"Export articles updated before given datetime","example":"2014-11-05T00:00:00%2B0000"},{"name":"visible","in":"query","schemaId":"schema_542","description":"Filtering according to document visibility","example":true}],"pointer":"/paths/~1api~1articles~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/articles/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"idFrom","in":"query","example":1,"schemaId":"schema_522"},{"name":"idTo","in":"query","example":10,"schemaId":"schema_522"},{"name":"articleLanguage","in":"query","example":"cs","schemaId":"schema_523"},{"name":"publishDateFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"publishDateTo","in":"query","example":"2014-11-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeDateFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeDateTo","in":"query","example":"2014-11-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"visible","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/articles/snapshot","href":"articles/getlistallarticles","openApiOperationId":"getListAllArticles","summary":"List of all articles","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1articles~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/getlistallarticles"}],"panels":[]}]},"httpPath":"/api/articles/snapshot"},{"label":"Detail of article","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getdetailofarticle","routeSlug":"/shoptet-api/openapi/articles/getdetailofarticle","metadata":{"seo":{"title":"Detail of article","description":"Returns a detail of the article."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfArticle","name":"Detail of article","isWebhook":false,"pointer":"/paths/~1api~1articles~1{articleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a detail of the article."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_522","description":"article ID","required":true,"example":1}],"pointer":"/paths/~1api~1articles~1{articleId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles~1{articleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/articles/{articleId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/articles/{articleId}","href":"articles/getdetailofarticle","openApiOperationId":"getDetailOfArticle","summary":"Detail of article","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675"}},"schemaId":"schema_675"}],"pointer":"/paths/~1api~1articles~1{articleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_675","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/getdetailofarticle"}],"panels":[]}]},"httpPath":"/api/articles/{articleId}"},{"label":"Update of article","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/updatearticle","routeSlug":"/shoptet-api/openapi/articles/updatearticle","metadata":{"seo":{"title":"Update of article","description":"Updates the article."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateArticle","name":"Update of article","isWebhook":false,"pointer":"/paths/~1api~1articles~1{articleId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the article."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_522","description":"article ID","required":true,"example":1}],"pointer":"/paths/~1api~1articles~1{articleId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles~1{articleId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_676"}},"schemaId":"schema_676","pointer":"/paths/~1api~1articles~1{articleId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/articles/{articleId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_676"}},"responseCodes":["200","422"],"pointer":"/api/articles/{articleId}","href":"articles/updatearticle","openApiOperationId":"updateArticle","summary":"Update of article","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_676","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_676"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675"}},"schemaId":"schema_675"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1{articleId}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1{articleId}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1articles~1{articleId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_675","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_675"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1{articleId}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1{articleId}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/updatearticle"}],"panels":[]}]},"httpPath":"/api/articles/{articleId}"},{"label":"Delete of article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/deletearticle","routeSlug":"/shoptet-api/openapi/articles/deletearticle","metadata":{"seo":{"title":"Delete of article","description":"Deletes the article."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteArticle","name":"Delete of article","isWebhook":false,"pointer":"/paths/~1api~1articles~1{articleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete of article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the article."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_522","description":"article ID","required":true,"example":1}],"pointer":"/paths/~1api~1articles~1{articleId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles~1{articleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/articles/{articleId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/articles/{articleId}","href":"articles/deletearticle","openApiOperationId":"deleteArticle","summary":"Delete of article","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1articles~1{articleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/deletearticle"}],"panels":[]}]},"httpPath":"/api/articles/{articleId}"},{"label":"List of article sections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getlistofarticlesections","routeSlug":"/shoptet-api/openapi/articles/getlistofarticlesections","metadata":{"seo":{"title":"List of article sections","description":"Returns a list of article sections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfArticleSections","name":"List of article sections","isWebhook":false,"pointer":"/paths/~1api~1articles~1sections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of article sections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of article sections."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/articles/sections","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/articles/sections","href":"articles/getlistofarticlesections","openApiOperationId":"getListOfArticleSections","summary":"List of article sections","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677"}},"schemaId":"schema_677"}],"pointer":"/paths/~1api~1articles~1sections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_677","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_677"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/getlistofarticlesections"}],"panels":[]}]},"httpPath":"/api/articles/sections"},{"label":"Insert of article section","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/createarticlesection","routeSlug":"/shoptet-api/openapi/articles/createarticlesection","metadata":{"seo":{"title":"Insert of article section","description":"Creates a new article section."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createArticleSection","name":"Insert of article section","isWebhook":false,"pointer":"/paths/~1api~1articles~1sections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert of article section","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new article section."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles~1sections/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_678"}},"schemaId":"schema_678","pointer":"/paths/~1api~1articles~1sections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/articles/sections","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_678"}},"responseCodes":["201","422"],"pointer":"/api/articles/sections","href":"articles/createarticlesection","openApiOperationId":"createArticleSection","summary":"Insert of article section","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_678","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_678"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_679"}},"schemaId":"schema_679"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1articles~1sections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_679","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_679"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/createarticlesection"}],"panels":[]}]},"httpPath":"/api/articles/sections"},{"label":"Detail of article section","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/getdetailofarticlesection","routeSlug":"/shoptet-api/openapi/articles/getdetailofarticlesection","metadata":{"seo":{"title":"Detail of article section","description":"Returns a detail of the article section."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfArticleSection","name":"Detail of article section","isWebhook":false,"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of article section","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a detail of the article section."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleSectionId","in":"path","schemaId":"schema_522","description":"article section ID","required":true,"example":1}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/articles/sections/{articleSectionId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"articleSectionId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/articles/sections/{articleSectionId}","href":"articles/getdetailofarticlesection","openApiOperationId":"getDetailOfArticleSection","summary":"Detail of article section","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_679"}},"schemaId":"schema_679"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_679","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_679"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/getdetailofarticlesection"}],"panels":[]}]},"httpPath":"/api/articles/sections/{articleSectionId}"},{"label":"Update of article section","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/updatearticlesection","routeSlug":"/shoptet-api/openapi/articles/updatearticlesection","metadata":{"seo":{"title":"Update of article section","description":"Updates the article section."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateArticleSection","name":"Update of article section","isWebhook":false,"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of article section","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the article section."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleSectionId","in":"path","schemaId":"schema_522","description":"article section ID","required":true,"example":123}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_680"}},"schemaId":"schema_680","pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/articles/sections/{articleSectionId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"articleSectionId","in":"path","required":true,"example":123,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_680"}},"responseCodes":["200","404"],"pointer":"/api/articles/sections/{articleSectionId}","href":"articles/updatearticlesection","openApiOperationId":"updateArticleSection","summary":"Update of article section","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_680","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_680"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_679"}},"schemaId":"schema_679"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_679","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_679"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/updatearticlesection"}],"panels":[]}]},"httpPath":"/api/articles/sections/{articleSectionId}"},{"label":"Deletion of article section","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/articles/deletearticlesection","routeSlug":"/shoptet-api/openapi/articles/deletearticlesection","metadata":{"seo":{"title":"Deletion of article section","description":"If the article section cannot be deleted, because it contains article(s), a409 code is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteArticleSection","name":"Deletion of article section","isWebhook":false,"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of article section","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the article section cannot be deleted, because it contains article(s), a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"409 code is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value allows deletion of article section including permanent deletion of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"article(s) having this section set as default."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleSectionId","in":"path","schemaId":"schema_522","description":"article section ID","required":true,"example":1}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_529","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allows deletion of article section that contains article(s) if set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/articles/sections/{articleSectionId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"articleSectionId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[{"name":"force","in":"query","required":false,"example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/articles/sections/{articleSectionId}","href":"articles/deletearticlesection","openApiOperationId":"deleteArticleSection","summary":"Deletion of article section","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/articles/deletearticlesection"}],"panels":[]}]},"httpPath":"/api/articles/sections/{articleSectionId}"}],"content":{"contentType":"group","meta":{"name":"Articles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Articles","showPageActions":true},{"nodeType":"markdoc","content":"Managing articles in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/articles","summary":"List of articles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/getlistofarticles","deprecated":false},{"title":"/api/articles","summary":"Insert of article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/articles/createarticle","deprecated":false},{"title":"/api/articles/snapshot","summary":"List of all articles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/getlistallarticles","deprecated":false},{"title":"/api/articles/{articleId}","summary":"Detail of article","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/getdetailofarticle","deprecated":false},{"title":"/api/articles/{articleId}","summary":"Update of article","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/articles/updatearticle","deprecated":false},{"title":"/api/articles/{articleId}","summary":"Delete of article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/articles/deletearticle","deprecated":false},{"title":"/api/articles/sections","summary":"List of article sections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/getlistofarticlesections","deprecated":false},{"title":"/api/articles/sections","summary":"Insert of article section","prefix":{"name":"post","color":"post"},"badges":[],"link":"/articles/createarticlesection","deprecated":false},{"title":"/api/articles/sections/{articleSectionId}","summary":"Detail of article section","prefix":{"name":"get","color":"get"},"badges":[],"link":"/articles/getdetailofarticlesection","deprecated":false},{"title":"/api/articles/sections/{articleSectionId}","summary":"Update of article section","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/articles/updatearticlesection","deprecated":false},{"title":"/api/articles/sections/{articleSectionId}","summary":"Deletion of article section","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/articles/deletearticlesection","deprecated":false}]}]}]}]}},{"type":"group","label":"Discussions","link":"/shoptet-api/openapi/discussions","routeSlug":"/shoptet-api/openapi/discussions","items":[{"label":"Discussion settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/getdiscussionsettings","routeSlug":"/shoptet-api/openapi/discussions/getdiscussionsettings","metadata":{"seo":{"title":"Discussion settings","description":"Discussion settings configured in the administration for each discussion context (product, article, section article): whether discussions are enabled, whether posts require authorization before publishing, whether only registered users may post, whether customers can reply to existing posts, and the pagination limit. Requires \"discussion\" module to be active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDiscussionSettings","name":"Discussion settings","isWebhook":false,"pointer":"/paths/~1api~1discussions~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discussion settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Discussion settings configured in the administration for each discussion context (product, article, section article): whether discussions are enabled, whether posts require authorization before publishing, whether only registered users may post, whether customers can reply to existing posts, and the pagination limit. Requires \"discussion\" module to be active."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discussions~1settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/discussions/settings","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/discussions/settings","href":"discussions/getdiscussionsettings","openApiOperationId":"getDiscussionSettings","summary":"Discussion settings","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_681"}},"schemaId":"schema_681"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions~1settings/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions~1settings/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1discussions~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_681","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_681"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions~1settings/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions~1settings/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discussions/getdiscussionsettings"}],"panels":[]}]},"httpPath":"/api/discussions/settings"},{"label":"List of discussion posts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/getlistofdiscussionposts","routeSlug":"/shoptet-api/openapi/discussions/getlistofdiscussionposts","metadata":{"seo":{"title":"List of discussion posts","description":"List of discussion posts, filterable by product GUID, article ID, page ID, customer GUID, author's e-mail, and creation date. Requires \"discussion\" module to be active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfDiscussionPosts","name":"List of discussion posts","isWebhook":false,"pointer":"/paths/~1api~1discussions-posts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of discussion posts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of discussion posts, filterable by product GUID, article ID, page ID, customer GUID, author's e-mail, and creation date. Requires \"discussion\" module to be active."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"productGuid","in":"query","schemaId":"schema_523","description":"guid of the product associated to discussion","example":"356eb81e-d966-11e0-b04f-57a43310b768"},{"name":"articleId","in":"query","schemaId":"schema_522","description":"identifier of the article associated to discussion","example":1},{"name":"pageId","in":"query","schemaId":"schema_522","description":"identifier of the page associated to discussion","example":1},{"name":"customerGuid","in":"query","schemaId":"schema_523","description":"guid of the customer associated to discussion","example":"443cad54-73bc-11e8-8216-002590dad85e"},{"name":"userEmail","in":"query","schemaId":"schema_523","description":"e-mail of the post's author","example":"john.doe@example.com"},{"name":"creationDateFrom","in":"query","schemaId":"schema_523","description":"date and time of the post creation - lower limit","example":"2022-12-24T16:00:00+02:00"},{"name":"creationDateTo","in":"query","schemaId":"schema_523","description":"date and time of the post creation - upper limit","example":"2022-12-31T23:59:59+02:00"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 100.","example":98},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1discussions-posts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discussions-posts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/discussions-posts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"productGuid","in":"query","example":"356eb81e-d966-11e0-b04f-57a43310b768","schemaId":"schema_523"},{"name":"articleId","in":"query","example":1,"schemaId":"schema_522"},{"name":"pageId","in":"query","example":1,"schemaId":"schema_522"},{"name":"customerGuid","in":"query","example":"443cad54-73bc-11e8-8216-002590dad85e","schemaId":"schema_523"},{"name":"userEmail","in":"query","example":"john.doe@example.com","schemaId":"schema_523"},{"name":"creationDateFrom","in":"query","example":"2022-12-24T16:00:00+02:00","schemaId":"schema_523"},{"name":"creationDateTo","in":"query","example":"2022-12-31T23:59:59+02:00","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":98,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/discussions-posts","href":"discussions/getlistofdiscussionposts","openApiOperationId":"getListOfDiscussionPosts","summary":"List of discussion posts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_682"}},"schemaId":"schema_682"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1discussions-posts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_682","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_682"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discussions/getlistofdiscussionposts"}],"panels":[]}]},"httpPath":"/api/discussions-posts"},{"label":"Creation of discussion posts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/creatediscussionposts","routeSlug":"/shoptet-api/openapi/discussions/creatediscussionposts","metadata":{"seo":{"title":"Creation of discussion posts","description":"Allows the creation of multiple discussion posts at once. The limit of items per request is defined to 100."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDiscussionPosts","name":"Creation of discussion posts","isWebhook":false,"pointer":"/paths/~1api~1discussions-posts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of discussion posts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the creation of multiple discussion posts at once. The limit of items per request is defined to 100."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discussions can be created for: products, articles, and pages. Requires \"discussion\" module to be active."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request is processing all the items. If there are some errors in item definitions, only these items are skipped and summarized in response errors. Valid items are processed even if some error items are skipped."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If at least one item is processed successfully, the response code is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If all the items contain errors, the response code is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If basic validation of items fails, the response code is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the request is not processed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discussions-posts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_683"}},"schemaId":"schema_683","pointer":"/paths/~1api~1discussions-posts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/discussions-posts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_683"}},"responseCodes":["201","400","403","422"],"pointer":"/api/discussions-posts","href":"discussions/creatediscussionposts","openApiOperationId":"createDiscussionPosts","summary":"Creation of discussion posts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_683","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_683"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_684"}},"schemaId":"schema_684"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/400/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/403/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1discussions-posts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_684","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_684"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discussions/creatediscussionposts"}],"panels":[]}]},"httpPath":"/api/discussions-posts"},{"label":"Discussion post update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/updatediscussionpost","routeSlug":"/shoptet-api/openapi/discussions/updatediscussionpost","metadata":{"seo":{"title":"Discussion post update","description":"Updates discussion post's data. Requires \"discussion\" module to be active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDiscussionPost","name":"Discussion post update","isWebhook":false,"pointer":"/paths/~1api~1discussions-posts~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discussion post update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates discussion post's data. Requires \"discussion\" module to be active."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"Discussion post id","required":true,"example":1}],"pointer":"/paths/~1api~1discussions-posts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discussions-posts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_685"}},"schemaId":"schema_685","pointer":"/paths/~1api~1discussions-posts~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/discussions-posts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_685"}},"responseCodes":["200","403","404","422"],"pointer":"/api/discussions-posts/{id}","href":"discussions/updatediscussionpost","openApiOperationId":"updateDiscussionPost","summary":"Discussion post update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_685","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_685"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_686"}},"schemaId":"schema_686"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1discussions-posts~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_686","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_686"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discussions/updatediscussionpost"}],"panels":[]}]},"httpPath":"/api/discussions-posts/{id}"},{"label":"Removal of discussion post","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discussions/deletediscussionbyid","routeSlug":"/shoptet-api/openapi/discussions/deletediscussionbyid","metadata":{"seo":{"title":"Removal of discussion post","description":"Deletes discussion post. Requires \"discussion\" module to be active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDiscussionById","name":"Removal of discussion post","isWebhook":false,"pointer":"/paths/~1api~1discussions-posts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removal of discussion post","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes discussion post. Requires \"discussion\" module to be active."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"ID of discussion","required":true,"example":1}],"pointer":"/paths/~1api~1discussions-posts~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discussions-posts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/discussions-posts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/discussions-posts/{id}","href":"discussions/deletediscussionbyid","openApiOperationId":"deleteDiscussionById","summary":"Removal of discussion post","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/delete/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1discussions-posts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discussions-posts~1{id}/delete/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discussions/deletediscussionbyid"}],"panels":[]}]},"httpPath":"/api/discussions-posts/{id}"}],"content":{"contentType":"group","meta":{"name":"Discussions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discussions","showPageActions":true},{"nodeType":"markdoc","content":"Managing discussions in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/discussions/settings","summary":"Discussion settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discussions/getdiscussionsettings","deprecated":false},{"title":"/api/discussions-posts","summary":"List of discussion posts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discussions/getlistofdiscussionposts","deprecated":false},{"title":"/api/discussions-posts","summary":"Creation of discussion posts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discussions/creatediscussionposts","deprecated":false},{"title":"/api/discussions-posts/{id}","summary":"Discussion post update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/discussions/updatediscussionpost","deprecated":false},{"title":"/api/discussions-posts/{id}","summary":"Removal of discussion post","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/discussions/deletediscussionbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Pages","link":"/shoptet-api/openapi/pages","routeSlug":"/shoptet-api/openapi/pages","items":[{"label":"List of pages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/getlistofpages","routeSlug":"/shoptet-api/openapi/pages/getlistofpages","metadata":{"seo":{"title":"List of pages","description":"Returns a list of pages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfPages","name":"List of pages","isWebhook":false,"pointer":"/paths/~1api~1pages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of pages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of pages."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1pages/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pages","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/pages","href":"pages/getlistofpages","openApiOperationId":"getListOfPages","summary":"List of pages","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_687"}},"schemaId":"schema_687"}],"pointer":"/paths/~1api~1pages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_687","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_687"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/getlistofpages"}],"panels":[]}]},"httpPath":"/api/pages"},{"label":"Insert of page","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/createpage","routeSlug":"/shoptet-api/openapi/pages/createpage","metadata":{"seo":{"title":"Insert of page","description":"Creates a new page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPage","name":"Insert of page","isWebhook":false,"pointer":"/paths/~1api~1pages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insert of page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_688"}},"schemaId":"schema_688","pointer":"/paths/~1api~1pages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/pages","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_688"}},"responseCodes":["201","422"],"pointer":"/api/pages","href":"pages/createpage","openApiOperationId":"createPage","summary":"Insert of page","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_688","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_688"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_689"}},"schemaId":"schema_689"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pages/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1pages/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1pages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_689","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_689"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1pages/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pages/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/createpage"}],"panels":[]}]},"httpPath":"/api/pages"},{"label":"Detail of page","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/getdetailofpage","routeSlug":"/shoptet-api/openapi/pages/getdetailofpage","metadata":{"seo":{"title":"Detail of page","description":"Returns a detail of the page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfPage","name":"Detail of page","isWebhook":false,"pointer":"/paths/~1api~1pages~1{pageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a detail of the page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_522","description":"page ID","required":true,"example":1}],"pointer":"/paths/~1api~1pages~1{pageId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pages~1{pageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/pages/{pageId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/pages/{pageId}","href":"pages/getdetailofpage","openApiOperationId":"getDetailOfPage","summary":"Detail of page","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_689"}},"schemaId":"schema_689"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1pages~1{pageId}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_617","exampleIds":["paths/~1api~1pages~1{pageId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1pages~1{pageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_689","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_689"}}},{"code":"404","schemaId":"schema_617","exampleIds":["paths/~1api~1pages~1{pageId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_617","exampleIds":["paths/~1api~1pages~1{pageId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/getdetailofpage"}],"panels":[]}]},"httpPath":"/api/pages/{pageId}"},{"label":"Delete of page","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/deletepage","routeSlug":"/shoptet-api/openapi/pages/deletepage","metadata":{"seo":{"title":"Delete of page","description":"Deletes the page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePage","name":"Delete of page","isWebhook":false,"pointer":"/paths/~1api~1pages~1{pageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete of page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_522","description":"page ID","required":true,"example":1}],"pointer":"/paths/~1api~1pages~1{pageId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pages~1{pageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/pages/{pageId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/pages/{pageId}","href":"pages/deletepage","openApiOperationId":"deletePage","summary":"Delete of page","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_619","exampleIds":["paths/~1api~1pages~1{pageId}/delete/responses/200/content/application~1json/example"]}},"schemaId":"schema_619","exampleIds":["paths/~1api~1pages~1{pageId}/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pages~1{pageId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1pages~1{pageId}/delete/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1pages~1{pageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_619","exampleIds":["paths/~1api~1pages~1{pageId}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_619","exampleIds":["paths/~1api~1pages~1{pageId}/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1pages~1{pageId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pages~1{pageId}/delete/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/deletepage"}],"panels":[]}]},"httpPath":"/api/pages/{pageId}"},{"label":"Update of page","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/pages/updatepage","routeSlug":"/shoptet-api/openapi/pages/updatepage","metadata":{"seo":{"title":"Update of page","description":"Updates the page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePage","name":"Update of page","isWebhook":false,"pointer":"/paths/~1api~1pages~1{pageId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of page","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the page."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pageId","in":"path","schemaId":"schema_522","description":"page ID","required":true,"example":1}],"pointer":"/paths/~1api~1pages~1{pageId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1pages~1{pageId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_690"}},"schemaId":"schema_690","pointer":"/paths/~1api~1pages~1{pageId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/pages/{pageId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"pageId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_690"}},"responseCodes":["200","404"],"pointer":"/api/pages/{pageId}","href":"pages/updatepage","openApiOperationId":"updatePage","summary":"Update of page","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_690","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_690"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_689"}},"schemaId":"schema_689"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pages~1{pageId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1pages~1{pageId}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1pages~1{pageId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_689","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_689"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1pages~1{pageId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1pages~1{pageId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pages/updatepage"}],"panels":[]}]},"httpPath":"/api/pages/{pageId}"}],"content":{"contentType":"group","meta":{"name":"Pages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pages","showPageActions":true},{"nodeType":"markdoc","content":"Managing pages in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/pages","summary":"List of pages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/getlistofpages","deprecated":false},{"title":"/api/pages","summary":"Insert of page","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pages/createpage","deprecated":false},{"title":"/api/pages/{pageId}","summary":"Detail of page","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pages/getdetailofpage","deprecated":false},{"title":"/api/pages/{pageId}","summary":"Delete of page","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pages/deletepage","deprecated":false},{"title":"/api/pages/{pageId}","summary":"Update of page","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pages/updatepage","deprecated":false}]}]}]}]}},{"type":"group","label":"Reviews","link":"/shoptet-api/openapi/reviews","routeSlug":"/shoptet-api/openapi/reviews","items":[{"label":"Reviews settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/getreviewssettings","routeSlug":"/shoptet-api/openapi/reviews/getreviewssettings","metadata":{"seo":{"title":"Reviews settings","description":"Returns the reviews settings configured in the administration Rating Settings page, covering both product reviews and store rating. This endpoint is available only when the 'Rating' module is active. The endpoint is read-only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReviewsSettings","name":"Reviews settings","isWebhook":false,"pointer":"/paths/~1api~1reviews~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reviews settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the reviews settings configured in the administration Rating Settings page, covering both product reviews and store rating. This endpoint is available only when the 'Rating' module is active. The endpoint is read-only."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1reviews~1settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/reviews/settings","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/reviews/settings","href":"reviews/getreviewssettings","openApiOperationId":"getReviewsSettings","summary":"Reviews settings","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_691"}},"schemaId":"schema_691"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1settings/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1settings/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1reviews~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_691","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_691"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1settings/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1settings/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/getreviewssettings"}],"panels":[]}]},"httpPath":"/api/reviews/settings"},{"label":"List of products reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/getlistofproductsreviews","routeSlug":"/shoptet-api/openapi/reviews/getlistofproductsreviews","metadata":{"seo":{"title":"List of products reviews","description":"Returns list of product's reviews."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductsReviews","name":"List of products reviews","isWebhook":false,"pointer":"/paths/~1api~1reviews~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of products reviews","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of product's reviews."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dateFrom","in":"query","schemaId":"schema_523","description":"Filter reviews with creation date after date","example":"2019-09-05T00:00:00%2B0000"},{"name":"dateTo","in":"query","schemaId":"schema_523","description":"Filter reviews with creation date before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"Filter reviews changed after this date (included)","example":"2019-09-05T00:00:00%2B0000"},{"name":"productGuid","in":"query","schemaId":"schema_523","description":"Product identifier to filter reviews by.","example":"91670fd3-5b3d-11e7-819d-002590dc5efc"},{"name":"orderCode","in":"query","schemaId":"schema_523","description":"Order identifier to filter reviews by.","example":"2011000002"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1reviews~1products/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1reviews~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/reviews/products","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"dateFrom","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"dateTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"changeTimeFrom","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"productGuid","in":"query","example":"91670fd3-5b3d-11e7-819d-002590dc5efc","schemaId":"schema_523"},{"name":"orderCode","in":"query","example":"2011000002","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/reviews/products","href":"reviews/getlistofproductsreviews","openApiOperationId":"getListOfProductsReviews","summary":"List of products reviews","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_692"}},"schemaId":"schema_692"}],"pointer":"/paths/~1api~1reviews~1products/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_692","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_692"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/getlistofproductsreviews"}],"panels":[]}]},"httpPath":"/api/reviews/products"},{"label":"Product review insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/createproductreview","routeSlug":"/shoptet-api/openapi/reviews/createproductreview","metadata":{"seo":{"title":"Product review insertion","description":"Importing product reviews with option to backdate them"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductReview","name":"Product review insertion","isWebhook":false,"pointer":"/paths/~1api~1reviews~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product review insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Importing product reviews with option to backdate them"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1reviews~1products/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_693"}},"schemaId":"schema_693","pointer":"/paths/~1api~1reviews~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/reviews/products","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_693"}},"responseCodes":["201","403","404","422"],"pointer":"/api/reviews/products","href":"reviews/createproductreview","openApiOperationId":"createProductReview","summary":"Product review insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_693","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_693"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_694"}},"schemaId":"schema_694"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1reviews~1products/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_694","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_694"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/createproductreview"}],"panels":[]}]},"httpPath":"/api/reviews/products"},{"label":"Product review update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/updateproductreview","routeSlug":"/shoptet-api/openapi/reviews/updateproductreview","metadata":{"seo":{"title":"Product review update","description":"Updates the product review. This endpoint is available only when the 'Rating' module is active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductReview","name":"Product review update","isWebhook":false,"pointer":"/paths/~1api~1reviews~1products~1{reviewId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product review update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the product review. This endpoint is available only when the 'Rating' module is active."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reviewId","in":"path","schemaId":"schema_522","description":"review ID","required":true,"example":1}],"pointer":"/paths/~1api~1reviews~1products~1{reviewId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1reviews~1products~1{reviewId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_695"}},"schemaId":"schema_695","pointer":"/paths/~1api~1reviews~1products~1{reviewId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/reviews/products/{reviewId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"reviewId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_695"}},"responseCodes":["200","403","404"],"pointer":"/api/reviews/products/{reviewId}","href":"reviews/updateproductreview","openApiOperationId":"updateProductReview","summary":"Product review update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_695","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_695"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_694"}},"schemaId":"schema_694"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products~1{reviewId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products~1{reviewId}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products~1{reviewId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products~1{reviewId}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1reviews~1products~1{reviewId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_694","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_694"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products~1{reviewId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products~1{reviewId}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products~1{reviewId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1products~1{reviewId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/updateproductreview"}],"panels":[]}]},"httpPath":"/api/reviews/products/{reviewId}"},{"label":"List of project reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/getlistofprojectreviews","routeSlug":"/shoptet-api/openapi/reviews/getlistofprojectreviews","metadata":{"seo":{"title":"List of project reviews","description":"Returns a list of the project reviews. This endpoint is available only when the 'Rating' module is active. Also, the project must have store ratings enabled in the administration settings.The endpoint supports Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProjectReviews","name":"List of project reviews","isWebhook":false,"pointer":"/paths/~1api~1reviews~1project/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of project reviews","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of the project reviews. This endpoint is available only when the 'Rating' module is active. Also, the project must have store ratings enabled in the administration settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 100. Max value is 200.","example":100},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1reviews~1project/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1reviews~1project/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/reviews/project","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":100,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/reviews/project","href":"reviews/getlistofprojectreviews","openApiOperationId":"getListOfProjectReviews","summary":"List of project reviews","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_696"}},"schemaId":"schema_696"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1reviews~1project/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_696","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_696"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/getlistofprojectreviews"}],"panels":[]}]},"httpPath":"/api/reviews/project"},{"label":"Project review insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/createprojectreview","routeSlug":"/shoptet-api/openapi/reviews/createprojectreview","metadata":{"seo":{"title":"Project review insertion","description":"Creates a new project review. This endpoint is available only when the 'Rating' module is active. Also, the e-shop must have store ratings enabled in the administration settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProjectReview","name":"Project review insertion","isWebhook":false,"pointer":"/paths/~1api~1reviews~1project/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project review insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new project review. This endpoint is available only when the 'Rating' module is active. Also, the e-shop must have store ratings enabled in the administration settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1reviews~1project/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_697"}},"schemaId":"schema_697","pointer":"/paths/~1api~1reviews~1project/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/reviews/project","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_697"}},"responseCodes":["201","403","404","422"],"pointer":"/api/reviews/project","href":"reviews/createprojectreview","openApiOperationId":"createProjectReview","summary":"Project review insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_697","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_697"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_698"}},"schemaId":"schema_698"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1reviews~1project/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_698","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_698"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/createprojectreview"}],"panels":[]}]},"httpPath":"/api/reviews/project"},{"label":"Project review update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/reviews/updateprojectreview","routeSlug":"/shoptet-api/openapi/reviews/updateprojectreview","metadata":{"seo":{"title":"Project review update","description":"Updates the project review. This endpoint is available only when the 'Rating' module is active. Also, the project must have store ratings enabled in the administration settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProjectReview","name":"Project review update","isWebhook":false,"pointer":"/paths/~1api~1reviews~1project~1{reviewId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project review update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the project review. This endpoint is available only when the 'Rating' module is active. Also, the project must have store ratings enabled in the administration settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reviewId","in":"path","schemaId":"schema_522","description":"review ID","required":true,"example":1}],"pointer":"/paths/~1api~1reviews~1project~1{reviewId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1reviews~1project~1{reviewId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_699"}},"schemaId":"schema_699","pointer":"/paths/~1api~1reviews~1project~1{reviewId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/reviews/project/{reviewId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"reviewId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_699"}},"responseCodes":["200","403","404"],"pointer":"/api/reviews/project/{reviewId}","href":"reviews/updateprojectreview","openApiOperationId":"updateProjectReview","summary":"Project review update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_699","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_699"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_698"}},"schemaId":"schema_698"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project~1{reviewId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project~1{reviewId}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project~1{reviewId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project~1{reviewId}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1reviews~1project~1{reviewId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_698","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_698"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project~1{reviewId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project~1{reviewId}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project~1{reviewId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1reviews~1project~1{reviewId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/updateprojectreview"}],"panels":[]}]},"httpPath":"/api/reviews/project/{reviewId}"}],"content":{"contentType":"group","meta":{"name":"Reviews"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reviews","showPageActions":true},{"nodeType":"markdoc","content":"Managing reviews in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/reviews/settings","summary":"Reviews settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviews/getreviewssettings","deprecated":false},{"title":"/api/reviews/products","summary":"List of products reviews","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviews/getlistofproductsreviews","deprecated":false},{"title":"/api/reviews/products","summary":"Product review insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reviews/createproductreview","deprecated":false},{"title":"/api/reviews/products/{reviewId}","summary":"Product review update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/reviews/updateproductreview","deprecated":false},{"title":"/api/reviews/project","summary":"List of project reviews","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviews/getlistofprojectreviews","deprecated":false},{"title":"/api/reviews/project","summary":"Project review insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reviews/createprojectreview","deprecated":false},{"title":"/api/reviews/project/{reviewId}","summary":"Project review update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/reviews/updateprojectreview","deprecated":false}]}]}]}]}},{"type":"group","label":"Templates","link":"/shoptet-api/openapi/templates","routeSlug":"/shoptet-api/openapi/templates","items":[{"label":"Listing of codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/templates/getlistingofhtmlcodes","routeSlug":"/shoptet-api/openapi/templates/getlistingofhtmlcodes","metadata":{"seo":{"title":"Listing of codes","description":"This lists currently defined HTML codes for this addon, in all possiblelocations. Each addon sees only “its own” codes,it cannot see other codes of other addons, not even from the same developer. Also, it does not see the code inserted within the administration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListingOfHtmlCodes","name":"Listing of codes","isWebhook":false,"pointer":"/paths/~1api~1template-include/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Listing of codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This lists currently defined HTML codes for this addon, in all possible"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"locations. Each addon sees only “its own” codes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it cannot see other codes of other addons, not even from the same developer. Also, it does not see the code inserted within the administration."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1template-include/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/template-include","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/template-include","href":"templates/getlistingofhtmlcodes","openApiOperationId":"getListingOfHtmlCodes","summary":"Listing of codes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_700"}},"schemaId":"schema_700"}],"pointer":"/paths/~1api~1template-include/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_700","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_700"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/getlistingofhtmlcodes"}],"panels":[]}]},"httpPath":"/api/template-include"},{"label":"Inserting and editing codes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/templates/createandedithtmlcodes","routeSlug":"/shoptet-api/openapi/templates/createandedithtmlcodes","metadata":{"seo":{"title":"Inserting and editing codes","description":"This adds new or changes the current (if exists) HTML code. It ispossible to enter 1-3 changes at a time (typically"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAndEditHtmlCodes","name":"Inserting and editing codes","isWebhook":false,"pointer":"/paths/~1api~1template-include/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inserting and editing codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This adds new or changes the current (if exists) HTML code. It is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"possible to enter 1-3 changes at a time (typically"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 possible locations). If the value already exists, it is simply"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overwritten. The limit for HTML code is 8192 characters. In case that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the requirements fail, the detailed information is returned in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1template-include/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_701"}},"schemaId":"schema_701","pointer":"/paths/~1api~1template-include/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/template-include","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_701"}},"responseCodes":["200","400"],"pointer":"/api/template-include","href":"templates/createandedithtmlcodes","openApiOperationId":"createAndEditHtmlCodes","summary":"Inserting and editing codes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_701","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_701"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_700"}},"schemaId":"schema_700"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1template-include/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1template-include/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1template-include/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_700","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_700"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1template-include/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1template-include/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/createandedithtmlcodes"}],"panels":[]}]},"httpPath":"/api/template-include"},{"label":"Removal of code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/templates/deletehtmlcode","routeSlug":"/shoptet-api/openapi/templates/deletehtmlcode","metadata":{"seo":{"title":"Removal of code","description":"This call can be used to delete the existing code from the givenlocation. if the code for the given location (position) does notexist, the"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteHtmlCode","name":"Removal of code","isWebhook":false,"pointer":"/paths/~1api~1template-include~1{location}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removal of code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call can be used to delete the existing code from the given"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location. if the code for the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (position) does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exist, the"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 NOT FOUND"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location","in":"path","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"common-header"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"common-footer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order-confirmed"},"children":[]}]}]}],"required":true,"example":"common-header"}],"pointer":"/paths/~1api~1template-include~1{location}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1template-include~1{location}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/template-include/{location}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"location","in":"path","required":true,"example":"common-header","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/template-include/{location}","href":"templates/deletehtmlcode","openApiOperationId":"deleteHtmlCode","summary":"Removal of code","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1template-include~1{location}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/deletehtmlcode"}],"panels":[]}]},"httpPath":"/api/template-include/{location}"}],"content":{"contentType":"group","meta":{"name":"Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Templates","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the last Shoptet version, it is not possible to change the e-shop"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"design via API. However, it is possible to include HTML codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"into previously defined places. This enables the code or link to a file"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"containing additional CSS styles or JavaScript codes to be entered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The same functionality is now included within the e-shop administration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/admin/html-kody/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HTML code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are 3 possible locations, where HTML codes can be inserted:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"common-header"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the code will be inserted into each e-shop page header"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"common-footer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the code will be inserted into each e-shop page foot"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(before end "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order-confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the code will be inserted in the page confirming the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order (the \"thank you page\")"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inserted codes may come from 3 sources, and they are included in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"following order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Codes from addons (the addon defines HTML codes to be inserted for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"anybody, who installs the addon). If there are more of these, they are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inserted progressively, the order cannot be relied upon."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Codes entered via API. Each addon can insert only one code into each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location. If there are more of these addons, the codes will be inserted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"progressively, one after another, the order cannot be relied upon."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code entered in the administration GUI ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/admin/html-kody/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HTML code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab)."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/template-include","summary":"Listing of codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/getlistingofhtmlcodes","deprecated":false},{"title":"/api/template-include","summary":"Inserting and editing codes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates/createandedithtmlcodes","deprecated":false},{"title":"/api/template-include/{location}","summary":"Removal of code","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/templates/deletehtmlcode","deprecated":false}]}]}]}]}},{"type":"separator","label":"Marketing","content":null},{"type":"group","label":"Abandoned carts","link":"/shoptet-api/openapi/abandoned-carts","routeSlug":"/shoptet-api/openapi/abandoned-carts","items":[{"label":"List of all abandoned carts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/abandoned-carts/getlistofallabandonedcarts","routeSlug":"/shoptet-api/openapi/abandoned-carts/getlistofallabandonedcarts","metadata":{"seo":{"title":"List of all abandoned carts","description":"Using this endpoint, you can get list of all abandoned carts asynchronously. See how Asynchronous requests work on our developer's portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllAbandonedCarts","name":"List of all abandoned carts","isWebhook":false,"pointer":"/paths/~1api~1abandoned-carts~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all abandoned carts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all abandoned carts asynchronously. See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each abandoned cart taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visitTimeFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visitTimeTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to request a full snapshot on the first call, then request only carts last visited since the previous run (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visitTimeFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to yesterday) for daily incremental updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"visitTimeFrom","in":"query","schemaId":"schema_523","description":"Export abandoned carts last visited after date","example":"2026-07-21T00:00:00+0200"},{"name":"visitTimeTo","in":"query","schemaId":"schema_523","description":"Export abandoned carts last visited before date","example":"2026-07-22T00:00:00+0200"}],"pointer":"/paths/~1api~1abandoned-carts~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1abandoned-carts~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/abandoned-carts/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"visitTimeFrom","in":"query","example":"2026-07-21T00:00:00+0200","schemaId":"schema_523"},{"name":"visitTimeTo","in":"query","example":"2026-07-22T00:00:00+0200","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/abandoned-carts/snapshot","href":"abandoned-carts/getlistofallabandonedcarts","openApiOperationId":"getListOfAllAbandonedCarts","summary":"List of all abandoned carts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1abandoned-carts~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/abandoned-carts/getlistofallabandonedcarts"}],"panels":[]}]},"httpPath":"/api/abandoned-carts/snapshot"}],"content":{"contentType":"group","meta":{"name":"Abandoned carts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Abandoned carts","showPageActions":true},{"nodeType":"markdoc","content":"Managing abandoned carts in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/abandoned-carts/snapshot","summary":"List of all abandoned carts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/abandoned-carts/getlistofallabandonedcarts","deprecated":false}]}]}]}]}},{"type":"group","label":"Discount coupons","link":"/shoptet-api/openapi/discount-coupons","routeSlug":"/shoptet-api/openapi/discount-coupons","items":[{"label":"List of discount coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/getlistofdiscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/getlistofdiscountcoupons","metadata":{"seo":{"title":"List of discount coupons","description":"List of discount coupons within the e-shop. The list is paged at 1000 coupons.The discount coupons can be filtered according to the date of creation, validity,repeatability of usage or their template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfDiscountCoupons","name":"List of discount coupons","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of discount coupons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of discount coupons within the e-shop. The list is paged at 1000 coupons."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The discount coupons can be filtered according to the date of creation, validity,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeatability of usage or their template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If absolute price is used, the amount is interpreted with the default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT rate of the eshop (in administration:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings » Basic Settings » Tax Classes). It can be retrieved using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint Eshop Info, array "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxClasses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The same is valid for minimum price."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"template","in":"query","schemaId":"schema_523","description":"template GUID","example":"01b39ad8-8686-11e9-968c-08002774f818"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"date and time of coupon creation - lower limit","example":"2018-05-28T14:17:00+02:00"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"date and time of coupon creation - upper limit","example":"2028-05-28T14:17:00+02:00"},{"name":"reusable","in":"query","schemaId":"schema_542","description":"is the discount coupon reusable?","example":true},{"name":"validFrom","in":"query","schemaId":"schema_523","description":"date of discount coupon validity - lower limit","example":"2018-05-28"},{"name":"validTo","in":"query","schemaId":"schema_523","description":"date of discount coupon validity - upper limit","example":"2028-05-28"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 1000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1discount-coupons/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/discount-coupons","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"template","in":"query","example":"01b39ad8-8686-11e9-968c-08002774f818","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2018-05-28T14:17:00+02:00","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2028-05-28T14:17:00+02:00","schemaId":"schema_523"},{"name":"reusable","in":"query","example":true,"schemaId":"schema_542"},{"name":"validFrom","in":"query","example":"2018-05-28","schemaId":"schema_523"},{"name":"validTo","in":"query","example":"2028-05-28","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/discount-coupons","href":"discount-coupons/getlistofdiscountcoupons","openApiOperationId":"getListOfDiscountCoupons","summary":"List of discount coupons","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_702"}},"schemaId":"schema_702"}],"pointer":"/paths/~1api~1discount-coupons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_702","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_702"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/getlistofdiscountcoupons"}],"panels":[]}]},"httpPath":"/api/discount-coupons"},{"label":"Discount coupons insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/creatediscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/creatediscountcoupons","metadata":{"seo":{"title":"Discount coupons insertion","description":"This endpoint allows you to insert specific discount coupons into Shoptet. Request is sent in JSON format in its body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDiscountCoupons","name":"Discount coupons insertion","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupons insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to insert specific discount coupons into\nShoptet. Request is sent in JSON format in its body.\n\n\nIt is good to compare count of requested coupons with count of cooupons\nin response as it can be different. It is because of request validation,\nwhere it ignores invalid coupons."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_703"}},"schemaId":"schema_703","pointer":"/paths/~1api~1discount-coupons/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/discount-coupons","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_703"}},"responseCodes":["201"],"pointer":"/api/discount-coupons","href":"discount-coupons/creatediscountcoupons","openApiOperationId":"createDiscountCoupons","summary":"Discount coupons insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_703","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_703"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_704"}},"schemaId":"schema_704"}],"pointer":"/paths/~1api~1discount-coupons/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_704","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_704"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/creatediscountcoupons"}],"panels":[]}]},"httpPath":"/api/discount-coupons"},{"label":"Bulk discount coupon update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/bulkupdatediscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/bulkupdatediscountcoupons","metadata":{"seo":{"title":"Bulk discount coupon update","description":"Bulk partial update of existing discount coupons. Each coupon in the requestmust include code as the identifier. All remaining fields are optional andapplied as a partial update — only provided fields are changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkUpdateDiscountCoupons","name":"Bulk discount coupon update","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk discount coupon update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk partial update of existing discount coupons. Each coupon in the request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the identifier. All remaining fields are optional and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applied as a partial update — only provided fields are changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be provided. When"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ratio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minPrice"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is not null."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid coupons or coupons not found by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are skipped and reported in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_705"}},"schemaId":"schema_705","pointer":"/paths/~1api~1discount-coupons/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/discount-coupons","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_705"}},"responseCodes":["200","403","422"],"pointer":"/api/discount-coupons","href":"discount-coupons/bulkupdatediscountcoupons","openApiOperationId":"bulkUpdateDiscountCoupons","summary":"Bulk discount coupon update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_705","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_705"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_704","exampleIds":["paths/~1api~1discount-coupons/patch/responses/200/content/application~1json/examples/duplicateCode"]}},"schemaId":"schema_704","exampleIds":["paths/~1api~1discount-coupons/patch/responses/200/content/application~1json/examples/duplicateCode"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_706","exampleIds":["paths/~1api~1discount-coupons/patch/responses/403/content/application~1json/examples/missingModule"]}},"schemaId":"schema_706","exampleIds":["paths/~1api~1discount-coupons/patch/responses/403/content/application~1json/examples/missingModule"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_707","exampleIds":["paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/couponNotFound","paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/validationErrors"]}},"schemaId":"schema_707","exampleIds":["paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/couponNotFound","paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/validationErrors"]}],"pointer":"/paths/~1api~1discount-coupons/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_704","exampleIds":["paths/~1api~1discount-coupons/patch/responses/200/content/application~1json/examples/duplicateCode"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_704","exampleIds":["paths/~1api~1discount-coupons/patch/responses/200/content/application~1json/examples/duplicateCode"]}}},{"code":"403","schemaId":"schema_706","exampleIds":["paths/~1api~1discount-coupons/patch/responses/403/content/application~1json/examples/missingModule"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_706","exampleIds":["paths/~1api~1discount-coupons/patch/responses/403/content/application~1json/examples/missingModule"]}}},{"code":"422","schemaId":"schema_707","exampleIds":["paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/couponNotFound","paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/validationErrors"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_707","exampleIds":["paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/couponNotFound","paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/validationErrors"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/bulkupdatediscountcoupons"}],"panels":[]}]},"httpPath":"/api/discount-coupons"},{"label":"Bulk discount coupon deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/bulkdeletediscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/bulkdeletediscountcoupons","metadata":{"seo":{"title":"Bulk discount coupon deletion","description":"Bulk deletion of discount coupons as per list of codes. If successful, returnsthe code 200."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkDeleteDiscountCoupons","name":"Bulk discount coupon deletion","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk discount coupon deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk deletion of discount coupons as per list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If successful, returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the code 200."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If some discount coupons does not exist within the e-shop, a 422 code is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_708"}},"schemaId":"schema_708","pointer":"/paths/~1api~1discount-coupons/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/discount-coupons","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_708"}},"responseCodes":["200","422"],"pointer":"/api/discount-coupons","href":"discount-coupons/bulkdeletediscountcoupons","openApiOperationId":"bulkDeleteDiscountCoupons","summary":"Bulk discount coupon deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_708","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_708"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons/delete/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons/delete/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1discount-coupons/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons/delete/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons/delete/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/bulkdeletediscountcoupons"}],"panels":[]}]},"httpPath":"/api/discount-coupons"},{"label":"List of all discount coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/getlistofalldiscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/getlistofalldiscountcoupons","metadata":{"seo":{"title":"List of all discount coupons","description":"Using this endpoint, you can get list of all discount coupons with detailedinfo of each discount coupon asynchronously. See how Asynchronousrequests work on our developer's portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllDiscountCoupons","name":"List of all discount coupons","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all discount coupons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all discount coupons with detailed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"info of each discount coupon asynchronously. See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount coupon taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One discount coupon in response has the same format as one discount coupon"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item form list response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/discountcouponsnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount coupon snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"Export discount coupons with code after given value","example":"0000000006"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"Export discount coupons with code befor given value","example":"0000000006"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"Export discount coupons created after date","example":"2014-09-05T00:00:00%2B0000"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"Export discount coupons created before date","example":"2019-09-05T00:00:00%2B0000"},{"name":"discountType","in":"query","schemaId":"schema_523","description":"Export discount coupons with given discount type (percentual, fixed)","example":"free"},{"name":"validFrom","in":"query","schemaId":"schema_523","description":"Export discount coupons valid after date","example":"2014-09-05"},{"name":"validTo","in":"query","schemaId":"schema_523","description":"Export discount coupons valid before date","example":"2019-09-05"},{"name":"reusable","in":"query","schemaId":"schema_542","description":"Is the discount coupon reusable?","example":true},{"name":"template","in":"query","schemaId":"schema_523","description":"GUID of discount coupon template","required":true,"example":"01b39ad8-8686-11e9-968c-08002774f818"},{"name":"currency","in":"query","schemaId":"schema_523","description":"Currency of fixed discount","example":"EUR"},{"name":"shippingPrice","in":"query","schemaId":"schema_523","description":"How the transport prices are calculated: according to the cart\nbefore discounts (beforeDiscount), according to the displayed value\nof the cart (cart), or free (free)","required":true,"example":"cart"}],"pointer":"/paths/~1api~1discount-coupons~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/discount-coupons/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"codeFrom","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"0000000006","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2014-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2019-09-05T00:00:00%2B0000","schemaId":"schema_523"},{"name":"discountType","in":"query","example":"free","schemaId":"schema_523"},{"name":"validFrom","in":"query","example":"2014-09-05","schemaId":"schema_523"},{"name":"validTo","in":"query","example":"2019-09-05","schemaId":"schema_523"},{"name":"reusable","in":"query","example":true,"schemaId":"schema_542"},{"name":"template","in":"query","required":true,"example":"01b39ad8-8686-11e9-968c-08002774f818","schemaId":"schema_523"},{"name":"currency","in":"query","example":"EUR","schemaId":"schema_523"},{"name":"shippingPrice","in":"query","required":true,"example":"cart","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/discount-coupons/snapshot","href":"discount-coupons/getlistofalldiscountcoupons","openApiOperationId":"getListOfAllDiscountCoupons","summary":"List of all discount coupons","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1discount-coupons~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/getlistofalldiscountcoupons"}],"panels":[]}]},"httpPath":"/api/discount-coupons/snapshot"},{"label":"Detail of discount coupon","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/getdetailofdiscountcoupon","routeSlug":"/shoptet-api/openapi/discount-coupons/getdetailofdiscountcoupon","metadata":{"seo":{"title":"Detail of discount coupon","description":"Detail of discount coupon within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfDiscountCoupon","name":"Detail of discount coupon","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of discount coupon","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Detail of discount coupon within the e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"discount coupon code","required":true,"example":"ABCDEF12"}],"pointer":"/paths/~1api~1discount-coupons~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/discount-coupons/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"ABCDEF12","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/discount-coupons/{code}","href":"discount-coupons/getdetailofdiscountcoupon","openApiOperationId":"getDetailOfDiscountCoupon","summary":"Detail of discount coupon","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_709"}},"schemaId":"schema_709"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1discount-coupons~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_709","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_709"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/getdetailofdiscountcoupon"}],"panels":[]}]},"httpPath":"/api/discount-coupons/{code}"},{"label":"Discount coupon deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/deletediscountcoupon","routeSlug":"/shoptet-api/openapi/discount-coupons/deletediscountcoupon","metadata":{"seo":{"title":"Discount coupon deletion","description":"Deletes discount coupon as per entered code. If successful, returnsthe code 200."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDiscountCoupon","name":"Discount coupon deletion","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupon deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes discount coupon as per entered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If successful, returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the code 200."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the discount coupon does not exist within the e-shop, a 404 code is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"discount coupon code","required":true,"example":"ABCDEF12"}],"pointer":"/paths/~1api~1discount-coupons~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/discount-coupons/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"ABCDEF12","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/discount-coupons/{code}","href":"discount-coupons/deletediscountcoupon","openApiOperationId":"deleteDiscountCoupon","summary":"Discount coupon deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1{code}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1{code}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1discount-coupons~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1{code}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1{code}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/deletediscountcoupon"}],"panels":[]}]},"httpPath":"/api/discount-coupons/{code}"},{"label":"Discount coupons set creation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/creatediscountcouponsset","routeSlug":"/shoptet-api/openapi/discount-coupons/creatediscountcouponsset","metadata":{"seo":{"title":"Discount coupons set creation","description":"This endpoint allows you to create set of discount coupons for Shoptet.It is good to compare count of requested coupons with count of cooupons in response as it can be different. It is because of request validation, where it ignores invalid coupons."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDiscountCouponsSet","name":"Discount coupons set creation","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1set/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupons set creation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to create set of discount coupons for Shoptet.It is good to compare count of requested\ncoupons with count of cooupons in response as it can be different. It is because of request validation, \nwhere it ignores invalid coupons."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1set/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_710"}},"schemaId":"schema_710","pointer":"/paths/~1api~1discount-coupons~1set/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/discount-coupons/set","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_710"}},"responseCodes":["201"],"pointer":"/api/discount-coupons/set","href":"discount-coupons/creatediscountcouponsset","openApiOperationId":"createDiscountCouponsSet","summary":"Discount coupons set creation","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_710","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_710"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_711"}},"schemaId":"schema_711"}],"pointer":"/paths/~1api~1discount-coupons~1set/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_711","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_711"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/creatediscountcouponsset"}],"panels":[]}]},"httpPath":"/api/discount-coupons/set"},{"label":"Discount coupons usage update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/updatediscountcouponsusage","routeSlug":"/shoptet-api/openapi/discount-coupons/updatediscountcouponsusage","metadata":{"seo":{"title":"Discount coupons usage update","description":"This endpoint allows you to set usage of discount coupon."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDiscountCouponsUsage","name":"Discount coupons usage update","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1use~1{code}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupons usage update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to set usage of discount coupon."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"discount coupon code","required":true,"example":"89170026"}],"pointer":"/paths/~1api~1discount-coupons~1use~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressOrderChecking","in":"query","schemaId":"schema_529","description":"suppress checking if order exists.","example":true}],"pointer":"/paths/~1api~1discount-coupons~1use~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1use~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_712"}},"schemaId":"schema_712","pointer":"/paths/~1api~1discount-coupons~1use~1{code}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/discount-coupons/use/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"89170026","schemaId":"schema_523"}],"query":[{"name":"suppressOrderChecking","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_712"}},"responseCodes":["200","404","409"],"pointer":"/api/discount-coupons/use/{code}","href":"discount-coupons/updatediscountcouponsusage","openApiOperationId":"updateDiscountCouponsUsage","summary":"Discount coupons usage update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_712","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_712"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1use~1{code}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1use~1{code}/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1use~1{code}/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1use~1{code}/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1discount-coupons~1use~1{code}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1use~1{code}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1use~1{code}/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1use~1{code}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1use~1{code}/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/updatediscountcouponsusage"}],"panels":[]}]},"httpPath":"/api/discount-coupons/use/{code}"},{"label":"Templates of discount coupons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/gettemplatesofdiscountcoupons","routeSlug":"/shoptet-api/openapi/discount-coupons/gettemplatesofdiscountcoupons","metadata":{"seo":{"title":"Templates of discount coupons","description":"Templates of discount coupons within the e-shop. All templates are listed at a time. Without possibility of paging or filtering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplatesOfDiscountCoupons","name":"Templates of discount coupons","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Templates of discount coupons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Templates of discount coupons within the e-shop. All templates are listed at a time. Without possibility of \npaging or filtering."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/discount-coupons/templates","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/discount-coupons/templates","href":"discount-coupons/gettemplatesofdiscountcoupons","openApiOperationId":"getTemplatesOfDiscountCoupons","summary":"Templates of discount coupons","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_713"}},"schemaId":"schema_713"}],"pointer":"/paths/~1api~1discount-coupons~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_713","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_713"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/gettemplatesofdiscountcoupons"}],"panels":[]}]},"httpPath":"/api/discount-coupons/templates"},{"label":"Discount coupons template insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/creatediscountcouponstemplate","routeSlug":"/shoptet-api/openapi/discount-coupons/creatediscountcouponstemplate","metadata":{"seo":{"title":"Discount coupons template insertion","description":"Discount coupons template insertion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDiscountCouponsTemplate","name":"Discount coupons template insertion","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupons template insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714"}},"schemaId":"schema_714","pointer":"/paths/~1api~1discount-coupons~1templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/discount-coupons/templates","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_714"}},"responseCodes":["201","400"],"pointer":"/api/discount-coupons/templates","href":"discount-coupons/creatediscountcouponstemplate","openApiOperationId":"createDiscountCouponsTemplate","summary":"Discount coupons template insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_714","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_714"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}},"schemaId":"schema_715"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/tooManyProducts","paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/productNotFound"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/tooManyProducts","paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/productNotFound"]}],"pointer":"/paths/~1api~1discount-coupons~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_715","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_715"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/tooManyProducts","paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/productNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/tooManyProducts","paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/productNotFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/creatediscountcouponstemplate"}],"panels":[]}]},"httpPath":"/api/discount-coupons/templates"},{"label":"Discount coupons template detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/getdiscountcouponstemplate","routeSlug":"/shoptet-api/openapi/discount-coupons/getdiscountcouponstemplate","metadata":{"seo":{"title":"Discount coupons template detail","description":"Returns a single discount coupon template by guid, including the list ofspecific products assigned to it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDiscountCouponsTemplate","name":"Discount coupons template detail","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1templates~1{guid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupons template detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a single discount coupon template by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including the list of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific products assigned to it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"discount coupon template guid","required":true,"example":"b6e09a7a-6cb5-11eb-89aa-08002746ad91"}],"pointer":"/paths/~1api~1discount-coupons~1templates~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1templates~1{guid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/discount-coupons/templates/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"b6e09a7a-6cb5-11eb-89aa-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/discount-coupons/templates/{guid}","href":"discount-coupons/getdiscountcouponstemplate","openApiOperationId":"getDiscountCouponsTemplate","summary":"Discount coupons template detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_716"}},"schemaId":"schema_716"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1discount-coupons~1templates~1{guid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_716","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_716"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/getdiscountcouponstemplate"}],"panels":[]}]},"httpPath":"/api/discount-coupons/templates/{guid}"},{"label":"Discount coupons template deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/discount-coupons/deletediscountcouponstemplate","routeSlug":"/shoptet-api/openapi/discount-coupons/deletediscountcouponstemplate","metadata":{"seo":{"title":"Discount coupons template deletion","description":"Deletes discount coupon template as per entered guid. If successful,returns the code 200."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDiscountCouponsTemplate","name":"Discount coupons template deletion","isWebhook":false,"pointer":"/paths/~1api~1discount-coupons~1templates~1{guid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupons template deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes discount coupon template as per entered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If successful,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns the code 200."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the discount coupon template does not exist within the e-shop, a 404"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the discount coupon template cannot be deleted, because it is used as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"template of discount coupon, a 409 code is returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"discount coupon template guid","required":true,"example":"b6e09a7a-6cb5-11eb-89aa-08002746ad91"}],"pointer":"/paths/~1api~1discount-coupons~1templates~1{guid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1discount-coupons~1templates~1{guid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/discount-coupons/templates/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"b6e09a7a-6cb5-11eb-89aa-08002746ad91","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/discount-coupons/templates/{guid}","href":"discount-coupons/deletediscountcouponstemplate","openApiOperationId":"deleteDiscountCouponsTemplate","summary":"Discount coupons template deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/discount-coupons/deletediscountcouponstemplate"}],"panels":[]}]},"httpPath":"/api/discount-coupons/templates/{guid}"}],"content":{"contentType":"group","meta":{"name":"Discount coupons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupons","showPageActions":true},{"nodeType":"markdoc","content":"Managing discount coupons in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/discount-coupons","summary":"List of discount coupons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discount-coupons/getlistofdiscountcoupons","deprecated":false},{"title":"/api/discount-coupons","summary":"Discount coupons insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discount-coupons/creatediscountcoupons","deprecated":false},{"title":"/api/discount-coupons","summary":"Bulk discount coupon update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/discount-coupons/bulkupdatediscountcoupons","deprecated":false},{"title":"/api/discount-coupons","summary":"Bulk discount coupon deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/discount-coupons/bulkdeletediscountcoupons","deprecated":false},{"title":"/api/discount-coupons/snapshot","summary":"List of all discount coupons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discount-coupons/getlistofalldiscountcoupons","deprecated":false},{"title":"/api/discount-coupons/{code}","summary":"Detail of discount coupon","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discount-coupons/getdetailofdiscountcoupon","deprecated":false},{"title":"/api/discount-coupons/{code}","summary":"Discount coupon deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/discount-coupons/deletediscountcoupon","deprecated":false},{"title":"/api/discount-coupons/set","summary":"Discount coupons set creation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discount-coupons/creatediscountcouponsset","deprecated":false},{"title":"/api/discount-coupons/use/{code}","summary":"Discount coupons usage update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/discount-coupons/updatediscountcouponsusage","deprecated":false},{"title":"/api/discount-coupons/templates","summary":"Templates of discount coupons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discount-coupons/gettemplatesofdiscountcoupons","deprecated":false},{"title":"/api/discount-coupons/templates","summary":"Discount coupons template insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/discount-coupons/creatediscountcouponstemplate","deprecated":false},{"title":"/api/discount-coupons/templates/{guid}","summary":"Discount coupons template detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/discount-coupons/getdiscountcouponstemplate","deprecated":false},{"title":"/api/discount-coupons/templates/{guid}","summary":"Discount coupons template deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/discount-coupons/deletediscountcouponstemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"E-mail distribution lists","link":"/shoptet-api/openapi/e-mail-distribution-lists","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists","items":[{"label":"Listing of e-mail distribution lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/getlistingofemaildistributionlists","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/getlistingofemaildistributionlists","metadata":{"seo":{"title":"Listing of e-mail distribution lists","description":"The e-mail distribution list named \"newsletters\" is the system one and is always available (if the e-shop has the module installed). This e-mail distribution list includes the e-mails of all customers who agreed to receiving e-mails."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListingOfEmailDistributionLists","name":"Listing of e-mail distribution lists","isWebhook":false,"pointer":"/paths/~1api~1mailing-lists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Listing of e-mail distribution lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The e-mail distribution list named \"newsletters\" is the system one and is always available \n(if the e-shop has the module installed). This e-mail distribution list includes the e-mails \nof all customers who agreed to receiving e-mails."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1mailing-lists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/mailing-lists","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/mailing-lists","href":"e-mail-distribution-lists/getlistingofemaildistributionlists","openApiOperationId":"getListingOfEmailDistributionLists","summary":"Listing of e-mail distribution lists","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_717"}},"schemaId":"schema_717"}],"pointer":"/paths/~1api~1mailing-lists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_717","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_717"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-mail-distribution-lists/getlistingofemaildistributionlists"}],"panels":[]}]},"httpPath":"/api/mailing-lists"},{"label":"Insertion of e-mail distribution list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/createemaildistributionlist","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/createemaildistributionlist","metadata":{"seo":{"title":"Insertion of e-mail distribution list","description":"Insertion of e-mail distribution list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEmailDistributionList","name":"Insertion of e-mail distribution list","isWebhook":false,"pointer":"/paths/~1api~1mailing-lists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insertion of e-mail distribution list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 500.","example":350},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1mailing-lists/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1mailing-lists/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718"}},"schemaId":"schema_718","pointer":"/paths/~1api~1mailing-lists/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/mailing-lists","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":350,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_718"}},"responseCodes":["201"],"pointer":"/api/mailing-lists","href":"e-mail-distribution-lists/createemaildistributionlist","openApiOperationId":"createEmailDistributionList","summary":"Insertion of e-mail distribution list","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_718","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_718"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}},"schemaId":"schema_719"}],"pointer":"/paths/~1api~1mailing-lists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_719","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_719"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-mail-distribution-lists/createemaildistributionlist"}],"panels":[]}]},"httpPath":"/api/mailing-lists"},{"label":"Detail of e-mail distribution list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/getdetailofemaildistributionlist","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/getdetailofemaildistributionlist","metadata":{"seo":{"title":"Detail of e-mail distribution list","description":"This endpoint returns a list of e-mail addresses of the distribution list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfEmailDistributionList","name":"Detail of e-mail distribution list","isWebhook":false,"pointer":"/paths/~1api~1mailing-lists~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of e-mail distribution list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint returns a list of e-mail addresses of the distribution list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon initial call, it returns up to 500 e-mail addresses; using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?itemsPerPage=20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, you can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests any number of records per page, up to 500 items limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"e-mail list code","required":true,"example":"newsletters"}],"pointer":"/paths/~1api~1mailing-lists~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1mailing-lists~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/mailing-lists/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"newsletters","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/mailing-lists/{code}","href":"e-mail-distribution-lists/getdetailofemaildistributionlist","openApiOperationId":"getDetailOfEmailDistributionList","summary":"Detail of e-mail distribution list","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}},"schemaId":"schema_720"}],"pointer":"/paths/~1api~1mailing-lists~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_720","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_720"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-mail-distribution-lists/getdetailofemaildistributionlist"}],"panels":[]}]},"httpPath":"/api/mailing-lists/{code}"},{"label":"Distribution list e-mails insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/createemailsdistributionlist","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/createemailsdistributionlist","metadata":{"seo":{"title":"Distribution list e-mails insertion","description":"This endpoint allows you to add new e-mail addresses to the distributionlist identified by its code. In the response you will receivestructured info about the result of the insertion. In theemailsInserted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEmailsDistributionList","name":"Distribution list e-mails insertion","isWebhook":false,"pointer":"/paths/~1api~1mailing-lists~1{code}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Distribution list e-mails insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to add new e-mail addresses to the distribution"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In the response you will receive"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"structured info about the result of the insertion. In the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailsInserted"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"key there will be a list of e-mails successfully inserted, in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailsExisting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key, there will be a list of skipped e-mails, because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there were already in the list. In the"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailsInvalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key, there will be a list of invalid e-mails (wrong"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format or non-existing MX domain record) and finally in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorMessages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key, there will be a list of error messages"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated for invalid e-mails."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"e-mail list code","required":true,"example":"newsletters"}],"pointer":"/paths/~1api~1mailing-lists~1{code}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1mailing-lists~1{code}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721"}},"schemaId":"schema_721","pointer":"/paths/~1api~1mailing-lists~1{code}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/mailing-lists/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"newsletters","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_721"}},"responseCodes":["201"],"pointer":"/api/mailing-lists/{code}","href":"e-mail-distribution-lists/createemailsdistributionlist","openApiOperationId":"createEmailsDistributionList","summary":"Distribution list e-mails insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_721","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_721"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}},"schemaId":"schema_722"}],"pointer":"/paths/~1api~1mailing-lists~1{code}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_722","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_722"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-mail-distribution-lists/createemailsdistributionlist"}],"panels":[]}]},"httpPath":"/api/mailing-lists/{code}"},{"label":"Last changes in distribution list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/e-mail-distribution-lists/getlastchangesindistributionlist","routeSlug":"/shoptet-api/openapi/e-mail-distribution-lists/getlastchangesindistributionlist","metadata":{"seo":{"title":"Last changes in distribution list","description":"Endpoint is intended to determine the changes after you load the complete e-mail list and you need to knowif any of these e-mails were added or removed. Guaranteed history is 30 days, the older data are deletedprogressively."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLastChangesInDistributionList","name":"Last changes in distribution list","isWebhook":false,"pointer":"/paths/~1api~1mailing-lists~1{code}~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last changes in distribution list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint is intended to determine the changes after you load the complete e-mail list and you need to know"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if any of these e-mails were added or removed. Guaranteed history is 30 days, the older data are deleted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"progressively."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each e-mail on single e-mail list is only mentioned with its last change, within the log. For example,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the e-mail is deleted and then added again, the log will only show information about its addition."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The e-mail lists are not dependant on each other (removing an e-mail from one list does not cause any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"change in another list, unless the e-mail was originally included in both)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be filtered by changeType = edit/delete parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For \"created\" action, we use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" change type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"e-mail list code","required":true,"example":"newsletters"}],"pointer":"/paths/~1api~1mailing-lists~1{code}~1changes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime from which up to the present we are interested in the changes. + in the time zone"},"children":[]}]}]}],"required":true,"example":"2018-01-01T01:01:01+02:00"},{"name":"changeType","in":"query","schemaId":"schema_523","description":"Returning only edit or delete type changed records","example":"edit"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 500.","example":400},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1mailing-lists~1{code}~1changes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1mailing-lists~1{code}~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/mailing-lists/{code}/changes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"newsletters","schemaId":"schema_523"}],"query":[{"name":"from","in":"query","required":true,"example":"2018-01-01T01:01:01+02:00","schemaId":"schema_523"},{"name":"changeType","in":"query","required":false,"example":"edit","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":400,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/mailing-lists/{code}/changes","href":"e-mail-distribution-lists/getlastchangesindistributionlist","openApiOperationId":"getLastChangesInDistributionList","summary":"Last changes in distribution list","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_723"}},"schemaId":"schema_723"}],"pointer":"/paths/~1api~1mailing-lists~1{code}~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_723","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_723"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/e-mail-distribution-lists/getlastchangesindistributionlist"}],"panels":[]}]},"httpPath":"/api/mailing-lists/{code}/changes"}],"content":{"contentType":"group","meta":{"name":"E-mail distribution lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"E-mail distribution lists","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The functionality is subject to module activation "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doplnky.shoptet.cz/hromadne-rozesilani-emailu"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-mailing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the e-shop. The addon using this endpoint must therefore have this module"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defined as dependency."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/mailing-lists","summary":"Listing of e-mail distribution lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-mail-distribution-lists/getlistingofemaildistributionlists","deprecated":false},{"title":"/api/mailing-lists","summary":"Insertion of e-mail distribution list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-mail-distribution-lists/createemaildistributionlist","deprecated":false},{"title":"/api/mailing-lists/{code}","summary":"Detail of e-mail distribution list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-mail-distribution-lists/getdetailofemaildistributionlist","deprecated":false},{"title":"/api/mailing-lists/{code}","summary":"Distribution list e-mails insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/e-mail-distribution-lists/createemailsdistributionlist","deprecated":false},{"title":"/api/mailing-lists/{code}/changes","summary":"Last changes in distribution list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/e-mail-distribution-lists/getlastchangesindistributionlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Quantity discounts","link":"/shoptet-api/openapi/quantity-discounts","routeSlug":"/shoptet-api/openapi/quantity-discounts","items":[{"label":"List of quantity discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/getlistofquantitydiscounts","routeSlug":"/shoptet-api/openapi/quantity-discounts/getlistofquantitydiscounts","metadata":{"seo":{"title":"List of quantity discounts","description":"Returns a list of quantity discounts with basic info.Supports Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfQuantityDiscounts","name":"List of quantity discounts","isWebhook":false,"pointer":"/paths/~1api~1quantity-discounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of quantity discounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of quantity discounts with basic info."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customerGroupCode","in":"query","schemaId":"schema_523","description":"customer group code, possible values can be get by customer group list endpoint","example":"retail"},{"name":"validFrom","in":"query","schemaId":"schema_523","description":"date of discount validity - lower limit","example":"2028-05-28"},{"name":"validTo","in":"query","schemaId":"schema_523","description":"date of discount validity - upper limit","example":"2028-05-28"},{"name":"status","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status of discount, possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planned"},"children":[]}]}]}],"example":"available"},{"name":"isActive","in":"query","schemaId":"schema_542","description":"whether or not discount is active","example":true},{"name":"includeUnregisteredCustomers","in":"query","schemaId":"schema_542","description":"whether or not discount is valid for unregistered customers","example":true},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1quantity-discounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1quantity-discounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/quantity-discounts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"customerGroupCode","in":"query","example":"retail","schemaId":"schema_523"},{"name":"validFrom","in":"query","example":"2028-05-28","schemaId":"schema_523"},{"name":"validTo","in":"query","example":"2028-05-28","schemaId":"schema_523"},{"name":"status","in":"query","example":"available","schemaId":"schema_523"},{"name":"isActive","in":"query","example":true,"schemaId":"schema_542"},{"name":"includeUnregisteredCustomers","in":"query","example":true,"schemaId":"schema_542"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/quantity-discounts","href":"quantity-discounts/getlistofquantitydiscounts","openApiOperationId":"getListOfQuantityDiscounts","summary":"List of quantity discounts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_724"}},"schemaId":"schema_724"}],"pointer":"/paths/~1api~1quantity-discounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_724","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_724"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quantity-discounts/getlistofquantitydiscounts"}],"panels":[]}]},"httpPath":"/api/quantity-discounts"},{"label":"Quantity discount insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/createquantitydiscount","routeSlug":"/shoptet-api/openapi/quantity-discounts/createquantitydiscount","metadata":{"seo":{"title":"Quantity discount insertion","description":"Quantity discount insertion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createQuantityDiscount","name":"Quantity discount insertion","isWebhook":false,"pointer":"/paths/~1api~1quantity-discounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quantity discount insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1quantity-discounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_725"}},"schemaId":"schema_725","pointer":"/paths/~1api~1quantity-discounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/quantity-discounts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_725"}},"responseCodes":["201","404"],"pointer":"/api/quantity-discounts","href":"quantity-discounts/createquantitydiscount","openApiOperationId":"createQuantityDiscount","summary":"Quantity discount insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_725","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_725"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_726"}},"schemaId":"schema_726"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1quantity-discounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_726","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_726"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quantity-discounts/createquantitydiscount"}],"panels":[]}]},"httpPath":"/api/quantity-discounts"},{"label":"List of all quantity discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/getlistofallquantitydiscounts","routeSlug":"/shoptet-api/openapi/quantity-discounts/getlistofallquantitydiscounts","metadata":{"seo":{"title":"List of all quantity discounts","description":"Using this endpoint, you can get list of all quantity discounts with detailed info of each article (like in Detail of quantity discount endpoint) asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAllQuantityDiscounts","name":"List of all quantity discounts","isWebhook":false,"pointer":"/paths/~1api~1quantity-discounts~1snapshot/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all quantity discounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint, you can get list of all quantity discounts with detailed info of each article (like in Detail of quantity discount endpoint) asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response will be in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format with each quantity discount taking one line of output file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One quantity discount in response has the same format as in detail of quantity discount endpoint response. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/snapshot/quantitydiscountsnapshot"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantity discount snapshot schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result file is compressed using GZIP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customerGroupCode","in":"query","schemaId":"schema_523","description":"customer group code, possible values can be get by customer group list endpoint","example":"retail"},{"name":"validFrom","in":"query","schemaId":"schema_523","description":"date of discount validity - lower limit","example":"2028-05-28"},{"name":"validTo","in":"query","schemaId":"schema_523","description":"date of discount validity - upper limit","example":"2028-05-28"},{"name":"status","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status of discount, possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planned"},"children":[]}]}]}],"example":"available"},{"name":"isActive","in":"query","schemaId":"schema_542","description":"whether or not discount is active","example":true},{"name":"includeUnregisteredCustomers","in":"query","schemaId":"schema_542","description":"whether or not discount is valid for unregistered customers","example":true}],"pointer":"/paths/~1api~1quantity-discounts~1snapshot/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1quantity-discounts~1snapshot/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/quantity-discounts/snapshot","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"customerGroupCode","in":"query","example":"retail","schemaId":"schema_523"},{"name":"validFrom","in":"query","example":"2028-05-28","schemaId":"schema_523"},{"name":"validTo","in":"query","example":"2028-05-28","schemaId":"schema_523"},{"name":"status","in":"query","example":"available","schemaId":"schema_523"},{"name":"isActive","in":"query","example":true,"schemaId":"schema_542"},{"name":"includeUnregisteredCustomers","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/quantity-discounts/snapshot","href":"quantity-discounts/getlistofallquantitydiscounts","openApiOperationId":"getListOfAllQuantityDiscounts","summary":"List of all quantity discounts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1quantity-discounts~1snapshot/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quantity-discounts/getlistofallquantitydiscounts"}],"panels":[]}]},"httpPath":"/api/quantity-discounts/snapshot"},{"label":"Detail of quantity discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/getdetailofquantitydiscounts","routeSlug":"/shoptet-api/openapi/quantity-discounts/getdetailofquantitydiscounts","metadata":{"seo":{"title":"Detail of quantity discounts","description":"Detail of quantity discounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfQuantityDiscounts","name":"Detail of quantity discounts","isWebhook":false,"pointer":"/paths/~1api~1quantity-discounts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of quantity discounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"discount ID","required":true,"example":1}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/quantity-discounts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/quantity-discounts/{id}","href":"quantity-discounts/getdetailofquantitydiscounts","openApiOperationId":"getDetailOfQuantityDiscounts","summary":"Detail of quantity discounts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_726"}},"schemaId":"schema_726"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_726","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_726"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quantity-discounts/getdetailofquantitydiscounts"}],"panels":[]}]},"httpPath":"/api/quantity-discounts/{id}"},{"label":"Quantity discount update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/updatequantitydiscount","routeSlug":"/shoptet-api/openapi/quantity-discounts/updatequantitydiscount","metadata":{"seo":{"title":"Quantity discount update","description":"Quantity discount update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateQuantityDiscount","name":"Quantity discount update","isWebhook":false,"pointer":"/paths/~1api~1quantity-discounts~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quantity discount update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"discount ID","required":true,"example":1}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_727"}},"schemaId":"schema_727","pointer":"/paths/~1api~1quantity-discounts~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/quantity-discounts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_727"}},"responseCodes":["200","404"],"pointer":"/api/quantity-discounts/{id}","href":"quantity-discounts/updatequantitydiscount","openApiOperationId":"updateQuantityDiscount","summary":"Quantity discount update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_727","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_727"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_728"}},"schemaId":"schema_728"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_728","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_728"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quantity-discounts/updatequantitydiscount"}],"panels":[]}]},"httpPath":"/api/quantity-discounts/{id}"},{"label":"Delete of quantity discount","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/quantity-discounts/deletequantitydiscount","routeSlug":"/shoptet-api/openapi/quantity-discounts/deletequantitydiscount","metadata":{"seo":{"title":"Delete of quantity discount","description":"Delete of quantity discount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteQuantityDiscount","name":"Delete of quantity discount","isWebhook":false,"pointer":"/paths/~1api~1quantity-discounts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete of quantity discount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"discount ID","required":true,"example":1}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/quantity-discounts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/quantity-discounts/{id}","href":"quantity-discounts/deletequantitydiscount","openApiOperationId":"deleteQuantityDiscount","summary":"Delete of quantity discount","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1quantity-discounts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1quantity-discounts~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quantity-discounts/deletequantitydiscount"}],"panels":[]}]},"httpPath":"/api/quantity-discounts/{id}"}],"content":{"contentType":"group","meta":{"name":"Quantity discounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quantity discounts","showPageActions":true},{"nodeType":"markdoc","content":"Managing quantity discounts in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/quantity-discounts","summary":"List of quantity discounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quantity-discounts/getlistofquantitydiscounts","deprecated":false},{"title":"/api/quantity-discounts","summary":"Quantity discount insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quantity-discounts/createquantitydiscount","deprecated":false},{"title":"/api/quantity-discounts/snapshot","summary":"List of all quantity discounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quantity-discounts/getlistofallquantitydiscounts","deprecated":false},{"title":"/api/quantity-discounts/{id}","summary":"Detail of quantity discounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quantity-discounts/getdetailofquantitydiscounts","deprecated":false},{"title":"/api/quantity-discounts/{id}","summary":"Quantity discount update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/quantity-discounts/updatequantitydiscount","deprecated":false},{"title":"/api/quantity-discounts/{id}","summary":"Delete of quantity discount","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/quantity-discounts/deletequantitydiscount","deprecated":false}]}]}]}]}},{"type":"group","label":"Unsubscribed emails","link":"/shoptet-api/openapi/unsubscribed-emails","routeSlug":"/shoptet-api/openapi/unsubscribed-emails","items":[{"label":"Listing of unsubscribed e-mails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/unsubscribed-emails/getlistingofunsubscribedemails","routeSlug":"/shoptet-api/openapi/unsubscribed-emails/getlistingofunsubscribedemails","metadata":{"seo":{"title":"Listing of unsubscribed e-mails","description":"Listing of unsubscribed e-mails"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListingOfUnsubscribedEmails","name":"Listing of unsubscribed e-mails","isWebhook":false,"pointer":"/paths/~1api~1unsubscribed-emails/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Listing of unsubscribed e-mails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date of unsubcription ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsubscribedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in response). Optional."},"children":[]}]}]}],"example":"2023-02-01T17:04:47+0100"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 1000.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1unsubscribed-emails/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1unsubscribed-emails/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/unsubscribed-emails","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","example":"2023-02-01T17:04:47+0100","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/unsubscribed-emails","href":"unsubscribed-emails/getlistingofunsubscribedemails","openApiOperationId":"getListingOfUnsubscribedEmails","summary":"Listing of unsubscribed e-mails","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_729"}},"schemaId":"schema_729"}],"pointer":"/paths/~1api~1unsubscribed-emails/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_729","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_729"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribed-emails/getlistingofunsubscribedemails"}],"panels":[]}]},"httpPath":"/api/unsubscribed-emails"},{"label":"Unsubscribed e-mail insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/unsubscribed-emails/createunsubscribedemail","routeSlug":"/shoptet-api/openapi/unsubscribed-emails/createunsubscribedemail","metadata":{"seo":{"title":"Unsubscribed e-mail insertion","description":"Unsubscribed e-mail insertion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUnsubscribedEmail","name":"Unsubscribed e-mail insertion","isWebhook":false,"pointer":"/paths/~1api~1unsubscribed-emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unsubscribed e-mail insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1unsubscribed-emails/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_730"}},"schemaId":"schema_730","pointer":"/paths/~1api~1unsubscribed-emails/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/unsubscribed-emails","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_730"}},"responseCodes":["201"],"pointer":"/api/unsubscribed-emails","href":"unsubscribed-emails/createunsubscribedemail","openApiOperationId":"createUnsubscribedEmail","summary":"Unsubscribed e-mail insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_730","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_730"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}},"schemaId":"schema_731"}],"pointer":"/paths/~1api~1unsubscribed-emails/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_731","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_731"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribed-emails/createunsubscribedemail"}],"panels":[]}]},"httpPath":"/api/unsubscribed-emails"}],"content":{"contentType":"group","meta":{"name":"Unsubscribed emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unsubscribed emails","showPageActions":true},{"nodeType":"markdoc","content":"This functionality allows you to manage a list of email addresses that\nopted out of receiving marketing communications in compliance with legal\nrequirements, including the possibility of comparing any further mailings\nwith this list to exclude opt-out contacts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/unsubscribed-emails","summary":"Listing of unsubscribed e-mails","prefix":{"name":"get","color":"get"},"badges":[],"link":"/unsubscribed-emails/getlistingofunsubscribedemails","deprecated":false},{"title":"/api/unsubscribed-emails","summary":"Unsubscribed e-mail insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unsubscribed-emails/createunsubscribedemail","deprecated":false}]}]}]}]}},{"type":"group","label":"Volume discounts","link":"/shoptet-api/openapi/volume-discounts","routeSlug":"/shoptet-api/openapi/volume-discounts","items":[{"label":"List of volume discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/volume-discounts/getlistofvolumediscounts","routeSlug":"/shoptet-api/openapi/volume-discounts/getlistofvolumediscounts","metadata":{"seo":{"title":"List of volume discounts","description":"List of volume discounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfVolumeDiscounts","name":"List of volume discounts","isWebhook":false,"pointer":"/paths/~1api~1volume-discounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of volume discounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customerGroupCode","in":"query","schemaId":"schema_523","description":"customer group code, possible values can be get by customer group\nlist endpoint","example":"retail"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1volume-discounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1volume-discounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/volume-discounts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"customerGroupCode","in":"query","example":"retail","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/volume-discounts","href":"volume-discounts/getlistofvolumediscounts","openApiOperationId":"getListOfVolumeDiscounts","summary":"List of volume discounts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_732"}},"schemaId":"schema_732"}],"pointer":"/paths/~1api~1volume-discounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_732","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_732"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/volume-discounts/getlistofvolumediscounts"}],"panels":[]}]},"httpPath":"/api/volume-discounts"}],"content":{"contentType":"group","meta":{"name":"Volume discounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Volume discounts","showPageActions":true},{"nodeType":"markdoc","content":"Managing volume discounts in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/volume-discounts","summary":"List of volume discounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/volume-discounts/getlistofvolumediscounts","deprecated":false}]}]}]}]}},{"type":"group","label":"XY discounts","link":"/shoptet-api/openapi/xy-discounts","routeSlug":"/shoptet-api/openapi/xy-discounts","items":[{"label":"List of X + Y discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/getlistofxydiscounts","routeSlug":"/shoptet-api/openapi/xy-discounts/getlistofxydiscounts","metadata":{"seo":{"title":"List of X + Y discounts","description":"List of X + Y discounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfXYDiscounts","name":"List of X + Y discounts","isWebhook":false,"pointer":"/paths/~1api~1xy-discounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of X + Y discounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customerGroupCode","in":"query","schemaId":"schema_523","description":"customer group code, possible values can be get by customer group\nlist endpoint","example":"retail"},{"name":"validFrom","in":"query","schemaId":"schema_523","description":"date of discount validity - lower limit","example":"2028-05-28"},{"name":"validTo","in":"query","schemaId":"schema_523","description":"date of discount validity - upper limit","example":"2028-05-28"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 20.","example":15},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1xy-discounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1xy-discounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/xy-discounts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"customerGroupCode","in":"query","example":"retail","schemaId":"schema_523"},{"name":"validFrom","in":"query","example":"2028-05-28","schemaId":"schema_523"},{"name":"validTo","in":"query","example":"2028-05-28","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":15,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/xy-discounts","href":"xy-discounts/getlistofxydiscounts","openApiOperationId":"getListOfXYDiscounts","summary":"List of X + Y discounts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_733"}},"schemaId":"schema_733"}],"pointer":"/paths/~1api~1xy-discounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_733","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_733"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/xy-discounts/getlistofxydiscounts"}],"panels":[]}]},"httpPath":"/api/xy-discounts"},{"label":"X + Y discount insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/createxydiscount","routeSlug":"/shoptet-api/openapi/xy-discounts/createxydiscount","metadata":{"seo":{"title":"X + Y discount insertion","description":"X + Y discount insertion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createXYDiscount","name":"X + Y discount insertion","isWebhook":false,"pointer":"/paths/~1api~1xy-discounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"X + Y discount insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1xy-discounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_734"}},"schemaId":"schema_734","pointer":"/paths/~1api~1xy-discounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/xy-discounts","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_734"}},"responseCodes":["201"],"pointer":"/api/xy-discounts","href":"xy-discounts/createxydiscount","openApiOperationId":"createXYDiscount","summary":"X + Y discount insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_734","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_734"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_735"}},"schemaId":"schema_735"}],"pointer":"/paths/~1api~1xy-discounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_735","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_735"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/xy-discounts/createxydiscount"}],"panels":[]}]},"httpPath":"/api/xy-discounts"},{"label":"Detail of X + Y discounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/getdetailofxydiscounts","routeSlug":"/shoptet-api/openapi/xy-discounts/getdetailofxydiscounts","metadata":{"seo":{"title":"Detail of X + Y discounts","description":"Detail of X + Y discounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfXYDiscounts","name":"Detail of X + Y discounts","isWebhook":false,"pointer":"/paths/~1api~1xy-discounts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of X + Y discounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"discount ID","required":true,"example":1}],"pointer":"/paths/~1api~1xy-discounts~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1xy-discounts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/xy-discounts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/xy-discounts/{id}","href":"xy-discounts/getdetailofxydiscounts","openApiOperationId":"getDetailOfXYDiscounts","summary":"Detail of X + Y discounts","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_735"}},"schemaId":"schema_735"}],"pointer":"/paths/~1api~1xy-discounts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_735","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_735"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/xy-discounts/getdetailofxydiscounts"}],"panels":[]}]},"httpPath":"/api/xy-discounts/{id}"},{"label":"X + Y discount update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/updatexydiscount","routeSlug":"/shoptet-api/openapi/xy-discounts/updatexydiscount","metadata":{"seo":{"title":"X + Y discount update","description":"X + Y discount update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateXYDiscount","name":"X + Y discount update","isWebhook":false,"pointer":"/paths/~1api~1xy-discounts~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"X + Y discount update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"discount ID","required":true,"example":1}],"pointer":"/paths/~1api~1xy-discounts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1xy-discounts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_736"}},"schemaId":"schema_736","pointer":"/paths/~1api~1xy-discounts~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/xy-discounts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_736"}},"responseCodes":["200","404"],"pointer":"/api/xy-discounts/{id}","href":"xy-discounts/updatexydiscount","openApiOperationId":"updateXYDiscount","summary":"X + Y discount update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_736","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_736"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_737"}},"schemaId":"schema_737"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1{id}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1xy-discounts~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_737","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_737"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1{id}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/xy-discounts/updatexydiscount"}],"panels":[]}]},"httpPath":"/api/xy-discounts/{id}"},{"label":"Delete of X + Y discount","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/deletexydiscount","routeSlug":"/shoptet-api/openapi/xy-discounts/deletexydiscount","metadata":{"seo":{"title":"Delete of X + Y discount","description":"Delete of X + Y discount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteXYDiscount","name":"Delete of X + Y discount","isWebhook":false,"pointer":"/paths/~1api~1xy-discounts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete of X + Y discount","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"discount ID","required":true,"example":1}],"pointer":"/paths/~1api~1xy-discounts~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1xy-discounts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/xy-discounts/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/xy-discounts/{id}","href":"xy-discounts/deletexydiscount","openApiOperationId":"deleteXYDiscount","summary":"Delete of X + Y discount","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1xy-discounts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/xy-discounts/deletexydiscount"}],"panels":[]}]},"httpPath":"/api/xy-discounts/{id}"},{"label":"X + Y discounts settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/getxydiscountssettings","routeSlug":"/shoptet-api/openapi/xy-discounts/getxydiscountssettings","metadata":{"seo":{"title":"X + Y discounts settings","description":"Lists & updates settings of X + Y discounts.Please note, that enableInCashdesk setting is not supported on HU projects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getXYDiscountsSettings","name":"X + Y discounts settings","isWebhook":false,"pointer":"/paths/~1api~1xy-discounts~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"X + Y discounts settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists & updates settings of X + Y discounts."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note, that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enableInCashdesk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting is not supported on HU projects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1xy-discounts~1settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/xy-discounts/settings","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/xy-discounts/settings","href":"xy-discounts/getxydiscountssettings","openApiOperationId":"getXYDiscountsSettings","summary":"X + Y discounts settings","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_738"}},"schemaId":"schema_738"}],"pointer":"/paths/~1api~1xy-discounts~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_738","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_738"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/xy-discounts/getxydiscountssettings"}],"panels":[]}]},"httpPath":"/api/xy-discounts/settings"},{"label":"X + Y discount settings update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/xy-discounts/updatexydiscountsettings","routeSlug":"/shoptet-api/openapi/xy-discounts/updatexydiscountsettings","metadata":{"seo":{"title":"X + Y discount settings update","description":"Updates settings for X + Y discounts. All settings are optional, but atleast one should be present."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateXYDiscountSettings","name":"X + Y discount settings update","isWebhook":false,"pointer":"/paths/~1api~1xy-discounts~1settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"X + Y discount settings update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates settings for X + Y discounts. All settings are optional, but at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"least one should be present."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note, that updating \"enableInCashdesk\" setting on HU projects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will throw an exception."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you're targeting a discount to a specific category, right now, we"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only include products that have"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that category as their primary one. If you want to include all products"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in that category in the discount,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not just the ones in the primary category, please use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryTargeting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all-categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1xy-discounts~1settings/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_739"}},"schemaId":"schema_739","pointer":"/paths/~1api~1xy-discounts~1settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/xy-discounts/settings","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_739"}},"responseCodes":["200","422"],"pointer":"/api/xy-discounts/settings","href":"xy-discounts/updatexydiscountsettings","openApiOperationId":"updateXYDiscountSettings","summary":"X + Y discount settings update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_739","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_739"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_740"}},"schemaId":"schema_740"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1settings/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1settings/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1xy-discounts~1settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_740","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_740"}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1settings/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1xy-discounts~1settings/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/xy-discounts/updatexydiscountsettings"}],"panels":[]}]},"httpPath":"/api/xy-discounts/settings"}],"content":{"contentType":"group","meta":{"name":"XY discounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"XY discounts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing X + Y discounts in the e-shop."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/xy-discounts","summary":"List of X + Y discounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/xy-discounts/getlistofxydiscounts","deprecated":false},{"title":"/api/xy-discounts","summary":"X + Y discount insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/xy-discounts/createxydiscount","deprecated":false},{"title":"/api/xy-discounts/{id}","summary":"Detail of X + Y discounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/xy-discounts/getdetailofxydiscounts","deprecated":false},{"title":"/api/xy-discounts/{id}","summary":"X + Y discount update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/xy-discounts/updatexydiscount","deprecated":false},{"title":"/api/xy-discounts/{id}","summary":"Delete of X + Y discount","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/xy-discounts/deletexydiscount","deprecated":false},{"title":"/api/xy-discounts/settings","summary":"X + Y discounts settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/xy-discounts/getxydiscountssettings","deprecated":false},{"title":"/api/xy-discounts/settings","summary":"X + Y discount settings update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/xy-discounts/updatexydiscountsettings","deprecated":false}]}]}]}]}},{"type":"separator","label":"Categories","content":null},{"type":"group","label":"Categories","link":"/shoptet-api/openapi/categories","routeSlug":"/shoptet-api/openapi/categories","items":[{"label":"List of product categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/getlistofproductcategories","routeSlug":"/shoptet-api/openapi/categories/getlistofproductcategories","metadata":{"seo":{"title":"List of product categories","description":"Returns the list of product categories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductCategories","name":"List of product categories","isWebhook":false,"pointer":"/paths/~1api~1categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of product categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of product categories."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 500. Max value is 1000.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1categories/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/categories","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/categories","href":"categories/getlistofproductcategories","openApiOperationId":"getListOfProductCategories","summary":"List of product categories","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_741"}},"schemaId":"schema_741"}],"pointer":"/paths/~1api~1categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_741","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_741"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/getlistofproductcategories"}],"panels":[]}]},"httpPath":"/api/categories"},{"label":"Product category create","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/createproductcategory","routeSlug":"/shoptet-api/openapi/categories/createproductcategory","metadata":{"seo":{"title":"Product category create","description":"Creates new category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductCategory","name":"Product category create","isWebhook":false,"pointer":"/paths/~1api~1categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product category create","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates new category"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_742"}},"schemaId":"schema_742","pointer":"/paths/~1api~1categories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/categories","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_742"}},"responseCodes":["201"],"pointer":"/api/categories","href":"categories/createproductcategory","openApiOperationId":"createProductCategory","summary":"Product category create","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_742","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_742"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}},"schemaId":"schema_743"}],"pointer":"/paths/~1api~1categories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_743","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/createproductcategory"}],"panels":[]}]},"httpPath":"/api/categories"},{"label":"Product category detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/getproductcategorydetail","routeSlug":"/shoptet-api/openapi/categories/getproductcategorydetail","metadata":{"seo":{"title":"Product category detail","description":"Returns category info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductCategoryDetail","name":"Product category detail","isWebhook":false,"pointer":"/paths/~1api~1categories~1{categoryGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product category detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns category info"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Product category.","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818"}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/categories/{categoryGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/categories/{categoryGuid}","href":"categories/getproductcategorydetail","openApiOperationId":"getProductCategoryDetail","summary":"Product category detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}},"schemaId":"schema_743"}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_743","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/getproductcategorydetail"}],"panels":[]}]},"httpPath":"/api/categories/{categoryGuid}"},{"label":"Product category update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/updateproductcategory","routeSlug":"/shoptet-api/openapi/categories/updateproductcategory","metadata":{"seo":{"title":"Product category update","description":"Updates existing category."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductCategory","name":"Product category update","isWebhook":false,"pointer":"/paths/~1api~1categories~1{categoryGuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product category update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates existing category."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Category's guid","required":true,"example":"bffa3b98-d968-11e0-b04f-57a43310b728"}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_744"}},"schemaId":"schema_744","pointer":"/paths/~1api~1categories~1{categoryGuid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/categories/{categoryGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"bffa3b98-d968-11e0-b04f-57a43310b728","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_744"}},"responseCodes":["200"],"pointer":"/api/categories/{categoryGuid}","href":"categories/updateproductcategory","openApiOperationId":"updateProductCategory","summary":"Product category update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_744","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_744"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}},"schemaId":"schema_743"}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_743","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_743"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/updateproductcategory"}],"panels":[]}]},"httpPath":"/api/categories/{categoryGuid}"},{"label":"Product category deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/deleteproductcategory","routeSlug":"/shoptet-api/openapi/categories/deleteproductcategory","metadata":{"seo":{"title":"Product category deletion","description":"Deletes product category as per entered categoryGuid. If successful,returns the code 200."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProductCategory","name":"Product category deletion","isWebhook":false,"pointer":"/paths/~1api~1categories~1{categoryGuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product category deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes product category as per entered "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If successful,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns the code 200."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the category does not exist within the e-shop, a 404 code is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the category cannot be deleted, because it is used by some product or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has children, a 409 code is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleteUsed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows deleting categories used by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products. The products are marked as changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleteChildren"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows deleting categories with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"child categories. The children are deleted too."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Category guid","required":true,"example":"5c499200-70ac-11e9-9208-08002774f818"}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deleteUsed","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows deleting categories used by products if set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}],"example":true},{"name":"deleteChildren","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows deleting categories with children if set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/categories/{categoryGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"5c499200-70ac-11e9-9208-08002774f818","schemaId":"schema_523"}],"query":[{"name":"deleteUsed","in":"query","example":true,"schemaId":"schema_542"},{"name":"deleteChildren","in":"query","example":true,"schemaId":"schema_542"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","409"],"pointer":"/api/categories/{categoryGuid}","href":"categories/deleteproductcategory","openApiOperationId":"deleteProductCategory","summary":"Product category deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}/delete/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1categories~1{categoryGuid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/deleteproductcategory"}],"panels":[]}]},"httpPath":"/api/categories/{categoryGuid}"},{"label":"Product category BATCH update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/updateproductcategorybatch","routeSlug":"/shoptet-api/openapi/categories/updateproductcategorybatch","metadata":{"seo":{"title":"Product category BATCH update","description":"This endpoint allows you to update multiple categories at once. Batchupdate is processed asynchronously in same way as for example productssnapshot, but it does not have resultUrl with categories to download inresponse. Instead, you can check attribute log which containssuccessfully updated categories and errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductCategoryBatch","name":"Product category BATCH update","isWebhook":false,"pointer":"/paths/~1api~1categories~1batch/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product category BATCH update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to update multiple categories at once. Batch"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update is processed asynchronously in same way as for example products"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snapshot, but it does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with categories to download in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response. Instead, you can check attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"log"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successfully updated categories and errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File with data for update must be in JSONL ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") format. Each line must contain one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category in JSON format. Maximum size of file is 100MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structure of JSON row is same as structure of JSON for single category"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update above. You can add one extra optional attribute \"language\" which defines language of updating category, so you are able"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to update multiple language attributes (i.e. \"name\", \"description\" etc.) of one category in one batch file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If language is not defined, default language of shop is used. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/batch/categorybatchupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category batch update schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous job process jsonl file row by row and try to validate and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"save data. If there is any error, row is skipped and error is logged,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but it does not stop processing of other rows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Log, every product is identified by its position in file (starting from 1)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories~1batch/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","pointer":"/paths/~1api~1categories~1batch/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/categories/batch","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_544"}},"responseCodes":["202","404","409"],"pointer":"/api/categories/batch","href":"categories/updateproductcategorybatch","openApiOperationId":"updateProductCategoryBatch","summary":"Product category BATCH update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1categories~1batch/patch/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1categories~1batch/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1batch/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1batch/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1categories~1batch/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"404","exampleIds":["paths/~1api~1categories~1batch/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1categories~1batch/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1batch/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1batch/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/updateproductcategorybatch"}],"panels":[]}]},"httpPath":"/api/categories/batch"},{"label":"Category products priority BATCH update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/updatecategoryproductsprioritybatch","routeSlug":"/shoptet-api/openapi/categories/updatecategoryproductsprioritybatch","metadata":{"seo":{"title":"Category products priority BATCH update","description":"This endpoint allows you to update multiple categories with product priorities at once. Batchupdate is processed asynchronously in same way as for example productssnapshot, but it does not have resultUrl in response. Instead, you can check attribute log which containssuccessfully updated categories and errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCategoryProductsPriorityBatch","name":"Category products priority BATCH update","isWebhook":false,"pointer":"/paths/~1api~1categories~1products-priority~1batch/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Category products priority BATCH update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to update multiple categories with product priorities at once. Batch"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update is processed asynchronously in same way as for example products"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snapshot, but it does not have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in response. Instead, you can check attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"log"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which contains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successfully updated categories and errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File with data for update must be in JSONL ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonlines.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jsonlines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") format. Each line must contain one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category with product priorities in JSON format. Maximum size of file is 100MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structure of JSON row is defined by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/shoptet-api/openapi/batch/categoryproductprioritybatchupdate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category product priority batch update schema"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item must identify the product by either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(exactly one must be provided per item)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous job process jsonl file row by row and try to validate and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"save data. If there is any error in a row, the failed products are skipped and errors are logged,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but it does not stop processing of other rows or other products within the same row."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Log, every row is identified by its position in file (starting from 1). Within a row, failed products are identified by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories~1products-priority~1batch/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","pointer":"/paths/~1api~1categories~1products-priority~1batch/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/categories/products-priority/batch","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_544"}},"responseCodes":["202","404","409"],"pointer":"/api/categories/products-priority/batch","href":"categories/updatecategoryproductsprioritybatch","openApiOperationId":"updateCategoryProductsPriorityBatch","summary":"Category products priority BATCH update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1categories~1products-priority~1batch/patch/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1api~1categories~1products-priority~1batch/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1products-priority~1batch/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1products-priority~1batch/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1api~1categories~1products-priority~1batch/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"code":"404","exampleIds":["paths/~1api~1categories~1products-priority~1batch/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1api~1categories~1products-priority~1batch/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1products-priority~1batch/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1products-priority~1batch/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/updatecategoryproductsprioritybatch"}],"panels":[]}]},"httpPath":"/api/categories/products-priority/batch"},{"label":"List of products order in category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/getlistofproductsorderincategory","routeSlug":"/shoptet-api/openapi/categories/getlistofproductsorderincategory","metadata":{"seo":{"title":"List of products order in category","description":"Retrieves products and their priorities within a category."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductsOrderInCategory","name":"List of products order in category","isWebhook":false,"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of products order in category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves products and their priorities within a category."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Product category.","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818"}],"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 500. Max value is 2000.","example":888},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/categories/{categoryGuid}/productsPriority","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818","schemaId":"schema_523"}],"query":[{"name":"itemsPerPage","in":"query","example":888,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/categories/{categoryGuid}/productsPriority","href":"categories/getlistofproductsorderincategory","openApiOperationId":"getListOfProductsOrderInCategory","summary":"List of products order in category","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_745"}},"schemaId":"schema_745"}],"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_745","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_745"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/getlistofproductsorderincategory"}],"panels":[]}]},"httpPath":"/api/categories/{categoryGuid}/productsPriority"},{"label":"Update product order in category","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/categories/updateproductorderincategory","routeSlug":"/shoptet-api/openapi/categories/updateproductorderincategory","metadata":{"seo":{"title":"Update product order in category","description":"Using this endpoint you can update product priority within a category."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductOrderInCategory","name":"Update product order in category","isWebhook":false,"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update product order in category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using this endpoint you can update product priority within a category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request multiple updates at once; the maximum is 300 updates per"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item must identify the product by either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(exactly one must be provided per item)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case of a partial failure, the response code will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"errorneous items will be"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"listed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. In case of a complete failure, response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 BAD REQUEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum priority is 0, maximum priority is 65535."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Product category.","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818"}],"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_746"}},"schemaId":"schema_746","pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/categories/{categoryGuid}/productsPriority","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_746"}},"responseCodes":["200","400"],"pointer":"/api/categories/{categoryGuid}/productsPriority","href":"categories/updateproductorderincategory","openApiOperationId":"updateProductOrderInCategory","summary":"Update product order in category","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_746","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_746"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/responses/400/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/updateproductorderincategory"}],"panels":[]}]},"httpPath":"/api/categories/{categoryGuid}/productsPriority"}],"content":{"contentType":"group","meta":{"name":"Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Categories","showPageActions":true},{"nodeType":"markdoc","content":"Managing categories in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/categories","summary":"List of product categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categories/getlistofproductcategories","deprecated":false},{"title":"/api/categories","summary":"Product category create","prefix":{"name":"post","color":"post"},"badges":[],"link":"/categories/createproductcategory","deprecated":false},{"title":"/api/categories/{categoryGuid}","summary":"Product category detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categories/getproductcategorydetail","deprecated":false},{"title":"/api/categories/{categoryGuid}","summary":"Product category update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/categories/updateproductcategory","deprecated":false},{"title":"/api/categories/{categoryGuid}","summary":"Product category deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/categories/deleteproductcategory","deprecated":false},{"title":"/api/categories/batch","summary":"Product category BATCH update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/categories/updateproductcategorybatch","deprecated":false},{"title":"/api/categories/products-priority/batch","summary":"Category products priority BATCH update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/categories/updatecategoryproductsprioritybatch","deprecated":false},{"title":"/api/categories/{categoryGuid}/productsPriority","summary":"List of products order in category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categories/getlistofproductsorderincategory","deprecated":false},{"title":"/api/categories/{categoryGuid}/productsPriority","summary":"Update product order in category","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/categories/updateproductorderincategory","deprecated":false}]}]}]}]}},{"type":"group","label":"Parametric categories","link":"/shoptet-api/openapi/parametric-categories","routeSlug":"/shoptet-api/openapi/parametric-categories","items":[{"label":"List of parametric categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/getlistofparametriccategories","routeSlug":"/shoptet-api/openapi/parametric-categories/getlistofparametriccategories","metadata":{"seo":{"title":"List of parametric categories","description":"Returns the list of product categories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfParametricCategories","name":"List of parametric categories","isWebhook":false,"pointer":"/paths/~1api~1parametric-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of parametric categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of product categories."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include additional data in response. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"parameters"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 100.","example":90},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1parametric-categories/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1parametric-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/parametric-categories","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"parameters","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":90,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/parametric-categories","href":"parametric-categories/getlistofparametriccategories","openApiOperationId":"getListOfParametricCategories","summary":"List of parametric categories","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_747"}},"schemaId":"schema_747"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1parametric-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_747","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_747"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parametric-categories/getlistofparametriccategories"}],"panels":[]}]},"httpPath":"/api/parametric-categories"},{"label":"Creation of parametric category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/createparametriccategory","routeSlug":"/shoptet-api/openapi/parametric-categories/createparametriccategory","metadata":{"seo":{"title":"Creation of parametric category","description":"Creates a new combination for a parametric category."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createParametricCategory","name":"Creation of parametric category","isWebhook":false,"pointer":"/paths/~1api~1parametric-categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of parametric category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new combination for a parametric category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Before creating a combination, a parametric category definition for the selected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameterCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the given category must exist. Create one via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /parametric-categories-definition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To discover which "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameterCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are available for a category, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /parametric-categories-available-parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create only one parametric category combination for each combination of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameterCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valueCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Advanced SEO\" module must be active to use this endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include additional data in response. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"parameters"}],"pointer":"/paths/~1api~1parametric-categories/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1parametric-categories/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_748"}},"schemaId":"schema_748","pointer":"/paths/~1api~1parametric-categories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/parametric-categories","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"parameters","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_748"}},"responseCodes":["201","403","422"],"pointer":"/api/parametric-categories","href":"parametric-categories/createparametriccategory","openApiOperationId":"createParametricCategory","summary":"Creation of parametric category","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_748","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_748"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_749"}},"schemaId":"schema_749"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/post/responses/403/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1parametric-categories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_749","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_749"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/post/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parametric-categories/createparametriccategory"}],"panels":[]}]},"httpPath":"/api/parametric-categories"},{"label":"Parametric category detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/getparametriccategorydetail","routeSlug":"/shoptet-api/openapi/parametric-categories/getparametriccategorydetail","metadata":{"seo":{"title":"Parametric category detail","description":"Returns parametric category info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getParametricCategoryDetail","name":"Parametric category detail","isWebhook":false,"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Parametric category detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns parametric category info."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Guid of parametric category.","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818"}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/parametric-categories/{categoryGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/parametric-categories/{categoryGuid}","href":"parametric-categories/getparametriccategorydetail","openApiOperationId":"getParametricCategoryDetail","summary":"Parametric category detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_749"}},"schemaId":"schema_749"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_749","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_749"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parametric-categories/getparametriccategorydetail"}],"panels":[]}]},"httpPath":"/api/parametric-categories/{categoryGuid}"},{"label":"Update of parametric category","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/updateparametriccategory","routeSlug":"/shoptet-api/openapi/parametric-categories/updateparametriccategory","metadata":{"seo":{"title":"Update of parametric category","description":"Updates existing parametric category."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateParametricCategory","name":"Update of parametric category","isWebhook":false,"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of parametric category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates existing parametric category. \n\nThe \"Advanced SEO\" module must be active to use this endpoint.\n\nThis endpoint is language dependent. While active module \"Foreign languages\" \nyou can use language query parameter to specify the language of updated parametric category."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Guid of parametric category.","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818"}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_750"}},"schemaId":"schema_750","pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/parametric-categories/{categoryGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_750"}},"responseCodes":["200","403","404"],"pointer":"/api/parametric-categories/{categoryGuid}","href":"parametric-categories/updateparametriccategory","openApiOperationId":"updateParametricCategory","summary":"Update of parametric category","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_750","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_750"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_749"}},"schemaId":"schema_749"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_749","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_749"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parametric-categories/updateparametriccategory"}],"panels":[]}]},"httpPath":"/api/parametric-categories/{categoryGuid}"},{"label":"Delete of parametric category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/deleteparametriccategory","routeSlug":"/shoptet-api/openapi/parametric-categories/deleteparametriccategory","metadata":{"seo":{"title":"Delete of parametric category","description":"Delete existing parametric category. The \"Advanced SEO\" module must be active to use this endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteParametricCategory","name":"Delete of parametric category","isWebhook":false,"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete of parametric category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete existing parametric category. The \"Advanced SEO\" module must be active to use this endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Guid of parametric category.","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818"}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/parametric-categories/{categoryGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/parametric-categories/{categoryGuid}","href":"parametric-categories/deleteparametriccategory","openApiOperationId":"deleteParametricCategory","summary":"Delete of parametric category","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parametric-categories/deleteparametriccategory"}],"panels":[]}]},"httpPath":"/api/parametric-categories/{categoryGuid}"},{"label":"Parametric category available parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/getparametriccategoryavailableparameters","routeSlug":"/shoptet-api/openapi/parametric-categories/getparametriccategoryavailableparameters","metadata":{"seo":{"title":"Parametric category available parameters","description":"Returns all available parameters for a parent category that can be used when creating parametric categories and their combinations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getParametricCategoryAvailableParameters","name":"Parametric category available parameters","isWebhook":false,"pointer":"/paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Parametric category available parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all available parameters for a parent category that can be used when creating\nparametric categories and their combinations.\n\nThe \"Advanced SEO\" module must be active to use this endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryGuid","in":"path","schemaId":"schema_523","description":"Guid of the parent category.","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818"}],"pointer":"/paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/parametric-categories-available-parameters/{categoryGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"categoryGuid","in":"path","required":true,"example":"5c498fb7-70ac-11e9-9208-08002774f818","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/parametric-categories-available-parameters/{categoryGuid}","href":"parametric-categories/getparametriccategoryavailableparameters","openApiOperationId":"getParametricCategoryAvailableParameters","summary":"Parametric category available parameters","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_751"}},"schemaId":"schema_751"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_751","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_751"}}},{"code":"403","schemaId":"schema_568","exampleIds":["paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_568","exampleIds":["paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parametric-categories/getparametriccategoryavailableparameters"}],"panels":[]}]},"httpPath":"/api/parametric-categories-available-parameters/{categoryGuid}"},{"label":"Creation of parametric category definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/parametric-categories/createparametriccategorydefinition","routeSlug":"/shoptet-api/openapi/parametric-categories/createparametriccategorydefinition","metadata":{"seo":{"title":"Creation of parametric category definition","description":"Creates a new parametric category definition for a given category and set of parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createParametricCategoryDefinition","name":"Creation of parametric category definition","isWebhook":false,"pointer":"/paths/~1api~1parametric-categories-definition/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of parametric category definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new parametric category definition for a given category and set of parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The definition specifies which parameters are used to generate parametric category pages for the specified category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify 1 to 4 parameters. Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameterCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must exist and must be unique within the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one definition with the same set of parameters can exist per category."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Advanced SEO\" module must be active to use this endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1parametric-categories-definition/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_752"}},"schemaId":"schema_752","pointer":"/paths/~1api~1parametric-categories-definition/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/parametric-categories-definition","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_752"}},"responseCodes":["201","403","422"],"pointer":"/api/parametric-categories-definition","href":"parametric-categories/createparametriccategorydefinition","openApiOperationId":"createParametricCategoryDefinition","summary":"Creation of parametric category definition","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_752","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_752"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories-definition/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories-definition/post/responses/403/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories-definition/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories-definition/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1parametric-categories-definition/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories-definition/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories-definition/post/responses/403/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories-definition/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1parametric-categories-definition/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parametric-categories/createparametriccategorydefinition"}],"panels":[]}]},"httpPath":"/api/parametric-categories-definition"}],"content":{"contentType":"group","meta":{"name":"Parametric categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Parametric categories","showPageActions":true},{"nodeType":"markdoc","content":"Managing parametric categories in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/parametric-categories","summary":"List of parametric categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parametric-categories/getlistofparametriccategories","deprecated":false},{"title":"/api/parametric-categories","summary":"Creation of parametric category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/parametric-categories/createparametriccategory","deprecated":false},{"title":"/api/parametric-categories/{categoryGuid}","summary":"Parametric category detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parametric-categories/getparametriccategorydetail","deprecated":false},{"title":"/api/parametric-categories/{categoryGuid}","summary":"Update of parametric category","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/parametric-categories/updateparametriccategory","deprecated":false},{"title":"/api/parametric-categories/{categoryGuid}","summary":"Delete of parametric category","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/parametric-categories/deleteparametriccategory","deprecated":false},{"title":"/api/parametric-categories-available-parameters/{categoryGuid}","summary":"Parametric category available parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parametric-categories/getparametriccategoryavailableparameters","deprecated":false},{"title":"/api/parametric-categories-definition","summary":"Creation of parametric category definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/parametric-categories/createparametriccategorydefinition","deprecated":false}]}]}]}]}},{"type":"separator","label":"Settings","content":null},{"type":"group","label":"Consumption taxes","link":"/shoptet-api/openapi/consumption-taxes","routeSlug":"/shoptet-api/openapi/consumption-taxes","items":[{"label":"List of product consumption taxes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/consumption-taxes/getlistofconsumptiontaxes","routeSlug":"/shoptet-api/openapi/consumption-taxes/getlistofconsumptiontaxes","metadata":{"seo":{"title":"List of product consumption taxes","description":"Returns the list of consumption taxes within the e-shop. In order to list consuption taxes, you will need to have the Consumption tax module activated on the customer's e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfConsumptionTaxes","name":"List of product consumption taxes","isWebhook":false,"pointer":"/paths/~1api~1products~1consumption-taxes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of product consumption taxes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of consumption taxes within the e-shop.\nIn order to list consuption taxes, you will need to have the Consumption tax module activated on the customer's e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1consumption-taxes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/consumption-taxes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/api/products/consumption-taxes","href":"consumption-taxes/getlistofconsumptiontaxes","openApiOperationId":"getListOfConsumptionTaxes","summary":"List of product consumption taxes","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_753"}},"schemaId":"schema_753"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1consumption-taxes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_753","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_753"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumption-taxes/getlistofconsumptiontaxes"}],"panels":[]}]},"httpPath":"/api/products/consumption-taxes"},{"label":"Creation of consumption tax","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/consumption-taxes/createconsumptiontax","routeSlug":"/shoptet-api/openapi/consumption-taxes/createconsumptiontax","metadata":{"seo":{"title":"Creation of consumption tax","description":"Creation of consumption tax"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConsumptionTax","name":"Creation of consumption tax","isWebhook":false,"pointer":"/paths/~1api~1products~1consumption-taxes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of consumption tax","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1consumption-taxes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_754"}},"schemaId":"schema_754","pointer":"/paths/~1api~1products~1consumption-taxes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/consumption-taxes","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_754"}},"responseCodes":["201","409","422"],"pointer":"/api/products/consumption-taxes","href":"consumption-taxes/createconsumptiontax","openApiOperationId":"createConsumptionTax","summary":"Creation of consumption tax","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_754","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_754"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_755"}},"schemaId":"schema_755"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1consumption-taxes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_755","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_755"}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumption-taxes/createconsumptiontax"}],"panels":[]}]},"httpPath":"/api/products/consumption-taxes"},{"label":"Update of consumption tax","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/consumption-taxes/updateconsumptiontax","routeSlug":"/shoptet-api/openapi/consumption-taxes/updateconsumptiontax","metadata":{"seo":{"title":"Update of consumption tax","description":"Update of consumption tax"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateConsumptionTax","name":"Update of consumption tax","isWebhook":false,"pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of consumption tax","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"consumption tax identifier","required":true,"example":8}],"pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_756"}},"schemaId":"schema_756","pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/consumption-taxes/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":8,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_756"}},"responseCodes":["200","404","409","422"],"pointer":"/api/products/consumption-taxes/{id}","href":"consumption-taxes/updateconsumptiontax","openApiOperationId":"updateConsumptionTax","summary":"Update of consumption tax","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_756","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_756"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_755"}},"schemaId":"schema_755"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/409/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_755","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_755"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumption-taxes/updateconsumptiontax"}],"panels":[]}]},"httpPath":"/api/products/consumption-taxes/{id}"},{"label":"Deletion of consumption tax","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/consumption-taxes/deleteconsumptiontax","routeSlug":"/shoptet-api/openapi/consumption-taxes/deleteconsumptiontax","metadata":{"seo":{"title":"Deletion of consumption tax","description":"Deletion of consumption tax"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConsumptionTax","name":"Deletion of consumption tax","isWebhook":false,"pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of consumption tax","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"consumption tax identifier","required":true,"example":8}],"pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/consumption-taxes/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":8,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/products/consumption-taxes/{id}","href":"consumption-taxes/deleteconsumptiontax","openApiOperationId":"deleteConsumptionTax","summary":"Deletion of consumption tax","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1products~1consumption-taxes~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1products~1consumption-taxes~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumption-taxes/deleteconsumptiontax"}],"panels":[]}]},"httpPath":"/api/products/consumption-taxes/{id}"}],"content":{"contentType":"group","meta":{"name":"Consumption taxes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumption taxes","showPageActions":true},{"nodeType":"markdoc","content":"Managing consumption taxes in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/consumption-taxes","summary":"List of product consumption taxes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/consumption-taxes/getlistofconsumptiontaxes","deprecated":false},{"title":"/api/products/consumption-taxes","summary":"Creation of consumption tax","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consumption-taxes/createconsumptiontax","deprecated":false},{"title":"/api/products/consumption-taxes/{id}","summary":"Update of consumption tax","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/consumption-taxes/updateconsumptiontax","deprecated":false},{"title":"/api/products/consumption-taxes/{id}","summary":"Deletion of consumption tax","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/consumption-taxes/deleteconsumptiontax","deprecated":false}]}]}]}]}},{"type":"group","label":"Eshop","link":"/shoptet-api/openapi/eshop","routeSlug":"/shoptet-api/openapi/eshop","items":[{"label":"Eshop info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/eshop/geteshopinfo","routeSlug":"/shoptet-api/openapi/eshop/geteshopinfo","metadata":{"seo":{"title":"Eshop info","description":"Information about queried e-shop (defined by token). Returns the contact data and e-shop settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEshopInfo","name":"Eshop info","isWebhook":false,"pointer":"/paths/~1api~1eshop/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Eshop info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about queried e-shop (defined by token). Returns the contact data and e-shop settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has several sections, which are only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you state the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter within the URL, information about the image cut will also be part of the response. For more information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"about the chapter "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Product-images"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product images"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that languages section has meaning only if module foreign languages (Cizí jazyky) is enabled on current eshop. Otherwise you have to follow \"eshopLanguage\" attribute."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderAdditionalFields"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order can contain up to six additional fields, which can be freely used by the e-shop for its individual needs. The field names can be defined in administration and this section returns their names."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orderStatuses"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order statuses, as defined for this e-shop."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentMethods"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment methods, as defined for this e-shop."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shippingMethods"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transportation options, as defined for this e-shop."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"imageCuts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information on image cuts (various sizes of the same image)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"countries"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informations about eshop supported countries (name, validation atterns, ...)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cashDesk"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informations about eshop cash desk configuration"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"orderAdditionalFields,orderStatuses,paymentMethods,shippingMethods,imageCuts,countries,cashDesk"}],"pointer":"/paths/~1api~1eshop/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1eshop/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/eshop","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"orderAdditionalFields,orderStatuses,paymentMethods,shippingMethods,imageCuts,countries,cashDesk","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/eshop","href":"eshop/geteshopinfo","openApiOperationId":"getEshopInfo","summary":"Eshop info","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_757"}},"schemaId":"schema_757"}],"pointer":"/paths/~1api~1eshop/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_757","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_757"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eshop/geteshopinfo"}],"panels":[]}]},"httpPath":"/api/eshop"},{"label":"E-shop design","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/eshop/geteshopdesign","routeSlug":"/shoptet-api/openapi/eshop/geteshopdesign","metadata":{"seo":{"title":"E-shop design","description":"Information about queried e-shop template setting (defined by token).backgroundImage value can internally contain the link to a transparentreference gif, in this case the API returns a NULL value."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEshopDesign","name":"E-shop design","isWebhook":false,"pointer":"/paths/~1api~1eshop~1design/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"E-shop design","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about queried e-shop template setting (defined by token)."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backgroundImage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value can internally contain the link to a transparent"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reference gif, in this case the API returns a NULL value."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1eshop~1design/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/eshop/design","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/eshop/design","href":"eshop/geteshopdesign","openApiOperationId":"getEshopDesign","summary":"E-shop design","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}},"schemaId":"schema_758"}],"pointer":"/paths/~1api~1eshop~1design/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_758","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_758"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eshop/geteshopdesign"}],"panels":[]}]},"httpPath":"/api/eshop/design"},{"label":"E-shop document settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/eshop/geteshopdocumentsettings","routeSlug":"/shoptet-api/openapi/eshop/geteshopdocumentsettings","metadata":{"seo":{"title":"E-shop document settings","description":"Information about financial documents settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEshopDocumentSettings","name":"E-shop document settings","isWebhook":false,"pointer":"/paths/~1api~1eshop~1document-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"E-shop document settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Information about financial documents settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1eshop~1document-settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/eshop/document-settings","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/eshop/document-settings","href":"eshop/geteshopdocumentsettings","openApiOperationId":"getEshopDocumentSettings","summary":"E-shop document settings","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_759"}},"schemaId":"schema_759"}],"pointer":"/paths/~1api~1eshop~1document-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_759","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_759"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eshop/geteshopdocumentsettings"}],"panels":[]}]},"httpPath":"/api/eshop/document-settings"},{"label":"E-shop mandatory fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/eshop/geteshopmandatoryfields","routeSlug":"/shoptet-api/openapi/eshop/geteshopmandatoryfields","metadata":{"seo":{"title":"E-shop mandatory fields","description":"Information about queried e-shop mandatory fields setting (defined by token).Returns the values, which are set by e-shop administrator inSettings -> Customers -> Mandatory fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEshopMandatoryFields","name":"E-shop mandatory fields","isWebhook":false,"pointer":"/paths/~1api~1eshop~1customer-fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"E-shop mandatory fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about queried e-shop mandatory fields setting (defined by token)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the values, which are set by e-shop administrator in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> Customers -> Mandatory fields."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1eshop~1customer-fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/eshop/customer-fields","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/eshop/customer-fields","href":"eshop/geteshopmandatoryfields","openApiOperationId":"getEshopMandatoryFields","summary":"E-shop mandatory fields","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_760"}},"schemaId":"schema_760"}],"pointer":"/paths/~1api~1eshop~1customer-fields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_760","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_760"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eshop/geteshopmandatoryfields"}],"panels":[]}]},"httpPath":"/api/eshop/customer-fields"}],"content":{"contentType":"group","meta":{"name":"Eshop"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Eshop","showPageActions":true},{"nodeType":"markdoc","content":"General information about the e-shop settings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/eshop","summary":"Eshop info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eshop/geteshopinfo","deprecated":false},{"title":"/api/eshop/design","summary":"E-shop design","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eshop/geteshopdesign","deprecated":false},{"title":"/api/eshop/document-settings","summary":"E-shop document settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eshop/geteshopdocumentsettings","deprecated":false},{"title":"/api/eshop/customer-fields","summary":"E-shop mandatory fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eshop/geteshopmandatoryfields","deprecated":false}]}]}]}]}},{"type":"group","label":"Filtering parameters","link":"/shoptet-api/openapi/filtering-parameters","routeSlug":"/shoptet-api/openapi/filtering-parameters","items":[{"label":"List of filtering parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/getlistoffilteringparameters","routeSlug":"/shoptet-api/openapi/filtering-parameters/getlistoffilteringparameters","metadata":{"seo":{"title":"List of filtering parameters","description":"Returns the list of available filtering parameters with their available values within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfFilteringParameters","name":"List of filtering parameters","isWebhook":false,"pointer":"/paths/~1api~1products~1filtering-parameters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of filtering parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of available filtering parameters with their available values within the e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 100.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1products~1filtering-parameters/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1filtering-parameters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/filtering-parameters","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/filtering-parameters","href":"filtering-parameters/getlistoffilteringparameters","openApiOperationId":"getListOfFilteringParameters","summary":"List of filtering parameters","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_761"}},"schemaId":"schema_761"}],"pointer":"/paths/~1api~1products~1filtering-parameters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_761","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_761"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filtering-parameters/getlistoffilteringparameters"}],"panels":[]}]},"httpPath":"/api/products/filtering-parameters"},{"label":"Creation of filtering parameter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/createfilteringparameter","routeSlug":"/shoptet-api/openapi/filtering-parameters/createfilteringparameter","metadata":{"seo":{"title":"Creation of filtering parameter","description":"Creation of filtering parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFilteringParameter","name":"Creation of filtering parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1filtering-parameters/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of filtering parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1filtering-parameters/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_762"}},"schemaId":"schema_762","pointer":"/paths/~1api~1products~1filtering-parameters/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/filtering-parameters","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_762"}},"responseCodes":["201"],"pointer":"/api/products/filtering-parameters","href":"filtering-parameters/createfilteringparameter","openApiOperationId":"createFilteringParameter","summary":"Creation of filtering parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_762","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_762"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}},"schemaId":"schema_763"}],"pointer":"/paths/~1api~1products~1filtering-parameters/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_763","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filtering-parameters/createfilteringparameter"}],"panels":[]}]},"httpPath":"/api/products/filtering-parameters"},{"label":"Detail of filtering parameter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/getdetailoffilteringparameter","routeSlug":"/shoptet-api/openapi/filtering-parameters/getdetailoffilteringparameter","metadata":{"seo":{"title":"Detail of filtering parameter","description":"Detail of filtering parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfFilteringParameter","name":"Detail of filtering parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of filtering parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"material"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/filtering-parameters/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"material","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/filtering-parameters/{code}","href":"filtering-parameters/getdetailoffilteringparameter","openApiOperationId":"getDetailOfFilteringParameter","summary":"Detail of filtering parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}},"schemaId":"schema_763"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_763","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filtering-parameters/getdetailoffilteringparameter"}],"panels":[]}]},"httpPath":"/api/products/filtering-parameters/{code}"},{"label":"Update of filtering parameter","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/updatefilteringparameter","routeSlug":"/shoptet-api/openapi/filtering-parameters/updatefilteringparameter","metadata":{"seo":{"title":"Update of filtering parameter","description":"Update of filtering parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFilteringParameter","name":"Update of filtering parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of filtering parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"material"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_764"}},"schemaId":"schema_764","pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/filtering-parameters/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"material","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_764"}},"responseCodes":["200"],"pointer":"/api/products/filtering-parameters/{code}","href":"filtering-parameters/updatefilteringparameter","openApiOperationId":"updateFilteringParameter","summary":"Update of filtering parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_764","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_764"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}},"schemaId":"schema_763"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_763","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filtering-parameters/updatefilteringparameter"}],"panels":[]}]},"httpPath":"/api/products/filtering-parameters/{code}"},{"label":"Creation of filtering parameter value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/createfilteringparametervalue","routeSlug":"/shoptet-api/openapi/filtering-parameters/createfilteringparametervalue","metadata":{"seo":{"title":"Creation of filtering parameter value","description":"Creation of filtering parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFilteringParameterValue","name":"Creation of filtering parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of filtering parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"material"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_765"}},"schemaId":"schema_765","pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/filtering-parameters/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"material","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_765"}},"responseCodes":["201"],"pointer":"/api/products/filtering-parameters/{code}","href":"filtering-parameters/createfilteringparametervalue","openApiOperationId":"createFilteringParameterValue","summary":"Creation of filtering parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_765","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_765"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}},"schemaId":"schema_763"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_763","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filtering-parameters/createfilteringparametervalue"}],"panels":[]}]},"httpPath":"/api/products/filtering-parameters/{code}"},{"label":"Removal of filtering parameter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/deletefilteringparameter","routeSlug":"/shoptet-api/openapi/filtering-parameters/deletefilteringparameter","metadata":{"seo":{"title":"Removal of filtering parameter","description":"Removal of filtering parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFilteringParameter","name":"Removal of filtering parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removal of filtering parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"strih-2"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/filtering-parameters/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"strih-2","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/filtering-parameters/{code}","href":"filtering-parameters/deletefilteringparameter","openApiOperationId":"deleteFilteringParameter","summary":"Removal of filtering parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filtering-parameters/deletefilteringparameter"}],"panels":[]}]},"httpPath":"/api/products/filtering-parameters/{code}"},{"label":"Removal of filtering parameter value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/deletefilteringparametervalue","routeSlug":"/shoptet-api/openapi/filtering-parameters/deletefilteringparametervalue","metadata":{"seo":{"title":"Removal of filtering parameter value","description":"Removal of filtering parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFilteringParameterValue","name":"Removal of filtering parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removal of filtering parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"pohlavi"},{"name":"valueIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"muz"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/filtering-parameters/{code}/{valueIndex}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"pohlavi","schemaId":"schema_523"},{"name":"valueIndex","in":"path","required":true,"example":"muz","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/filtering-parameters/{code}/{valueIndex}","href":"filtering-parameters/deletefilteringparametervalue","openApiOperationId":"deleteFilteringParameterValue","summary":"Removal of filtering parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filtering-parameters/deletefilteringparametervalue"}],"panels":[]}]},"httpPath":"/api/products/filtering-parameters/{code}/{valueIndex}"},{"label":"Update of filtering parameter value","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/filtering-parameters/updatefilteringparametervalue","routeSlug":"/shoptet-api/openapi/filtering-parameters/updatefilteringparametervalue","metadata":{"seo":{"title":"Update of filtering parameter value","description":"Update of filtering parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFilteringParameterValue","name":"Update of filtering parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of filtering parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"material"},{"name":"valueIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"bavlna"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_766"}},"schemaId":"schema_766","pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/filtering-parameters/{code}/{valueIndex}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"material","schemaId":"schema_523"},{"name":"valueIndex","in":"path","required":true,"example":"bavlna","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_766"}},"responseCodes":["200"],"pointer":"/api/products/filtering-parameters/{code}/{valueIndex}","href":"filtering-parameters/updatefilteringparametervalue","openApiOperationId":"updateFilteringParameterValue","summary":"Update of filtering parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_766","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_766"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}},"schemaId":"schema_763"}],"pointer":"/paths/~1api~1products~1filtering-parameters~1{code}~1{valueIndex}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_763","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_763"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/filtering-parameters/updatefilteringparametervalue"}],"panels":[]}]},"httpPath":"/api/products/filtering-parameters/{code}/{valueIndex}"}],"content":{"contentType":"group","meta":{"name":"Filtering parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Filtering parameters","showPageActions":true},{"nodeType":"markdoc","content":"Managing filtering parameters in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/filtering-parameters","summary":"List of filtering parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/filtering-parameters/getlistoffilteringparameters","deprecated":false},{"title":"/api/products/filtering-parameters","summary":"Creation of filtering parameter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/filtering-parameters/createfilteringparameter","deprecated":false},{"title":"/api/products/filtering-parameters/{code}","summary":"Detail of filtering parameter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/filtering-parameters/getdetailoffilteringparameter","deprecated":false},{"title":"/api/products/filtering-parameters/{code}","summary":"Update of filtering parameter","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/filtering-parameters/updatefilteringparameter","deprecated":false},{"title":"/api/products/filtering-parameters/{code}","summary":"Creation of filtering parameter value","prefix":{"name":"post","color":"post"},"badges":[],"link":"/filtering-parameters/createfilteringparametervalue","deprecated":false},{"title":"/api/products/filtering-parameters/{code}","summary":"Removal of filtering parameter","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/filtering-parameters/deletefilteringparameter","deprecated":false},{"title":"/api/products/filtering-parameters/{code}/{valueIndex}","summary":"Removal of filtering parameter value","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/filtering-parameters/deletefilteringparametervalue","deprecated":false},{"title":"/api/products/filtering-parameters/{code}/{valueIndex}","summary":"Update of filtering parameter value","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/filtering-parameters/updatefilteringparametervalue","deprecated":false}]}]}]}]}},{"type":"group","label":"Flags","link":"/shoptet-api/openapi/flags","routeSlug":"/shoptet-api/openapi/flags","items":[{"label":"List of products flags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/flags/getlistofproductsflags","routeSlug":"/shoptet-api/openapi/flags/getlistofproductsflags","metadata":{"seo":{"title":"List of products flags","description":"Returns the list of product flags within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductsFlags","name":"List of products flags","isWebhook":false,"pointer":"/paths/~1api~1products~1flags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of products flags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of product flags within the e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1flags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/flags","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/flags","href":"flags/getlistofproductsflags","openApiOperationId":"getListOfProductsFlags","summary":"List of products flags","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767"}},"schemaId":"schema_767"}],"pointer":"/paths/~1api~1products~1flags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_767","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/flags/getlistofproductsflags"}],"panels":[]}]},"httpPath":"/api/products/flags"},{"label":"Product flag insertion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/flags/createproductflag","routeSlug":"/shoptet-api/openapi/flags/createproductflag","metadata":{"seo":{"title":"Product flag insertion","description":"Product flag insertion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductFlag","name":"Product flag insertion","isWebhook":false,"pointer":"/paths/~1api~1products~1flags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product flag insertion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1flags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_768"}},"schemaId":"schema_768","pointer":"/paths/~1api~1products~1flags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/flags","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_768"}},"responseCodes":["200"],"pointer":"/api/products/flags","href":"flags/createproductflag","openApiOperationId":"createProductFlag","summary":"Product flag insertion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_768","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_768"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767"}},"schemaId":"schema_767"}],"pointer":"/paths/~1api~1products~1flags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_767","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/flags/createproductflag"}],"panels":[]}]},"httpPath":"/api/products/flags"},{"label":"Product flag update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/flags/updateproductflag","routeSlug":"/shoptet-api/openapi/flags/updateproductflag","metadata":{"seo":{"title":"Product flag update","description":"Updates the flag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductFlag","name":"Product flag update","isWebhook":false,"pointer":"/paths/~1api~1products~1flags~1{code}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product flag update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the flag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"action"}],"pointer":"/paths/~1api~1products~1flags~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1flags~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_769"}},"schemaId":"schema_769","pointer":"/paths/~1api~1products~1flags~1{code}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/flags/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"action","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_769"}},"responseCodes":["200"],"pointer":"/api/products/flags/{code}","href":"flags/updateproductflag","openApiOperationId":"updateProductFlag","summary":"Product flag update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_769","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_769"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767"}},"schemaId":"schema_767"}],"pointer":"/paths/~1api~1products~1flags~1{code}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_767","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_767"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/flags/updateproductflag"}],"panels":[]}]},"httpPath":"/api/products/flags/{code}"},{"label":"Product flag delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/flags/deleteproductflag","routeSlug":"/shoptet-api/openapi/flags/deleteproductflag","metadata":{"seo":{"title":"Product flag delete","description":"Deletes the flag. System flags cannot be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProductFlag","name":"Product flag delete","isWebhook":false,"pointer":"/paths/~1api~1products~1flags~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product flag delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the flag. System flags cannot be deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"action"}],"pointer":"/paths/~1api~1products~1flags~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1flags~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/flags/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"action","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/flags/{code}","href":"flags/deleteproductflag","openApiOperationId":"deleteProductFlag","summary":"Product flag delete","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1products~1flags~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/flags/deleteproductflag"}],"panels":[]}]},"httpPath":"/api/products/flags/{code}"}],"content":{"contentType":"group","meta":{"name":"Flags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Flags","showPageActions":true},{"nodeType":"markdoc","content":"Managing flags in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/flags","summary":"List of products flags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/flags/getlistofproductsflags","deprecated":false},{"title":"/api/products/flags","summary":"Product flag insertion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/flags/createproductflag","deprecated":false},{"title":"/api/products/flags/{code}","summary":"Product flag update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/flags/updateproductflag","deprecated":false},{"title":"/api/products/flags/{code}","summary":"Product flag delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/flags/deleteproductflag","deprecated":false}]}]}]}]}},{"type":"group","label":"Gifts","link":"/shoptet-api/openapi/gifts","routeSlug":"/shoptet-api/openapi/gifts","items":[{"label":"Get order gift settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/gifts/getordergiftsettings","routeSlug":"/shoptet-api/openapi/gifts/getordergiftsettings","metadata":{"seo":{"title":"Get order gift settings","description":"There are order gift setting, which influence general behaviour."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderGiftSettings","name":"Get order gift settings","isWebhook":false,"pointer":"/paths/~1api~1orders~1gifts~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order gift settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are order gift setting, which influence general behaviour."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behavior of the gifts - set if gifts are dependent on each product or whole order (stock dependent/independent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offer to wholesale customers - define if customer with wholesale module have gifts offer available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift to whole order or each product"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1gifts~1settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/orders/gifts/settings","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/orders/gifts/settings","href":"gifts/getordergiftsettings","openApiOperationId":"getOrderGiftSettings","summary":"Get order gift settings","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_770"}},"schemaId":"schema_770"}],"pointer":"/paths/~1api~1orders~1gifts~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_770","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_770"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/getordergiftsettings"}],"panels":[]}]},"httpPath":"/api/orders/gifts/settings"},{"label":"Update order gift settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/gifts/updateordergiftsettings","routeSlug":"/shoptet-api/openapi/gifts/updateordergiftsettings","metadata":{"seo":{"title":"Update order gift settings","description":"Method updates order gift settings. Every item in request body is optional, but at least one setting is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrderGiftSettings","name":"Update order gift settings","isWebhook":false,"pointer":"/paths/~1api~1orders~1gifts~1settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update order gift settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Method updates order gift settings. Every item in request body is\noptional, but at least one setting is required."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1orders~1gifts~1settings/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_771"}},"schemaId":"schema_771","pointer":"/paths/~1api~1orders~1gifts~1settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/orders/gifts/settings","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_771"}},"responseCodes":["200"],"pointer":"/api/orders/gifts/settings","href":"gifts/updateordergiftsettings","openApiOperationId":"updateOrderGiftSettings","summary":"Update order gift settings","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_771","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_771"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_770"}},"schemaId":"schema_770"}],"pointer":"/paths/~1api~1orders~1gifts~1settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_770","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_770"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/updateordergiftsettings"}],"panels":[]}]},"httpPath":"/api/orders/gifts/settings"}],"content":{"contentType":"group","meta":{"name":"Gifts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gifts","showPageActions":true},{"nodeType":"markdoc","content":"Managing order gifts in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/orders/gifts/settings","summary":"Get order gift settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/getordergiftsettings","deprecated":false},{"title":"/api/orders/gifts/settings","summary":"Update order gift settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/gifts/updateordergiftsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment methods","link":"/shoptet-api/openapi/payment-methods","routeSlug":"/shoptet-api/openapi/payment-methods","items":[{"label":"Listing of payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-methods/getlistingofpaymentmethods","routeSlug":"/shoptet-api/openapi/payment-methods/getlistingofpaymentmethods","metadata":{"seo":{"title":"Listing of payment methods","description":"The endpoint returns the listing of all available payment methods and details about their settings. Paging is not used, it always returns all methods at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListingOfPaymentMethods","name":"Listing of payment methods","isWebhook":false,"pointer":"/paths/~1api~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Listing of payment methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The endpoint returns the listing of all available payment methods and\ndetails about their settings. Paging is not used, it always returns all\nmethods at once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"salesChannelGuid","in":"query","schemaId":"schema_523","description":"Sales channel GUID. Optional parameter, if not provided, all payment methods will be returned.","example":"0199bdfd-0979-71fb-85ce-e483c61d391b"}],"pointer":"/paths/~1api~1payment-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/payment-methods","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"salesChannelGuid","in":"query","example":"0199bdfd-0979-71fb-85ce-e483c61d391b","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404","422"],"pointer":"/api/payment-methods","href":"payment-methods/getlistingofpaymentmethods","openApiOperationId":"getListingOfPaymentMethods","summary":"Listing of payment methods","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_772"}},"schemaId":"schema_772"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_772","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_772"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-methods/get/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/getlistingofpaymentmethods"}],"panels":[]}]},"httpPath":"/api/payment-methods"},{"label":"Adding the payment methods","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-methods/createpaymentmethod","routeSlug":"/shoptet-api/openapi/payment-methods/createpaymentmethod","metadata":{"seo":{"title":"Adding the payment methods","description":"Adds the new payment method for the specific e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentMethod","name":"Adding the payment methods","isWebhook":false,"pointer":"/paths/~1api~1payment-methods/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adding the payment methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds the new payment method for the specific e-shop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Premium client, contact your Account or Onboarding"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"manager and request the creation of a new gateway identifier. New"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment gateway has to be approved by Shoptet and client needs to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"familiar with the terms of payment in advance."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body includes the mandatory attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The other parameters are not mandatory and their default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values will be used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visibility"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the logo of the payment gateway as the file content, encoded with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"base64, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.logo.content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be longer than 255 characters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1payment-methods/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_773"}},"schemaId":"schema_773","pointer":"/paths/~1api~1payment-methods/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/payment-methods","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_773"}},"responseCodes":["200"],"pointer":"/api/payment-methods","href":"payment-methods/createpaymentmethod","openApiOperationId":"createPaymentMethod","summary":"Adding the payment methods","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_773","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_773"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_774"}},"schemaId":"schema_774"}],"pointer":"/paths/~1api~1payment-methods/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_774","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_774"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/createpaymentmethod"}],"panels":[]}]},"httpPath":"/api/payment-methods"},{"label":"Payment method deletion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-methods/deletepaymentmethod","routeSlug":"/shoptet-api/openapi/payment-methods/deletepaymentmethod","metadata":{"seo":{"title":"Payment method deletion","description":"Deletes payment method by guid. Only payment methods related to your addon may be deleted. Private API tokens aren't currently supported."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePaymentMethod","name":"Payment method deletion","isWebhook":false,"pointer":"/paths/~1api~1payment-methods~1{guid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment method deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes payment method by guid. Only payment methods related to your\naddon may be deleted. Private API tokens aren't currently supported."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Payment guid","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"pointer":"/paths/~1api~1payment-methods~1{guid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1payment-methods~1{guid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/payment-methods/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"93bc0dbe-7481-11e8-8216-002590dad85e","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/payment-methods/{guid}","href":"payment-methods/deletepaymentmethod","openApiOperationId":"deletePaymentMethod","summary":"Payment method deletion","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1payment-methods~1{guid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/deletepaymentmethod"}],"panels":[]}]},"httpPath":"/api/payment-methods/{guid}"}],"content":{"contentType":"group","meta":{"name":"Payment methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment methods","showPageActions":true},{"nodeType":"markdoc","content":"Managing payment methods in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/payment-methods","summary":"Listing of payment methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/getlistingofpaymentmethods","deprecated":false},{"title":"/api/payment-methods","summary":"Adding the payment methods","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/createpaymentmethod","deprecated":false},{"title":"/api/payment-methods/{guid}","summary":"Payment method deletion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-methods/deletepaymentmethod","deprecated":false}]}]}]}]}},{"type":"group","label":"Recycling fees","link":"/shoptet-api/openapi/recycling-fees","routeSlug":"/shoptet-api/openapi/recycling-fees","items":[{"label":"List of recycling fee categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/recycling-fees/getlistofrecyclingfeecategories","routeSlug":"/shoptet-api/openapi/recycling-fees/getlistofrecyclingfeecategories","metadata":{"seo":{"title":"List of recycling fee categories","description":"Returns the list of recycling fee categories within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfRecyclingFeeCategories","name":"List of recycling fee categories","isWebhook":false,"pointer":"/paths/~1api~1products~1recycling-fee-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of recycling fee categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of recycling fee categories within the e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1recycling-fee-categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/recycling-fee-categories","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/recycling-fee-categories","href":"recycling-fees/getlistofrecyclingfeecategories","openApiOperationId":"getListOfRecyclingFeeCategories","summary":"List of recycling fee categories","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_775"}},"schemaId":"schema_775"}],"pointer":"/paths/~1api~1products~1recycling-fee-categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_775","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_775"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recycling-fees/getlistofrecyclingfeecategories"}],"panels":[]}]},"httpPath":"/api/products/recycling-fee-categories"}],"content":{"contentType":"group","meta":{"name":"Recycling fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recycling fees","showPageActions":true},{"nodeType":"markdoc","content":"Managing recycling fees in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/recycling-fee-categories","summary":"List of recycling fee categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recycling-fees/getlistofrecyclingfeecategories","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipping methods","link":"/shoptet-api/openapi/shipping-methods","routeSlug":"/shoptet-api/openapi/shipping-methods","items":[{"label":"List of shipping methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-methods/getlistofshippingmethods","routeSlug":"/shoptet-api/openapi/shipping-methods/getlistofshippingmethods","metadata":{"seo":{"title":"List of shipping methods","description":"Endpoint returns a list of all available shipping methods and details of their settings. Does not use paging,"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfShippingMethods","name":"List of shipping methods","isWebhook":false,"pointer":"/paths/~1api~1shipping-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of shipping methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint returns a list of all available shipping methods and details of\ntheir settings. Does not use paging,\n\nit always returns all methods at once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"salesChannelGuid","in":"query","schemaId":"schema_523","description":"Sales channel GUID. Optional parameter, if not provided, all shipping methods will be returned.","example":"0199bdfd-0979-71fb-85ce-e483c61d391b"}],"pointer":"/paths/~1api~1shipping-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipping-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipping-methods","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"salesChannelGuid","in":"query","example":"0199bdfd-0979-71fb-85ce-e483c61d391b","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404","422"],"pointer":"/api/shipping-methods","href":"shipping-methods/getlistofshippingmethods","openApiOperationId":"getListOfShippingMethods","summary":"List of shipping methods","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_776"}},"schemaId":"schema_776"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/422/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipping-methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_776","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_776"}}},{"code":"403","schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods/get/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-methods/getlistofshippingmethods"}],"panels":[]}]},"httpPath":"/api/shipping-methods"},{"label":"Adding a shipping method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-methods/createshippingmethod","routeSlug":"/shoptet-api/openapi/shipping-methods/createshippingmethod","metadata":{"seo":{"title":"Adding a shipping method","description":"Adds a new shipping method for the specific e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShippingMethod","name":"Adding a shipping method","isWebhook":false,"pointer":"/paths/~1api~1shipping-methods/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adding a shipping method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a new shipping method for the specific e-shop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should you wish to implement an addon implementing a shipping method,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact our partner support and request the creation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of a new \"shipping company code\" identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body includes the mandatory attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingMethodCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingCompanyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameters are not"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mandatory and their default values will be used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visibility"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimalShippingPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the logo of the shipping method as the file content, encoded with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"base64, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.logo.content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be longer than 255 characters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipping-methods/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_777"}},"schemaId":"schema_777","pointer":"/paths/~1api~1shipping-methods/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/shipping-methods","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_777"}},"responseCodes":["200"],"pointer":"/api/shipping-methods","href":"shipping-methods/createshippingmethod","openApiOperationId":"createShippingMethod","summary":"Adding a shipping method","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_777","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_777"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_778"}},"schemaId":"schema_778"}],"pointer":"/paths/~1api~1shipping-methods/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_778","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_778"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-methods/createshippingmethod"}],"panels":[]}]},"httpPath":"/api/shipping-methods"},{"label":"Shipping method detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-methods/getshippingmethoddetail","routeSlug":"/shoptet-api/openapi/shipping-methods/getshippingmethoddetail","metadata":{"seo":{"title":"Shipping method detail","description":"Endpoint returns the detail of a single shipping method identified by its GUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShippingMethodDetail","name":"Shipping method detail","isWebhook":false,"pointer":"/paths/~1api~1shipping-methods~1{guid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping method detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint returns the detail of a single shipping method identified by its GUID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing and pricelist settings (price tiers by weight/price, per-country/region pricing and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paired payment methods) are returned only when requested via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=priceList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike the list endpoint ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/shipping-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which can be filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"salesChannelGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this detail endpoint is channel-agnostic: it returns the method by GUID regardless of sales"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"channel. Pricing is defined per method, not per channel, so the returned pricelist is the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"across channels."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Unique identifier of the shipping method.","required":true,"example":"b57f91bb-e920-11e0-baa3-7dc668b75ca8"}],"pointer":"/paths/~1api~1shipping-methods~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_779","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of additional data to include in the response. Supported value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"priceList"}],"pointer":"/paths/~1api~1shipping-methods~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipping-methods~1{guid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipping-methods/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"b57f91bb-e920-11e0-baa3-7dc668b75ca8","schemaId":"schema_523"}],"query":[{"name":"include","in":"query","example":"priceList","schemaId":"schema_779"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/shipping-methods/{guid}","href":"shipping-methods/getshippingmethoddetail","openApiOperationId":"getShippingMethodDetail","summary":"Shipping method detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_780"}},"schemaId":"schema_780"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods~1{guid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods~1{guid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipping-methods~1{guid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_780","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_780"}}},{"code":"404","schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods~1{guid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568","exampleIds":["paths/~1api~1shipping-methods~1{guid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-methods/getshippingmethoddetail"}],"panels":[]}]},"httpPath":"/api/shipping-methods/{guid}"}],"content":{"contentType":"group","meta":{"name":"Shipping methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping methods","showPageActions":true},{"nodeType":"markdoc","content":"Managing shipping methods in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipping-methods","summary":"List of shipping methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-methods/getlistofshippingmethods","deprecated":false},{"title":"/api/shipping-methods","summary":"Adding a shipping method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shipping-methods/createshippingmethod","deprecated":false},{"title":"/api/shipping-methods/{guid}","summary":"Shipping method detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-methods/getshippingmethoddetail","deprecated":false}]}]}]}]}},{"type":"group","label":"Stocks","link":"/shoptet-api/openapi/stocks","routeSlug":"/shoptet-api/openapi/stocks","items":[{"label":"List of stocks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getlistofstocks","routeSlug":"/shoptet-api/openapi/stocks/getlistofstocks","metadata":{"seo":{"title":"List of stocks","description":"Returns the list of stocks. There are usually not many stocks, therefore the endpoint returns all of them without Paging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfStocks","name":"List of stocks","isWebhook":false,"pointer":"/paths/~1api~1stocks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of stocks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of stocks. There are usually not many stocks, therefore the endpoint returns all of them without "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1stocks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/stocks","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/stocks","href":"stocks/getlistofstocks","openApiOperationId":"getListOfStocks","summary":"List of stocks","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_781"}},"schemaId":"schema_781"}],"pointer":"/paths/~1api~1stocks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_781","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_781"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stocks/getlistofstocks"}],"panels":[]}]},"httpPath":"/api/stocks"},{"label":"Stock detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getstockdetail","routeSlug":"/shoptet-api/openapi/stocks/getstockdetail","metadata":{"seo":{"title":"Stock detail","description":"Returns detailed information about one stock."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStockDetail","name":"Stock detail","isWebhook":false,"pointer":"/paths/~1api~1stocks~1{stockId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stock detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detailed information about one stock."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stockId","in":"path","schemaId":"schema_522","description":"","required":true,"example":1}],"pointer":"/paths/~1api~1stocks~1{stockId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1stocks~1{stockId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/stocks/{stockId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"stockId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/stocks/{stockId}","href":"stocks/getstockdetail","openApiOperationId":"getStockDetail","summary":"Stock detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_782"}},"schemaId":"schema_782"}],"pointer":"/paths/~1api~1stocks~1{stockId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_782","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_782"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stocks/getstockdetail"}],"panels":[]}]},"httpPath":"/api/stocks/{stockId}"},{"label":"Stock movements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getstockmovements","routeSlug":"/shoptet-api/openapi/stocks/getstockmovements","metadata":{"seo":{"title":"Stock movements","description":"It returns the list of changes in product quantity, which were donewithin one stock. Supports the Paging movements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStockMovements","name":"Stock movements","isWebhook":false,"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stock movements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns the list of changes in product quantity, which were done"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"within one stock. Supports the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"movements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports optional parts using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Please note that there is some"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"performance penalty associated with the usage of \"orderCode\" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and/or query "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also please note that when include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used, the returned data can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for specific cases. Either when this is a historic stock move, or the product code has been changed and/or is inconsistent with internally stored "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is to ensure that the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always point to the same product consistently."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To return GUID of product at the time of the stock movement, please use the include and attribute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"historicalProductGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The returned data can still be null on historic stock movements."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stockId","in":"path","schemaId":"schema_522","description":"ID of stock for which we would like the movements.","required":true,"example":1}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"lastId","in":"query","schemaId":"schema_522","description":"ID of last transfered record. If missing, the older records are\nsent.","example":45},{"name":"changeTimeFrom","in":"query","schemaId":"schema_523","description":"Date of move, in ISO 8601 format, lower limit. It is not possible to\nuse it as break poit, it is not unique value. Optional.","example":"2021-03-01T00:00:00+0100"},{"name":"orderCode","in":"query","schemaId":"schema_523","description":"Filtering according to order code.","example":"2017000049"},{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response. For specific include behavior, please see the general description above.","example":"orderCode,productGuid,historicalProductGuid,sumAmount"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 25. Max value is 1000.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/stocks/{stockId}/movements","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"stockId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[{"name":"lastId","in":"query","example":45,"schemaId":"schema_522"},{"name":"changeTimeFrom","in":"query","example":"2021-03-01T00:00:00+0100","schemaId":"schema_523"},{"name":"orderCode","in":"query","example":"2017000049","schemaId":"schema_523"},{"name":"include","in":"query","example":"orderCode,productGuid,historicalProductGuid,sumAmount","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/stocks/{stockId}/movements","href":"stocks/getstockmovements","openApiOperationId":"getStockMovements","summary":"Stock movements","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_783"}},"schemaId":"schema_783"}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_783","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_783"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stocks/getstockmovements"}],"panels":[]}]},"httpPath":"/api/stocks/{stockId}/movements"},{"label":"Update quantity in stock","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/updatequantityinstock","routeSlug":"/shoptet-api/openapi/stocks/updatequantityinstock","metadata":{"seo":{"title":"Update quantity in stock","description":"Endpoint enables the quantity of product in stock (relative andabsolute) to be changed. Within a call, the update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateQuantityInStock","name":"Update quantity in stock","isWebhook":false,"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update quantity in stock","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint enables the quantity of product in stock (relative and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"absolute) to be changed. Within a call, the update"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of multiple products at once can be requested (max. 300"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products/variants)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case an error occurs for one of the records, the correct records will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be updated, the response will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and there will be records in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for each failed record."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If all records are incorrect, the response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"code will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 BAD REQUEST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mandatory. Then one of the three items has to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountChange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to increase or decrease amount available for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ordering/physically on stock (relative change)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set amount available for ordering (absolute amount)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"realStock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set amount physically stored in a warehouse (absolute"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount)"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The difference between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"realStock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is amount of goods"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requested by the pending orders (so called \"claim\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount for ordering"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"realStock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"claim"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The claim cannot be changed explicitly, it is updated when a new order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is submitted or an order is sent out. Please note,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that the stock amount cannot be changed for product sets, where the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount is calculated dynamically from the individual"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products in the set. Trying to change the amount of product set will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"result in an error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stockId","in":"path","schemaId":"schema_522","description":"ID of the stock for which we would like the movements.","required":true,"example":1}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_784"}},"schemaId":"schema_784","pointer":"/paths/~1api~1stocks~1{stockId}~1movements/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/stocks/{stockId}/movements","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"stockId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_784"}},"responseCodes":["200","400"],"pointer":"/api/stocks/{stockId}/movements","href":"stocks/updatequantityinstock","openApiOperationId":"updateQuantityInStock","summary":"Update quantity in stock","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_784","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_784"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1stocks~1{stockId}~1movements/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1stocks~1{stockId}~1movements/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example1","paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example2"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example1","paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example2"]}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_528","exampleIds":["paths/~1api~1stocks~1{stockId}~1movements/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1stocks~1{stockId}~1movements/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_528","exampleIds":["paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example1","paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example1","paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stocks/updatequantityinstock"}],"panels":[]}]},"httpPath":"/api/stocks/{stockId}/movements"},{"label":"Stock movements - Last move","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getstockmovementslastmove","routeSlug":"/shoptet-api/openapi/stocks/getstockmovementslastmove","metadata":{"seo":{"title":"Stock movements - Last move","description":"It returns informations about last stock move."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStockMovementsLastMove","name":"Stock movements - Last move","isWebhook":false,"pointer":"/paths/~1api~1stocks~1{stockId}~1movements~1last/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stock movements - Last move","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"It returns informations about last stock move."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stockId","in":"path","schemaId":"schema_522","description":"ID of stock for which we would like the movements.","required":true,"example":1}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements~1last/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements~1last/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/stocks/{stockId}/movements/last","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"stockId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/stocks/{stockId}/movements/last","href":"stocks/getstockmovementslastmove","openApiOperationId":"getStockMovementsLastMove","summary":"Stock movements - Last move","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_785"}},"schemaId":"schema_785"}],"pointer":"/paths/~1api~1stocks~1{stockId}~1movements~1last/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_785","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_785"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stocks/getstockmovementslastmove"}],"panels":[]}]},"httpPath":"/api/stocks/{stockId}/movements/last"},{"label":"Product supplies in stock","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/stocks/getproductsuppliesinstock","routeSlug":"/shoptet-api/openapi/stocks/getproductsuppliesinstock","metadata":{"seo":{"title":"Product supplies in stock","description":"Returns the product supplies in stock for all products in a specific stock, contains GUID, code and quantityin stock for a specific product variant. It is possible to filter the specific GUID of a product, possibly a variant code. The endpoint supports Paging, in case of filtering, the amount of items per page increases.This endpoint supports optional parts using the include parameter (see Section on demand). The changeTime itemis always temporarily returned, however as of 16. 3. 2019 only upon using the include parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductSuppliesInStock","name":"Product supplies in stock","isWebhook":false,"pointer":"/paths/~1api~1stocks~1{stockId}~1supplies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product supplies in stock","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the product supplies in stock for all products in a specific stock, contains GUID, code and quantity"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in stock for a specific product variant. It is possible to filter the specific GUID of a product, possibly a variant code. The endpoint supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in case of filtering, the amount of items per page increases."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint supports optional parts using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/section-on-demand"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section on demand"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is always temporarily returned, however as of 16. 3. 2019 only upon using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you defined the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=changeTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter within the URL, the response will also contain the time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the last quantity in stock was changed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stockId","in":"path","schemaId":"schema_522","description":"","required":true,"example":1}],"pointer":"/paths/~1api~1stocks~1{stockId}~1supplies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"productGuid","in":"query","schemaId":"schema_523","description":"","example":"0023368f-d97b-11e0-b04f-57a43310b768"},{"name":"code","in":"query","schemaId":"schema_523","description":"","example":"26/BIL"},{"name":"onlyWithClaim","in":"query","schemaId":"schema_542","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether only products with claim greater than 0 should be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}]},{"name":"changedFrom","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return only product supplies, which amount has been changed since date value of this parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It support maximum of 30 days in history. (optional, string). ISO 8601 format (\"2017-12-12T22:08:01+0100\"). Optional."},"children":[]}]}]}]},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 1000.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1stocks~1{stockId}~1supplies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1stocks~1{stockId}~1supplies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/stocks/{stockId}/supplies","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"stockId","in":"path","required":true,"example":1,"schemaId":"schema_522"}],"query":[{"name":"productGuid","in":"query","example":"0023368f-d97b-11e0-b04f-57a43310b768","schemaId":"schema_523"},{"name":"code","in":"query","example":"26/BIL","schemaId":"schema_523"},{"name":"onlyWithClaim","in":"query","schemaId":"schema_542"},{"name":"changedFrom","in":"query","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/stocks/{stockId}/supplies","href":"stocks/getproductsuppliesinstock","openApiOperationId":"getProductSuppliesInStock","summary":"Product supplies in stock","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_786"}},"schemaId":"schema_786"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1stocks~1{stockId}~1supplies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_786","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_786"}}},{"code":"404","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stocks/getproductsuppliesinstock"}],"panels":[]}]},"httpPath":"/api/stocks/{stockId}/supplies"}],"content":{"contentType":"group","meta":{"name":"Stocks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stocks","showPageActions":true},{"nodeType":"markdoc","content":"Managing stocks in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/stocks","summary":"List of stocks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stocks/getlistofstocks","deprecated":false},{"title":"/api/stocks/{stockId}","summary":"Stock detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stocks/getstockdetail","deprecated":false},{"title":"/api/stocks/{stockId}/movements","summary":"Stock movements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stocks/getstockmovements","deprecated":false},{"title":"/api/stocks/{stockId}/movements","summary":"Update quantity in stock","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/stocks/updatequantityinstock","deprecated":false},{"title":"/api/stocks/{stockId}/movements/last","summary":"Stock movements - Last move","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stocks/getstockmovementslastmove","deprecated":false},{"title":"/api/stocks/{stockId}/supplies","summary":"Product supplies in stock","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stocks/getproductsuppliesinstock","deprecated":false}]}]}]}]}},{"type":"group","label":"Suppliers","link":"/shoptet-api/openapi/suppliers","routeSlug":"/shoptet-api/openapi/suppliers","items":[{"label":"List of suppliers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/suppliers/getlistofsuppliers","routeSlug":"/shoptet-api/openapi/suppliers/getlistofsuppliers","metadata":{"seo":{"title":"List of suppliers","description":"Returns the list of suppliers. Supports the Paging"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfSuppliers","name":"List of suppliers","isWebhook":false,"pointer":"/paths/~1api~1suppliers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of suppliers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of suppliers. Supports the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/paging"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paging"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 200. Max value is 500.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1suppliers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1suppliers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/suppliers","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/suppliers","href":"suppliers/getlistofsuppliers","openApiOperationId":"getListOfSuppliers","summary":"List of suppliers","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_787"}},"schemaId":"schema_787"}],"pointer":"/paths/~1api~1suppliers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_787","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_787"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/suppliers/getlistofsuppliers"}],"panels":[]}]},"httpPath":"/api/suppliers"}],"content":{"contentType":"group","meta":{"name":"Suppliers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Suppliers","showPageActions":true},{"nodeType":"markdoc","content":"Managing suppliers in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/suppliers","summary":"List of suppliers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/suppliers/getlistofsuppliers","deprecated":false}]}]}]}]}},{"type":"group","label":"Surcharge parameters","link":"/shoptet-api/openapi/surcharge-parameters","routeSlug":"/shoptet-api/openapi/surcharge-parameters","items":[{"label":"List of surcharge parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/getlistofsurchargeparameters","routeSlug":"/shoptet-api/openapi/surcharge-parameters/getlistofsurchargeparameters","metadata":{"seo":{"title":"List of surcharge parameters","description":"Returns the list of available surcharge parameters with their available values within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfSurchargeParameters","name":"List of surcharge parameters","isWebhook":false,"pointer":"/paths/~1api~1products~1surcharge-parameters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of surcharge parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of available surcharge parameters with their available values within the e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default and max value is 500.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1products~1surcharge-parameters/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1surcharge-parameters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/surcharge-parameters","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/surcharge-parameters","href":"surcharge-parameters/getlistofsurchargeparameters","openApiOperationId":"getListOfSurchargeParameters","summary":"List of surcharge parameters","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_788"}},"schemaId":"schema_788"}],"pointer":"/paths/~1api~1products~1surcharge-parameters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_788","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_788"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/surcharge-parameters/getlistofsurchargeparameters"}],"panels":[]}]},"httpPath":"/api/products/surcharge-parameters"},{"label":"Creation of surcharge parameter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/createsurchargeparameter","routeSlug":"/shoptet-api/openapi/surcharge-parameters/createsurchargeparameter","metadata":{"seo":{"title":"Creation of surcharge parameter","description":"Creation of surcharge parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSurchargeParameter","name":"Creation of surcharge parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1surcharge-parameters/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of surcharge parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1surcharge-parameters/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_789"}},"schemaId":"schema_789","pointer":"/paths/~1api~1products~1surcharge-parameters/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/surcharge-parameters","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_789"}},"responseCodes":["201"],"pointer":"/api/products/surcharge-parameters","href":"surcharge-parameters/createsurchargeparameter","openApiOperationId":"createSurchargeParameter","summary":"Creation of surcharge parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_789","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_789"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790"}],"pointer":"/paths/~1api~1products~1surcharge-parameters/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_790"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/surcharge-parameters/createsurchargeparameter"}],"panels":[]}]},"httpPath":"/api/products/surcharge-parameters"},{"label":"Detail of surcharge parameter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/getdetailofsurchargeparameter","routeSlug":"/shoptet-api/openapi/surcharge-parameters/getdetailofsurchargeparameter","metadata":{"seo":{"title":"Detail of surcharge parameter","description":"Detail of surcharge parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfSurchargeParameter","name":"Detail of surcharge parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of surcharge parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"povinny"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/surcharge-parameters/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"povinny","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/surcharge-parameters/{code}","href":"surcharge-parameters/getdetailofsurchargeparameter","openApiOperationId":"getDetailOfSurchargeParameter","summary":"Detail of surcharge parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_790"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/surcharge-parameters/getdetailofsurchargeparameter"}],"panels":[]}]},"httpPath":"/api/products/surcharge-parameters/{code}"},{"label":"Update of surcharge parameter","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/updatesurchargeparameter","routeSlug":"/shoptet-api/openapi/surcharge-parameters/updatesurchargeparameter","metadata":{"seo":{"title":"Update of surcharge parameter","description":"Update of surcharge parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSurchargeParameter","name":"Update of surcharge parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of surcharge parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"povinny"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_791"}},"schemaId":"schema_791","pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/surcharge-parameters/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"povinny","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_791"}},"responseCodes":["200"],"pointer":"/api/products/surcharge-parameters/{code}","href":"surcharge-parameters/updatesurchargeparameter","openApiOperationId":"updateSurchargeParameter","summary":"Update of surcharge parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_791","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_791"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_792"}},"schemaId":"schema_792"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_792","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_792"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/surcharge-parameters/updatesurchargeparameter"}],"panels":[]}]},"httpPath":"/api/products/surcharge-parameters/{code}"},{"label":"Creation of surcharge parameter value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/createsurchargeparametervalue","routeSlug":"/shoptet-api/openapi/surcharge-parameters/createsurchargeparametervalue","metadata":{"seo":{"title":"Creation of surcharge parameter value","description":"Creation of surcharge parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSurchargeParameterValue","name":"Creation of surcharge parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of surcharge parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"povinny"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_793"}},"schemaId":"schema_793","pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/surcharge-parameters/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"povinny","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_793"}},"responseCodes":["201"],"pointer":"/api/products/surcharge-parameters/{code}","href":"surcharge-parameters/createsurchargeparametervalue","openApiOperationId":"createSurchargeParameterValue","summary":"Creation of surcharge parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_793","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_793"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_790"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/surcharge-parameters/createsurchargeparametervalue"}],"panels":[]}]},"httpPath":"/api/products/surcharge-parameters/{code}"},{"label":"Removal of surcharge parameter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/deletesurchargeparameterbyindex","routeSlug":"/shoptet-api/openapi/surcharge-parameters/deletesurchargeparameterbyindex","metadata":{"seo":{"title":"Removal of surcharge parameter","description":"Removal of surcharge parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSurchargeParameterByIndex","name":"Removal of surcharge parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removal of surcharge parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_523","description":"","required":true,"example":"povinny"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/surcharge-parameters/{code}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"example":"povinny","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/surcharge-parameters/{code}","href":"surcharge-parameters/deletesurchargeparameterbyindex","openApiOperationId":"deleteSurchargeParameterByIndex","summary":"Removal of surcharge parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{code}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/surcharge-parameters/deletesurchargeparameterbyindex"}],"panels":[]}]},"httpPath":"/api/products/surcharge-parameters/{code}"},{"label":"Removal of surcharge parameter value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/deletesurchargeparametervalue","routeSlug":"/shoptet-api/openapi/surcharge-parameters/deletesurchargeparametervalue","metadata":{"seo":{"title":"Removal of surcharge parameter value","description":"Removal of surcharge parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSurchargeParameterValue","name":"Removal of surcharge parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removal of surcharge parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paramIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"povinny"},{"name":"valueIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"modry"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paramIndex","in":"path","required":true,"example":"povinny","schemaId":"schema_523"},{"name":"valueIndex","in":"path","required":true,"example":"modry","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}","href":"surcharge-parameters/deletesurchargeparametervalue","openApiOperationId":"deleteSurchargeParameterValue","summary":"Removal of surcharge parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/surcharge-parameters/deletesurchargeparametervalue"}],"panels":[]}]},"httpPath":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}"},{"label":"Update of surcharge parameter value","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/surcharge-parameters/updatesurchargeparametervalue","routeSlug":"/shoptet-api/openapi/surcharge-parameters/updatesurchargeparametervalue","metadata":{"seo":{"title":"Update of surcharge parameter value","description":"Update of surcharge parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSurchargeParameterValue","name":"Update of surcharge parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of surcharge parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paramIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"povinny"},{"name":"valueIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"modry"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_794"}},"schemaId":"schema_794","pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paramIndex","in":"path","required":true,"example":"povinny","schemaId":"schema_523"},{"name":"valueIndex","in":"path","required":true,"example":"modry","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_794"}},"responseCodes":["200"],"pointer":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}","href":"surcharge-parameters/updatesurchargeparametervalue","openApiOperationId":"updateSurchargeParameterValue","summary":"Update of surcharge parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_794","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_794"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_790"}},"schemaId":"schema_790"}],"pointer":"/paths/~1api~1products~1surcharge-parameters~1{paramIndex}~1{valueIndex}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_790","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_790"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/surcharge-parameters/updatesurchargeparametervalue"}],"panels":[]}]},"httpPath":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}"}],"content":{"contentType":"group","meta":{"name":"Surcharge parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Surcharge parameters","showPageActions":true},{"nodeType":"markdoc","content":"Managing surcharge parameters in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/surcharge-parameters","summary":"List of surcharge parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/surcharge-parameters/getlistofsurchargeparameters","deprecated":false},{"title":"/api/products/surcharge-parameters","summary":"Creation of surcharge parameter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/surcharge-parameters/createsurchargeparameter","deprecated":false},{"title":"/api/products/surcharge-parameters/{code}","summary":"Detail of surcharge parameter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/surcharge-parameters/getdetailofsurchargeparameter","deprecated":false},{"title":"/api/products/surcharge-parameters/{code}","summary":"Update of surcharge parameter","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/surcharge-parameters/updatesurchargeparameter","deprecated":false},{"title":"/api/products/surcharge-parameters/{code}","summary":"Creation of surcharge parameter value","prefix":{"name":"post","color":"post"},"badges":[],"link":"/surcharge-parameters/createsurchargeparametervalue","deprecated":false},{"title":"/api/products/surcharge-parameters/{code}","summary":"Removal of surcharge parameter","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/surcharge-parameters/deletesurchargeparameterbyindex","deprecated":false},{"title":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}","summary":"Removal of surcharge parameter value","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/surcharge-parameters/deletesurchargeparametervalue","deprecated":false},{"title":"/api/products/surcharge-parameters/{paramIndex}/{valueIndex}","summary":"Update of surcharge parameter value","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/surcharge-parameters/updatesurchargeparametervalue","deprecated":false}]}]}]}]}},{"type":"group","label":"Units","link":"/shoptet-api/openapi/units","routeSlug":"/shoptet-api/openapi/units","items":[{"label":"List of product units","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/units/getlistofproductunits","routeSlug":"/shoptet-api/openapi/units/getlistofproductunits","metadata":{"seo":{"title":"List of product units","description":"List of product units"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductUnits","name":"List of product units","isWebhook":false,"pointer":"/paths/~1api~1products~1units/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of product units","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1units/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/units","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/units","href":"units/getlistofproductunits","openApiOperationId":"getListOfProductUnits","summary":"List of product units","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_795"}},"schemaId":"schema_795"}],"pointer":"/paths/~1api~1products~1units/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_795","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_795"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/units/getlistofproductunits"}],"panels":[]}]},"httpPath":"/api/products/units"}],"content":{"contentType":"group","meta":{"name":"Units"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Units","showPageActions":true},{"nodeType":"markdoc","content":"Managing units in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/units","summary":"List of product units","prefix":{"name":"get","color":"get"},"badges":[],"link":"/units/getlistofproductunits","deprecated":false}]}]}]}]}},{"type":"group","label":"Variant parameters","link":"/shoptet-api/openapi/variant-parameters","routeSlug":"/shoptet-api/openapi/variant-parameters","items":[{"label":"List of variant parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/getlistofvariantparameters","routeSlug":"/shoptet-api/openapi/variant-parameters/getlistofvariantparameters","metadata":{"seo":{"title":"List of variant parameters","description":"Returns the list of available variant parameters with their available values within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfVariantParameters","name":"List of variant parameters","isWebhook":false,"pointer":"/paths/~1api~1products~1variant-parameters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of variant parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available variant parameters with their available values within the e-shop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of variant parameters endpoint has section, which is only sent when requested in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Section"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variant parameter values"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_523","description":"Optional parts of response","example":"values"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 50. Max value is 100.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1products~1variant-parameters/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1variant-parameters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/variant-parameters","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","example":"values","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/variant-parameters","href":"variant-parameters/getlistofvariantparameters","openApiOperationId":"getListOfVariantParameters","summary":"List of variant parameters","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}},"schemaId":"schema_796"}],"pointer":"/paths/~1api~1products~1variant-parameters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_796","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_796"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variant-parameters/getlistofvariantparameters"}],"panels":[]}]},"httpPath":"/api/products/variant-parameters"},{"label":"Creation of variant parameter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/createvariantparameter","routeSlug":"/shoptet-api/openapi/variant-parameters/createvariantparameter","metadata":{"seo":{"title":"Creation of variant parameter","description":"Creation of variant parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVariantParameter","name":"Creation of variant parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1variant-parameters/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of variant parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1variant-parameters/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_797"}},"schemaId":"schema_797","pointer":"/paths/~1api~1products~1variant-parameters/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/variant-parameters","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_797"}},"responseCodes":["201"],"pointer":"/api/products/variant-parameters","href":"variant-parameters/createvariantparameter","openApiOperationId":"createVariantParameter","summary":"Creation of variant parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_797","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_797"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}},"schemaId":"schema_798"}],"pointer":"/paths/~1api~1products~1variant-parameters/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_798","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variant-parameters/createvariantparameter"}],"panels":[]}]},"httpPath":"/api/products/variant-parameters"},{"label":"Detail of variant parameter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/getdetailofvariantparameter","routeSlug":"/shoptet-api/openapi/variant-parameters/getdetailofvariantparameter","metadata":{"seo":{"title":"Detail of variant parameter","description":"Detail of variant parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfVariantParameter","name":"Detail of variant parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of variant parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paramIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"barva"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/variant-parameters/{paramIndex}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paramIndex","in":"path","required":true,"example":"barva","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/variant-parameters/{paramIndex}","href":"variant-parameters/getdetailofvariantparameter","openApiOperationId":"getDetailOfVariantParameter","summary":"Detail of variant parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}},"schemaId":"schema_798"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_798","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variant-parameters/getdetailofvariantparameter"}],"panels":[]}]},"httpPath":"/api/products/variant-parameters/{paramIndex}"},{"label":"Update of variant parameter","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/updatevariantparameter","routeSlug":"/shoptet-api/openapi/variant-parameters/updatevariantparameter","metadata":{"seo":{"title":"Update of variant parameter","description":"Update of variant parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateVariantParameter","name":"Update of variant parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of variant parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paramIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"barva"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_799"}},"schemaId":"schema_799","pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/variant-parameters/{paramIndex}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paramIndex","in":"path","required":true,"example":"barva","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_799"}},"responseCodes":["200"],"pointer":"/api/products/variant-parameters/{paramIndex}","href":"variant-parameters/updatevariantparameter","openApiOperationId":"updateVariantParameter","summary":"Update of variant parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_799","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_799"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}},"schemaId":"schema_798"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_798","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variant-parameters/updatevariantparameter"}],"panels":[]}]},"httpPath":"/api/products/variant-parameters/{paramIndex}"},{"label":"Creation of variant parameter value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/createvariantparametervalue","routeSlug":"/shoptet-api/openapi/variant-parameters/createvariantparametervalue","metadata":{"seo":{"title":"Creation of variant parameter value","description":"Creation of variant parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVariantParameterValue","name":"Creation of variant parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creation of variant parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paramIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"barevne-spektrum"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_800"}},"schemaId":"schema_800","pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/products/variant-parameters/{paramIndex}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paramIndex","in":"path","required":true,"example":"barevne-spektrum","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_800"}},"responseCodes":["201"],"pointer":"/api/products/variant-parameters/{paramIndex}","href":"variant-parameters/createvariantparametervalue","openApiOperationId":"createVariantParameterValue","summary":"Creation of variant parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_800","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_800"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}},"schemaId":"schema_798"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_798","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variant-parameters/createvariantparametervalue"}],"panels":[]}]},"httpPath":"/api/products/variant-parameters/{paramIndex}"},{"label":"Removal of variant parameter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/deletevariantparameter","routeSlug":"/shoptet-api/openapi/variant-parameters/deletevariantparameter","metadata":{"seo":{"title":"Removal of variant parameter","description":"Removal of variant parameter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteVariantParameter","name":"Removal of variant parameter","isWebhook":false,"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removal of variant parameter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paramIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"strih"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/variant-parameters/{paramIndex}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paramIndex","in":"path","required":true,"example":"strih","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/variant-parameters/{paramIndex}","href":"variant-parameters/deletevariantparameter","openApiOperationId":"deleteVariantParameter","summary":"Removal of variant parameter","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variant-parameters/deletevariantparameter"}],"panels":[]}]},"httpPath":"/api/products/variant-parameters/{paramIndex}"},{"label":"Removal of variant parameter value","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/deletevariantparametervalue","routeSlug":"/shoptet-api/openapi/variant-parameters/deletevariantparametervalue","metadata":{"seo":{"title":"Removal of variant parameter value","description":"Removal of variant parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteVariantParameterValue","name":"Removal of variant parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removal of variant parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paramIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"strih"},{"name":"rawValue","in":"path","schemaId":"schema_523","description":"","required":true,"example":"raminka"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/products/variant-parameters/{paramIndex}/{rawValue}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paramIndex","in":"path","required":true,"example":"strih","schemaId":"schema_523"},{"name":"rawValue","in":"path","required":true,"example":"raminka","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/variant-parameters/{paramIndex}/{rawValue}","href":"variant-parameters/deletevariantparametervalue","openApiOperationId":"deleteVariantParameterValue","summary":"Removal of variant parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variant-parameters/deletevariantparametervalue"}],"panels":[]}]},"httpPath":"/api/products/variant-parameters/{paramIndex}/{rawValue}"},{"label":"Update of variant parameter value","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/variant-parameters/updatevariantparametervalue","routeSlug":"/shoptet-api/openapi/variant-parameters/updatevariantparametervalue","metadata":{"seo":{"title":"Update of variant parameter value","description":"Update of variant parameter value"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateVariantParameterValue","name":"Update of variant parameter value","isWebhook":false,"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of variant parameter value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paramIndex","in":"path","schemaId":"schema_523","description":"","required":true,"example":"barva"},{"name":"rawValue","in":"path","schemaId":"schema_523","description":"","required":true,"example":"fialova"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_801"}},"schemaId":"schema_801","pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/products/variant-parameters/{paramIndex}/{rawValue}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paramIndex","in":"path","required":true,"example":"barva","schemaId":"schema_523"},{"name":"rawValue","in":"path","required":true,"example":"fialova","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_801"}},"responseCodes":["200"],"pointer":"/api/products/variant-parameters/{paramIndex}/{rawValue}","href":"variant-parameters/updatevariantparametervalue","openApiOperationId":"updateVariantParameterValue","summary":"Update of variant parameter value","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_801","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_801"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}},"schemaId":"schema_798"}],"pointer":"/paths/~1api~1products~1variant-parameters~1{paramIndex}~1{rawValue}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_798","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_798"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variant-parameters/updatevariantparametervalue"}],"panels":[]}]},"httpPath":"/api/products/variant-parameters/{paramIndex}/{rawValue}"}],"content":{"contentType":"group","meta":{"name":"Variant parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Variant parameters","showPageActions":true},{"nodeType":"markdoc","content":"Managing variant parameters in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/variant-parameters","summary":"List of variant parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/variant-parameters/getlistofvariantparameters","deprecated":false},{"title":"/api/products/variant-parameters","summary":"Creation of variant parameter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variant-parameters/createvariantparameter","deprecated":false},{"title":"/api/products/variant-parameters/{paramIndex}","summary":"Detail of variant parameter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/variant-parameters/getdetailofvariantparameter","deprecated":false},{"title":"/api/products/variant-parameters/{paramIndex}","summary":"Update of variant parameter","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/variant-parameters/updatevariantparameter","deprecated":false},{"title":"/api/products/variant-parameters/{paramIndex}","summary":"Creation of variant parameter value","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variant-parameters/createvariantparametervalue","deprecated":false},{"title":"/api/products/variant-parameters/{paramIndex}","summary":"Removal of variant parameter","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/variant-parameters/deletevariantparameter","deprecated":false},{"title":"/api/products/variant-parameters/{paramIndex}/{rawValue}","summary":"Removal of variant parameter value","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/variant-parameters/deletevariantparametervalue","deprecated":false},{"title":"/api/products/variant-parameters/{paramIndex}/{rawValue}","summary":"Update of variant parameter value","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/variant-parameters/updatevariantparametervalue","deprecated":false}]}]}]}]}},{"type":"group","label":"Warranties","link":"/shoptet-api/openapi/warranties","routeSlug":"/shoptet-api/openapi/warranties","items":[{"label":"List of product warranties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/warranties/getlistofproductwarranties","routeSlug":"/shoptet-api/openapi/warranties/getlistofproductwarranties","metadata":{"seo":{"title":"List of product warranties","description":"Returns list of product warranties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductWarranties","name":"List of product warranties","isWebhook":false,"pointer":"/paths/~1api~1products~1warranties/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of product warranties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of product warranties."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1warranties/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/warranties","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/warranties","href":"warranties/getlistofproductwarranties","openApiOperationId":"getListOfProductWarranties","summary":"List of product warranties","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_802"}},"schemaId":"schema_802"}],"pointer":"/paths/~1api~1products~1warranties/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_802","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_802"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/warranties/getlistofproductwarranties"}],"panels":[]}]},"httpPath":"/api/products/warranties"}],"content":{"contentType":"group","meta":{"name":"Warranties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Warranties","showPageActions":true},{"nodeType":"markdoc","content":"Managing warranties for the products."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/warranties","summary":"List of product warranties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/warranties/getlistofproductwarranties","deprecated":false}]}]}]}]}},{"type":"separator","label":"Sales channels","content":null},{"type":"group","label":"Sales channels","link":"/shoptet-api/openapi/sales-channels","routeSlug":"/shoptet-api/openapi/sales-channels","items":[{"label":"List of all sales channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/sales-channels/getsaleschannels","routeSlug":"/shoptet-api/openapi/sales-channels/getsaleschannels","metadata":{"seo":{"title":"List of all sales channels","description":"Provides a list of all sales channels."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSalesChannels","name":"List of all sales channels","isWebhook":false,"pointer":"/paths/~1api~1sales-channels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of all sales channels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provides a list of all sales channels."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online_store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marketplace"},"children":[]}]}]}],"example":"in_store"}],"pointer":"/paths/~1api~1sales-channels/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1sales-channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/sales-channels","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","example":"in_store","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/sales-channels","href":"sales-channels/getsaleschannels","openApiOperationId":"getSalesChannels","summary":"List of all sales channels","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_803"}},"schemaId":"schema_803"}],"pointer":"/paths/~1api~1sales-channels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_803","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_803"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sales-channels/getsaleschannels"}],"panels":[]}]},"httpPath":"/api/sales-channels"},{"label":"Sales channel detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/sales-channels/getsaleschannelsdetail","routeSlug":"/shoptet-api/openapi/sales-channels/getsaleschannelsdetail","metadata":{"seo":{"title":"Sales channel detail","description":"Information about the detail of the sales channels. Module Sales Channel is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSalesChannelsDetail","name":"Sales channel detail","isWebhook":false,"pointer":"/paths/~1api~1sales-channels~1{guid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales channel detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about the detail of the sales channels. Module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sales Channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guid","in":"path","schemaId":"schema_523","description":"Sales channel GUID","required":true,"example":"0199bdfd-0979-71fb-85ce-e483c61d391a"}],"pointer":"/paths/~1api~1sales-channels~1{guid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1sales-channels~1{guid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/sales-channels/{guid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"guid","in":"path","required":true,"example":"0199bdfd-0979-71fb-85ce-e483c61d391a","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/sales-channels/{guid}","href":"sales-channels/getsaleschannelsdetail","openApiOperationId":"getSalesChannelsDetail","summary":"Sales channel detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_804"}},"schemaId":"schema_804"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1{guid}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1{guid}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1{guid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1{guid}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1sales-channels~1{guid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_804","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_804"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1{guid}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1{guid}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1{guid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1{guid}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sales-channels/getsaleschannelsdetail"}],"panels":[]}]},"httpPath":"/api/sales-channels/{guid}"},{"label":"Sales channel detail by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/sales-channels/getsaleschannelsdetailbyid","routeSlug":"/shoptet-api/openapi/sales-channels/getsaleschannelsdetailbyid","metadata":{"seo":{"title":"Sales channel detail by ID","description":"Information about the detail of the sales channels. Module Sales Channel is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSalesChannelsDetailById","name":"Sales channel detail by ID","isWebhook":false,"pointer":"/paths/~1api~1sales-channels~1id~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales channel detail by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about the detail of the sales channels. Module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sales Channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_523","description":"Sales channel ID","required":true,"example":"2"}],"pointer":"/paths/~1api~1sales-channels~1id~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1sales-channels~1id~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/sales-channels/id/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"2","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/sales-channels/id/{id}","href":"sales-channels/getsaleschannelsdetailbyid","openApiOperationId":"getSalesChannelsDetailById","summary":"Sales channel detail by ID","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_804"}},"schemaId":"schema_804"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1id~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1id~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1id~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1id~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1sales-channels~1id~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_804","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_804"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1id~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1id~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1id~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1sales-channels~1id~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sales-channels/getsaleschannelsdetailbyid"}],"panels":[]}]},"httpPath":"/api/sales-channels/id/{id}"}],"content":{"contentType":"group","meta":{"name":"Sales channels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales channels","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/sales-channels","summary":"List of all sales channels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sales-channels/getsaleschannels","deprecated":false},{"title":"/api/sales-channels/{guid}","summary":"Sales channel detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sales-channels/getsaleschannelsdetail","deprecated":false},{"title":"/api/sales-channels/id/{id}","summary":"Sales channel detail by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sales-channels/getsaleschannelsdetailbyid","deprecated":false}]}]}]}]}},{"type":"separator","label":"System","content":null},{"type":"group","label":"Endpoints","link":"/shoptet-api/openapi/endpoints","routeSlug":"/shoptet-api/openapi/endpoints","items":[{"label":"List of available endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/endpoints/getlistofavailableendpoints","routeSlug":"/shoptet-api/openapi/endpoints/getlistofavailableendpoints","metadata":{"seo":{"title":"List of available endpoints","description":"List of endpoints available within the systems. Using the \"status\" parameter, you can list the approved endpoints, or endpoints pending approval. In default state, without the parameter, the endpoint returns the approved endpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfAvailableEndpoints","name":"List of available endpoints","isWebhook":false,"pointer":"/paths/~1api~1system~1endpoints/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of available endpoints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of endpoints available within the systems. Using the \"status\" parameter, you can list the approved \nendpoints, or endpoints pending approval. In default state, without the parameter, the endpoint returns \nthe approved endpoints."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]}]}],"example":"approved"}],"pointer":"/paths/~1api~1system~1endpoints/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1system~1endpoints/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/system/endpoints","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","example":"approved","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/system/endpoints","href":"endpoints/getlistofavailableendpoints","openApiOperationId":"getListOfAvailableEndpoints","summary":"List of available endpoints","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_805"}},"schemaId":"schema_805"}],"pointer":"/paths/~1api~1system~1endpoints/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_805","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_805"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/endpoints/getlistofavailableendpoints"}],"panels":[]}]},"httpPath":"/api/system/endpoints"}],"content":{"contentType":"group","meta":{"name":"Endpoints"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Endpoints","showPageActions":true},{"nodeType":"markdoc","content":"Obtaining information for endpoints in API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/system/endpoints","summary":"List of available endpoints","prefix":{"name":"get","color":"get"},"badges":[],"link":"/endpoints/getlistofavailableendpoints","deprecated":false}]}]}]}]}},{"type":"group","label":"Exports","link":"/shoptet-api/openapi/exports","routeSlug":"/shoptet-api/openapi/exports","items":[{"label":"General document export","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/exports/generaldocumentdownload","routeSlug":"/shoptet-api/openapi/exports/generaldocumentdownload","metadata":{"seo":{"title":"General document export","description":"You can request documents of several types in several formats in combination with settings as includes.See tables bellow for possibilities and settings. Export is processed asynchronously.See how Asynchronousrequests work on our developer's portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generalDocumentDownload","name":"General document export","isWebhook":false,"pointer":"/paths/~1api~1export~1{type}~1{format}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"General document export","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request documents of several types in several formats in combination with settings as includes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See tables bellow for possibilities and settings. Export is processed asynchronously."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document format"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csvDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportWithHistoricalVat"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xlsDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportAsForeignCurrency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"linkProformaInvoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isdoc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descOrder"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlPohodaCz"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlPohodaSk"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlMoneyS3CZ"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlMoneyS3Sk"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xlsxSummary"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csvSummary"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proformaInvoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csvDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportWithHistoricalVat"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xlsDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportAsForeignCurrency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlPohodaCz"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlPohodaSk"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlMoneyS3CZ"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlMoneyS3Sk"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xlsxSummary"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csvSummary"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creditNote"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csvDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportWithHistoricalVat"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xlsDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportAsForeignCurrency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isdoc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlPohodaCz"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlPohodaSk"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlMoneyS3CZ"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlMoneyS3Sk"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xlsxSummary"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csvSummary"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proofPayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlPohodaCz"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportWithHistoricalVat"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xmlPohodaSk"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportAsForeignCurrency"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csvDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"onlyClosedProofPayments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xlsDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deliveryNote"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"csvDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"xlsDetail"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"codeTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pdf"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxDateTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Does"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportWithHistoricalVat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will export historical rates."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exportAsForeignCurrency"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency will be exported as foreign regardless of e-shop settings."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"linkProformaInvoices"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corresponding proforma invoices will be added to export file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"onlyClosedProofPayments"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports only finished documents."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"descOrder"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort as starting from oldest"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type","in":"path","schemaId":"schema_523","description":"See tables for all document types","required":true,"example":"proofPayment"},{"name":"format","in":"path","schemaId":"schema_523","description":"See tables for all document formats","required":true,"example":"xmlPohodaCz"}],"pointer":"/paths/~1api~1export~1{type}~1{format}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_523","description":"Mandatory except for Delivery notes","example":"czk"},{"name":"codeFrom","in":"query","schemaId":"schema_523","description":"","example":"2018000004"},{"name":"codeTo","in":"query","schemaId":"schema_523","description":"","example":"2018000006"},{"name":"dateFrom","in":"query","schemaId":"schema_523","description":"","example":"2022-12-12"},{"name":"dateTo","in":"query","schemaId":"schema_523","description":"","example":"2023-12-12"},{"name":"taxDateFrom","in":"query","schemaId":"schema_523","description":"","example":"2022-12-12"},{"name":"taxDateTo","in":"query","schemaId":"schema_523","description":"","example":"2023-12-12"},{"name":"include","in":"query","schemaId":"schema_523","description":"Sections to include","example":"exportWithHistoricalVat, exportAsForeignCurrency, linkProformaInvoices, onlyClosedProofPayments, descOrder"}],"pointer":"/paths/~1api~1export~1{type}~1{format}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1export~1{type}~1{format}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/export/{type}/{format}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"type","in":"path","required":true,"example":"proofPayment","schemaId":"schema_523"},{"name":"format","in":"path","required":true,"example":"xmlPohodaCz","schemaId":"schema_523"}],"query":[{"name":"currency","in":"query","example":"czk","schemaId":"schema_523"},{"name":"codeFrom","in":"query","example":"2018000004","schemaId":"schema_523"},{"name":"codeTo","in":"query","example":"2018000006","schemaId":"schema_523"},{"name":"dateFrom","in":"query","example":"2022-12-12","schemaId":"schema_523"},{"name":"dateTo","in":"query","example":"2023-12-12","schemaId":"schema_523"},{"name":"taxDateFrom","in":"query","example":"2022-12-12","schemaId":"schema_523"},{"name":"taxDateTo","in":"query","example":"2023-12-12","schemaId":"schema_523"},{"name":"include","in":"query","example":"exportWithHistoricalVat, exportAsForeignCurrency, linkProformaInvoices, onlyClosedProofPayments, descOrder","schemaId":"schema_523"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["202"],"pointer":"/api/export/{type}/{format}","href":"exports/generaldocumentdownload","openApiOperationId":"generalDocumentDownload","summary":"General document export","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"}],"pointer":"/paths/~1api~1export~1{type}~1{format}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exports/generaldocumentdownload"}],"panels":[]}]},"httpPath":"/api/export/{type}/{format}"}],"content":{"contentType":"group","meta":{"name":"Exports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exports","showPageActions":true},{"nodeType":"markdoc","content":"Exports allow to work with documents of several types in several formats."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/export/{type}/{format}","summary":"General document export","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exports/generaldocumentdownload","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/shoptet-api/openapi/files","routeSlug":"/shoptet-api/openapi/files","items":[{"label":"List of uploaded files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/files/getlistofuploadedfiles","routeSlug":"/shoptet-api/openapi/files/getlistofuploadedfiles","metadata":{"seo":{"title":"List of uploaded files","description":"Retrieves your uploaded files that can be copied in supported endpoints to entities within e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfUploadedFiles","name":"List of uploaded files","isWebhook":false,"pointer":"/paths/~1api~1system~1files/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of uploaded files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves your uploaded files that can be copied in supported endpoints\nto entities within e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1system~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/system/files","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/system/files","href":"files/getlistofuploadedfiles","openApiOperationId":"getListOfUploadedFiles","summary":"List of uploaded files","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_806"}},"schemaId":"schema_806"}],"pointer":"/paths/~1api~1system~1files/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_806","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_806"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getlistofuploadedfiles"}],"panels":[]}]},"httpPath":"/api/system/files"},{"label":"Batch files upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/files/uploadfiles","routeSlug":"/shoptet-api/openapi/files/uploadfiles","metadata":{"seo":{"title":"Batch files upload","description":"This endpoint has been only renamed from \"File upload\" after we creatednew synchronous endpoint one file upload. Url and structure is unchanged"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadFiles","name":"Batch files upload","isWebhook":false,"pointer":"/paths/~1api~1system~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch files upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint has been only renamed from \"File upload\" after we created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new synchronous endpoint one file upload. Url and structure is unchanged"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performs file upload asynchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that order of files matter (result of job respects the order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of images in request)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case of specifying filename, keep in mind that extension is checked"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether it respects file type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result can be found in job detail in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resultUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The result is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"formed as normal API response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n{\n \"data\": {\n \"images\":[\n {\n \"index\": 0,\n \"md5\": \"072c1a2005e17dcd3a3cca3d2c769264\",\n \"name\": \"kocka.png\",\n \"created\": \"2023-01-16T13:19:32+0100\",\n \"sourceUrl\": \"https://example.com/image.png\"\n }\n ]\n },\n \"errors\": [\n {\n \"errorCode\": \"file-upload-size-limit\",\n \"message\": \"Uploaded file size limit exceeded. Limit is 2 MB.\",\n \"instance\": \"data[1]\"\n }\n ]\n}\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n{\n \"data\": {\n \"images\":[\n {\n \"index\": 0,\n \"md5\": \"072c1a2005e17dcd3a3cca3d2c769264\",\n \"name\": \"kocka.png\",\n \"created\": \"2023-01-16T13:19:32+0100\",\n \"sourceUrl\": \"https://example.com/image.png\"\n }\n ]\n },\n \"errors\": [\n {\n \"errorCode\": \"file-upload-size-limit\",\n \"message\": \"Uploaded file size limit exceeded. Limit is 2 MB.\",\n \"instance\": \"data[1]\"\n }\n ]\n}\n\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the result's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section, there are successfully uploaded images"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with their info and with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field which is order of the image in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request (0-based indexing)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the result's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section, there are errors which occurred during"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"some images upload and with number in brackets in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data[0]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is order of the image in the request (0-based"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indexing)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developers.shoptet.com/asynchronous-requests/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" work on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our developer's portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently maximum of 50 files can be uploaded in one request. Current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filesize limit per file is 2MB."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1system~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_807"}},"schemaId":"schema_807","pointer":"/paths/~1api~1system~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/system/files","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_807"}},"responseCodes":["202"],"pointer":"/api/system/files","href":"files/uploadfiles","openApiOperationId":"uploadFiles","summary":"Batch files upload","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_807","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_807"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545"}],"pointer":"/paths/~1api~1system~1files/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/uploadfiles"}],"panels":[]}]},"httpPath":"/api/system/files"},{"label":"File upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/files/uploadfile","routeSlug":"/shoptet-api/openapi/files/uploadfile","metadata":{"seo":{"title":"File upload","description":"This is new endpoint - older asynchronous endpoint has been only renamedto \"Batch files upload\" in documentation, url and structure is unchanged"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadFile","name":"File upload","isWebhook":false,"pointer":"/paths/~1api~1system~1file/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is new endpoint - older asynchronous endpoint has been only renamed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to \"Batch files upload\" in documentation, url and structure is unchanged"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please, do not use this endpoint for batch file upload!"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performs one file upload synchronously in same way as asynchronous files"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the result's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section, there are successfully uploaded image"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with current unique name and upload datetime."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In case of image upload, response tag is \"image\", any other file types has response key \"file\" as here:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMAGE: JPG, PNG, GIF, WEBP"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"data\": {\n \"image\": {\n \"name\": \"image.jpg\",\n \"created\": \"2025-03-31T20:28:55+0200\"\n }\n },\n \"errors\": null\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"data\": {\n \"image\": {\n \"name\": \"image.jpg\",\n \"created\": \"2025-03-31T20:28:55+0200\"\n }\n },\n \"errors\": null\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANY OTHER FILE TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"data\": {\n \"file\": {\n \"name\": \"file.pdf\",\n \"created\": \"2025-03-31T20:28:55+0200\"\n }\n },\n \"errors\": null\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"data\": {\n \"file\": {\n \"name\": \"file.pdf\",\n \"created\": \"2025-03-31T20:28:55+0200\"\n }\n },\n \"errors\": null\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current filesize limit is 2MB."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1system~1file/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_808"}},"schemaId":"schema_808","pointer":"/paths/~1api~1system~1file/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/system/file","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_808"}},"responseCodes":["201","404","422"],"pointer":"/api/system/file","href":"files/uploadfile","openApiOperationId":"uploadFile","summary":"File upload","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_808","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_808"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_809"}},"schemaId":"schema_809"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1file/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1file/post/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1file/post/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1file/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1system~1file/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_809","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_809"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1system~1file/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1file/post/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1system~1file/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1file/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/uploadfile"}],"panels":[]}]},"httpPath":"/api/system/file"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","showPageActions":true},{"nodeType":"markdoc","content":"Managing files in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/system/files","summary":"List of uploaded files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getlistofuploadedfiles","deprecated":false},{"title":"/api/system/files","summary":"Batch files upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/uploadfiles","deprecated":false},{"title":"/api/system/file","summary":"File upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/uploadfile","deprecated":false}]}]}]}]}},{"type":"group","label":"Jobs","link":"/shoptet-api/openapi/jobs","routeSlug":"/shoptet-api/openapi/jobs","items":[{"label":"List of jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/jobs/getlistofjobs","routeSlug":"/shoptet-api/openapi/jobs/getlistofjobs","metadata":{"seo":{"title":"List of jobs","description":"List of jobs in queue. Using the \"status\" parameter to filter by completed|pending|running|failed|expired|killed.Without this filter it will show all statuses. Also you can filter results depends on time of creation and completion."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfJobs","name":"List of jobs","isWebhook":false,"pointer":"/paths/~1api~1system~1jobs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of jobs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of jobs in queue. Using the \"status\" parameter to filter by completed|pending|running|failed|expired|killed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without this filter it will show all statuses. Also you can filter results depends on time of creation and completion."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"killed"},"children":[]}]}]}],"example":"completed"},{"name":"creationTimeFrom","in":"query","schemaId":"schema_523","description":"date and time of job creation - lower limit","example":"2018-05-28T14:17:00+02:00"},{"name":"creationTimeTo","in":"query","schemaId":"schema_523","description":"date and time of job creation - upper limit","example":"2018-05-28T14:17:00+02:00"},{"name":"completionTimeFrom","in":"query","schemaId":"schema_523","description":"date and time of job completion - lower limit","example":"2018-05-28T14:17:00+02:00"},{"name":"completionTimeTo","in":"query","schemaId":"schema_523","description":"date and time of job completion - upper limit","example":"2018-05-28T14:17:00+02:00"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 100. Max value is 500.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1system~1jobs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1system~1jobs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/system/jobs","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","example":"completed","schemaId":"schema_523"},{"name":"creationTimeFrom","in":"query","example":"2018-05-28T14:17:00+02:00","schemaId":"schema_523"},{"name":"creationTimeTo","in":"query","example":"2018-05-28T14:17:00+02:00","schemaId":"schema_523"},{"name":"completionTimeFrom","in":"query","example":"2018-05-28T14:17:00+02:00","schemaId":"schema_523"},{"name":"completionTimeTo","in":"query","example":"2018-05-28T14:17:00+02:00","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/system/jobs","href":"jobs/getlistofjobs","openApiOperationId":"getListOfJobs","summary":"List of jobs","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_810"}},"schemaId":"schema_810"}],"pointer":"/paths/~1api~1system~1jobs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_810","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_810"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getlistofjobs"}],"panels":[]}]},"httpPath":"/api/system/jobs"},{"label":"Job detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/jobs/getjobdetail","routeSlug":"/shoptet-api/openapi/jobs/getjobdetail","metadata":{"seo":{"title":"Job detail","description":"Returns information about job. If job is completed, it will contain additional information about job result."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJobDetail","name":"Job detail","isWebhook":false,"pointer":"/paths/~1api~1system~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Job detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns information about job. If job is completed, it will contain\nadditional information about job result.\n\n\nReturns 404 if job does not exist.\n\nReturns 403 response if job detail of unprocessed job is requested more\nthan 10 times."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_523","description":"","required":true,"example":"3ax1844"}],"pointer":"/paths/~1api~1system~1jobs~1{jobId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1system~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/system/jobs/{jobId}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"example":"3ax1844","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/api/system/jobs/{jobId}","href":"jobs/getjobdetail","openApiOperationId":"getJobDetail","summary":"Job detail","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_811"}},"schemaId":"schema_811"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1jobs~1{jobId}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1jobs~1{jobId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1jobs~1{jobId}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1jobs~1{jobId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1system~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_811","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_811"}}},{"code":"403","schemaId":"schema_528","exampleIds":["paths/~1api~1system~1jobs~1{jobId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1jobs~1{jobId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1system~1jobs~1{jobId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1system~1jobs~1{jobId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/getjobdetail"}],"panels":[]}]},"httpPath":"/api/system/jobs/{jobId}"}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":"Managing asynchronous jobs in the e-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/system/jobs","summary":"List of jobs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getlistofjobs","deprecated":false},{"title":"/api/system/jobs/{jobId}","summary":"Job detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/getjobdetail","deprecated":false}]}]}]}]}},{"type":"group","label":"Measure units","link":"/shoptet-api/openapi/measure-units","routeSlug":"/shoptet-api/openapi/measure-units","items":[{"label":"List of products measure units","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/measure-units/getlistofproductsmeasureunits","routeSlug":"/shoptet-api/openapi/measure-units/getlistofproductsmeasureunits","metadata":{"seo":{"title":"List of products measure units","description":"Returns the list of product measure units within the e-shop."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListOfProductsMeasureUnits","name":"List of products measure units","isWebhook":false,"pointer":"/paths/~1api~1products~1measure-units/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of products measure units","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of product measure units within the e-shop."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1products~1measure-units/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/products/measure-units","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/products/measure-units","href":"measure-units/getlistofproductsmeasureunits","openApiOperationId":"getListOfProductsMeasureUnits","summary":"List of products measure units","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_812"}},"schemaId":"schema_812"}],"pointer":"/paths/~1api~1products~1measure-units/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_812","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_812"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/measure-units/getlistofproductsmeasureunits"}],"panels":[]}]},"httpPath":"/api/products/measure-units"}],"content":{"contentType":"group","meta":{"name":"Measure units"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Measure units","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows you to access the system measure unit. These units are convertible to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"each other and cannot be redefined or extended. For defining/extending your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"own units use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/units"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Units"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/products/measure-units","summary":"List of products measure units","prefix":{"name":"get","color":"get"},"badges":[],"link":"/measure-units/getlistofproductsmeasureunits","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment gateways","link":"/shoptet-api/openapi/payment-gateways","routeSlug":"/shoptet-api/openapi/payment-gateways","items":[{"label":"Gaining the information about payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-gateways/getinformationaboutpayment","routeSlug":"/shoptet-api/openapi/payment-gateways/getinformationaboutpayment","metadata":{"seo":{"title":"Gaining the information about payment","description":"Returns the URL, at which the payment gateway shall redirect the users after completion of operation and order number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInformationAboutPayment","name":"Gaining the information about payment","isWebhook":false,"pointer":"/paths/~1api~1payment-status~1{paymentCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gaining the information about payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the URL, at which the payment gateway shall redirect the users\nafter completion of operation and order number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentCode","in":"path","schemaId":"schema_523","description":"the payment code identifies the payment of a single order,\nit is generated when the order is completed and received by the payment gateway upon redirection from the e-shop to the payment gateway.\n","required":true,"example":"os8FtURz7PpO46Z87euEAoBAn9RClB2d"}],"pointer":"/paths/~1api~1payment-status~1{paymentCode}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1payment-status~1{paymentCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/payment-status/{paymentCode}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paymentCode","in":"path","required":true,"example":"os8FtURz7PpO46Z87euEAoBAn9RClB2d","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/payment-status/{paymentCode}","href":"payment-gateways/getinformationaboutpayment","openApiOperationId":"getInformationAboutPayment","summary":"Gaining the information about payment","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_813"}},"schemaId":"schema_813"}],"pointer":"/paths/~1api~1payment-status~1{paymentCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_813","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_813"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-gateways/getinformationaboutpayment"}],"panels":[]}]},"httpPath":"/api/payment-status/{paymentCode}"},{"label":"Payment status update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/payment-gateways/updatepaymentstatus","routeSlug":"/shoptet-api/openapi/payment-gateways/updatepaymentstatus","metadata":{"seo":{"title":"Payment status update","description":"Payment status update via the payment gateway. The paymentCode is theidentifier. Payment status can be updated when the payment has beensuccessfully recorded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePaymentStatus","name":"Payment status update","isWebhook":false,"pointer":"/paths/~1api~1payment-status~1{paymentCode}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment status update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment status update via the payment gateway. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifier. Payment status can be updated when the payment has been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successfully recorded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can not be longer than 255 characters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentCode","in":"path","schemaId":"schema_523","description":"payment code identifies the payment of a single order,\nit is generated when the order is completed and received by the payment gateway upon redirection from e-shop to the payment gateway.\n","required":true,"example":"os8FtURz7PpO46Z87euEAoBAn9RClB2d"}],"pointer":"/paths/~1api~1payment-status~1{paymentCode}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"suppressDocumentGeneration","in":"query","schemaId":"schema_529","description":"suppress the generation of linked documents.","example":true},{"name":"suppressEmailSending","in":"query","schemaId":"schema_529","description":"suppress sending the linked information e-mails.","example":true}],"pointer":"/paths/~1api~1payment-status~1{paymentCode}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1payment-status~1{paymentCode}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_814"}},"schemaId":"schema_814","pointer":"/paths/~1api~1payment-status~1{paymentCode}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/payment-status/{paymentCode}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"paymentCode","in":"path","required":true,"example":"os8FtURz7PpO46Z87euEAoBAn9RClB2d","schemaId":"schema_523"}],"query":[{"name":"suppressDocumentGeneration","in":"query","example":true,"schemaId":"schema_529"},{"name":"suppressEmailSending","in":"query","example":true,"schemaId":"schema_529"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_814"}},"responseCodes":["200","404","422"],"pointer":"/api/payment-status/{paymentCode}","href":"payment-gateways/updatepaymentstatus","openApiOperationId":"updatePaymentStatus","summary":"Payment status update","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_814","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_814"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-status~1{paymentCode}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-status~1{paymentCode}/patch/responses/404/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-status~1{paymentCode}/patch/responses/422/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-status~1{paymentCode}/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1payment-status~1{paymentCode}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1payment-status~1{paymentCode}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-status~1{paymentCode}/patch/responses/404/content/application~1json/example"]}}},{"code":"422","schemaId":"schema_528","exampleIds":["paths/~1api~1payment-status~1{paymentCode}/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1payment-status~1{paymentCode}/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-gateways/updatepaymentstatus"}],"panels":[]}]},"httpPath":"/api/payment-status/{paymentCode}"}],"content":{"contentType":"group","meta":{"name":"Payment gateways"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment gateways","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API endpoints for integration of payment gateways."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you are a Premium client, contact your Account or Onboarding manager."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New payment gateway has to be approved by Shoptet and client needs to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"familiar with the terms of payment in advance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/payment-status/{paymentCode}","summary":"Gaining the information about payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-gateways/getinformationaboutpayment","deprecated":false},{"title":"/api/payment-status/{paymentCode}","summary":"Payment status update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/payment-gateways/updatepaymentstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Shipping requests","link":"/shoptet-api/openapi/shipping-requests","routeSlug":"/shoptet-api/openapi/shipping-requests","items":[{"label":"Shipping request for getting cart details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-requests/getshippingrequestforcartdetails","routeSlug":"/shoptet-api/openapi/shipping-requests/getshippingrequestforcartdetails","metadata":{"seo":{"title":"Shipping request for getting cart details","description":"Endpoint returns details of cart for shipping request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShippingRequestForCartDetails","name":"Shipping request for getting cart details","isWebhook":false,"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping request for getting cart details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Endpoint returns details of cart for shipping request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shippingRequestCode","in":"path","schemaId":"schema_523","description":"Shipping request code of cart","required":true,"example":"0389fc7dd97584790e5ad49010db9c4a"},{"name":"shippingGuid","in":"path","schemaId":"schema_523","description":"Shipping method based on delivery","required":true,"example":"ecb3e399-2f57-11eb-8853-0800275177b9"}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"shippingRequestCode","in":"path","required":true,"example":"0389fc7dd97584790e5ad49010db9c4a","schemaId":"schema_523"},{"name":"shippingGuid","in":"path","required":true,"example":"ecb3e399-2f57-11eb-8853-0800275177b9","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404","408"],"pointer":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}","href":"shipping-requests/getshippingrequestforcartdetails","openApiOperationId":"getShippingRequestForCartDetails","summary":"Shipping request for getting cart details","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_815"}},"schemaId":"schema_815"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/404/content/application~1json/example"]},{"code":"408","description":"Request Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/408/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/408/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_815","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_815"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/404/content/application~1json/example"]}}},{"code":"408","schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/408/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/408/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-requests/getshippingrequestforcartdetails"}],"panels":[]}]},"httpPath":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}"},{"label":"Update shipping price & data","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-requests/updateshippingdata","routeSlug":"/shoptet-api/openapi/shipping-requests/updateshippingdata","metadata":{"seo":{"title":"Update shipping price & data","description":"Endpoint to set shipping price & data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateShippingData","name":"Update shipping price & data","isWebhook":false,"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update shipping price & data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint to set shipping price & data"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shippingRequestCode","in":"path","schemaId":"schema_523","description":"Shipping request code of cart","required":true,"example":"0389fc7dd97584790e5ad49010db9c4a"},{"name":"shippingGuid","in":"path","schemaId":"schema_523","description":"Shipping method based on delivery","required":true,"example":"ecb3e399-2f57-11eb-8853-0800275177b9"}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_816"}},"schemaId":"schema_816","pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"shippingRequestCode","in":"path","required":true,"example":"0389fc7dd97584790e5ad49010db9c4a","schemaId":"schema_523"},{"name":"shippingGuid","in":"path","required":true,"example":"ecb3e399-2f57-11eb-8853-0800275177b9","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_816"}},"responseCodes":["200","404","408"],"pointer":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}","href":"shipping-requests/updateshippingdata","openApiOperationId":"updateShippingData","summary":"Update shipping price & data","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_816","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_816"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_817"}},"schemaId":"schema_817"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/404/content/application~1json/example"]},{"code":"408","description":"Request Timeout","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/408/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/408/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_817","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_817"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/404/content/application~1json/example"]}}},{"code":"408","schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/408/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/408/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-requests/updateshippingdata"}],"panels":[]}]},"httpPath":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}"},{"label":"Shipping request for getting status of order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/shipping-requests/getshippingrequestforgettingorderstatus","routeSlug":"/shoptet-api/openapi/shipping-requests/getshippingrequestforgettingorderstatus","metadata":{"seo":{"title":"Shipping request for getting status of order","description":"Endpoint returns status of order related to shippingRequestCode &shippingGuid"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getShippingRequestForGettingOrderStatus","name":"Shipping request for getting status of order","isWebhook":false,"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping request for getting status of order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint returns status of order related to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingRequestCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" &"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingGuid"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shippingRequestCode","in":"path","schemaId":"schema_523","description":"Shipping request code of cart","required":true,"example":"0389fc7dd97584790e5ad49010db9c4a"},{"name":"shippingGuid","in":"path","schemaId":"schema_523","description":"Shipping method based on delivery","required":true,"example":"ecb3e399-2f57-11eb-8853-0800275177b9"}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}/status","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"shippingRequestCode","in":"path","required":true,"example":"0389fc7dd97584790e5ad49010db9c4a","schemaId":"schema_523"},{"name":"shippingGuid","in":"path","required":true,"example":"ecb3e399-2f57-11eb-8853-0800275177b9","schemaId":"schema_523"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}/status","href":"shipping-requests/getshippingrequestforgettingorderstatus","openApiOperationId":"getShippingRequestForGettingOrderStatus","summary":"Shipping request for getting status of order","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_818","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_818","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_818","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_818","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shipping-requests/getshippingrequestforgettingorderstatus"}],"panels":[]}]},"httpPath":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}/status"}],"content":{"contentType":"group","meta":{"name":"Shipping requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shipping requests","showPageActions":true},{"nodeType":"markdoc","content":"Shipping requests endpoints are used for managing shipping requests in the\ne-shop."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}","summary":"Shipping request for getting cart details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-requests/getshippingrequestforcartdetails","deprecated":false},{"title":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}","summary":"Update shipping price & data","prefix":{"name":"put","color":"put"},"badges":[],"link":"/shipping-requests/updateshippingdata","deprecated":false},{"title":"/api/shipping-request/{shippingRequestCode}/{shippingGuid}/status","summary":"Shipping request for getting status of order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shipping-requests/getshippingrequestforgettingorderstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/shoptet-api/openapi/webhooks","routeSlug":"/shoptet-api/openapi/webhooks","items":[{"type":"link","label":"Payload delivery","link":"/shoptet-api/openapi/webhooks/payload-delivery","routeSlug":"/shoptet-api/openapi/webhooks/payload-delivery","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Payload delivery"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/payload-delivery"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For events that support it (see the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload supported"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), you can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"opt in to receive the full entity data directly in the notification body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by registering the webhook with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendPayload: \"full\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enabled, the notification body will contain an additional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field with the entity data equivalent to the corresponding GET endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"eshopId\": 222651,\n \"event\": \"product:create\",\n \"eventCreated\": \"2025-05-19T10:00:00+0200\",\n \"eventInstance\": \"c9e976a5-340b-11e4-b500-ac162d8a2454\",\n \"payload\": {\n \"data\": {\n \"product\": {}\n }\n }\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"eshopId\": 222651,\n \"event\": \"product:create\",\n \"eventCreated\": \"2025-05-19T10:00:00+0200\",\n \"eventInstance\": \"c9e976a5-340b-11e4-b500-ac162d8a2454\",\n \"payload\": {\n \"data\": {\n \"product\": {}\n }\n }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the payload cannot be fetched at delivery time (e.g. due to a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transient error), the notification is still sent without the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field. Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendPayload: null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable payload delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about the function of webhooks, see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://developers.shoptet.com/webhooks/."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Overview of registered webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/getoverviewofregisteredwebhooks","routeSlug":"/shoptet-api/openapi/webhooks/getoverviewofregisteredwebhooks","metadata":{"seo":{"title":"Overview of registered webhooks","description":"Returns the list of webhooks, registered by the specific addon for a single e-shop. It is therefore bound to the specific installation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOverviewOfRegisteredWebhooks","name":"Overview of registered webhooks","isWebhook":false,"pointer":"/paths/~1api~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Overview of registered webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of webhooks, registered by the specific addon for a\nsingle e-shop. It is therefore bound to the specific installation.\n\nThe addon does not have any access to another addon (not even for the\nsame e-shop, or two addons from the same developer)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 500.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1webhooks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/webhooks","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/webhooks","href":"webhooks/getoverviewofregisteredwebhooks","openApiOperationId":"getOverviewOfRegisteredWebhooks","summary":"Overview of registered webhooks","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_819"}},"schemaId":"schema_819"}],"pointer":"/paths/~1api~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_819","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_819"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getoverviewofregisteredwebhooks"}],"panels":[]}]},"httpPath":"/api/webhooks"},{"label":"Registration of new webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/registernewwebhook","routeSlug":"/shoptet-api/openapi/webhooks/registernewwebhook","metadata":{"seo":{"title":"Registration of new webhook","description":"Registers the webhook. For a single event (event, for exampleorder:create) ONLY ONE URL can be registered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerNewWebhook","name":"Registration of new webhook","isWebhook":false,"pointer":"/paths/~1api~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Registration of new webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers the webhook. For a single event ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order:create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ONLY ONE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL can be registered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you try to enter the webhook for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that already exists, you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receive error "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with message "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook already exists for this event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Successful creation (registration) of webhook is signaled by code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The endpoint returns the info"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the created webhook. One of the items is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is assigned to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the webhook and is used for its identification"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upon change or deletion."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The supported event can be found in code list "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#webhook-event-type"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is possible to enter up to 50 webhooks using a single call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be longer than 2000 characters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_820"}},"schemaId":"schema_820","pointer":"/paths/~1api~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/webhooks","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_820"}},"responseCodes":["201"],"pointer":"/api/webhooks","href":"webhooks/registernewwebhook","openApiOperationId":"registerNewWebhook","summary":"Registration of new webhook","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_820","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_820"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_821"}},"schemaId":"schema_821"}],"pointer":"/paths/~1api~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_821","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_821"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/registernewwebhook"}],"panels":[]}]},"httpPath":"/api/webhooks"},{"label":"Detail of registered webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/getdetailofregisteredwebhooks","routeSlug":"/shoptet-api/openapi/webhooks/getdetailofregisteredwebhooks","metadata":{"seo":{"title":"Detail of registered webhooks","description":"Shows the information about a single specific registered webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDetailOfRegisteredWebhooks","name":"Detail of registered webhooks","isWebhook":false,"pointer":"/paths/~1api~1webhooks~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detail of registered webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows the information about a single specific registered webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"","required":true,"example":3}],"pointer":"/paths/~1api~1webhooks~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1webhooks~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/webhooks/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":3,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/webhooks/{id}","href":"webhooks/getdetailofregisteredwebhooks","openApiOperationId":"getDetailOfRegisteredWebhooks","summary":"Detail of registered webhooks","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_822"}},"schemaId":"schema_822"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1webhooks~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_822","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_822"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getdetailofregisteredwebhooks"}],"panels":[]}]},"httpPath":"/api/webhooks/{id}"},{"label":"Update of existing webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/updateexistingwebhook","routeSlug":"/shoptet-api/openapi/webhooks/updateexistingwebhook","metadata":{"seo":{"title":"Update of existing webhook","description":"Modification of the existing webhook. The id of the webhook serves asthe identifier. Using just one call, only one webhook can be modified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExistingWebhook","name":"Update of existing webhook","isWebhook":false,"pointer":"/paths/~1api~1webhooks~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update of existing webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modification of the existing webhook. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the webhook serves as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the identifier. Using just one call, only one webhook can be modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be longer than 2000 characters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"","required":true,"example":3}],"pointer":"/paths/~1api~1webhooks~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1webhooks~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_823"}},"schemaId":"schema_823","pointer":"/paths/~1api~1webhooks~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/webhooks/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":3,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_823"}},"responseCodes":["200","404"],"pointer":"/api/webhooks/{id}","href":"webhooks/updateexistingwebhook","openApiOperationId":"updateExistingWebhook","summary":"Update of existing webhook","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"schemaId":"schema_823","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_823"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1webhooks~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updateexistingwebhook"}],"panels":[]}]},"httpPath":"/api/webhooks/{id}"},{"label":"Deletion of registered webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/deleteregisteredwebhook","routeSlug":"/shoptet-api/openapi/webhooks/deleteregisteredwebhook","metadata":{"seo":{"title":"Deletion of registered webhook","description":"Deletes the registered webhook, identified by means of id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRegisteredWebhook","name":"Deletion of registered webhook","isWebhook":false,"pointer":"/paths/~1api~1webhooks~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletion of registered webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the registered webhook, identified by means of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_522","description":"","required":true,"example":3}],"pointer":"/paths/~1api~1webhooks~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1webhooks~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/webhooks/{id}","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":3,"schemaId":"schema_522"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/api/webhooks/{id}","href":"webhooks/deleteregisteredwebhook","openApiOperationId":"deleteRegisteredWebhook","summary":"Deletion of registered webhook","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1webhooks~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"404","schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528","exampleIds":["paths/~1api~1webhooks~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deleteregisteredwebhook"}],"panels":[]}]},"httpPath":"/api/webhooks/{id}"},{"label":"Generating of signature key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/generatewebhooksignaturekey","routeSlug":"/shoptet-api/openapi/webhooks/generatewebhooksignaturekey","metadata":{"seo":{"title":"Generating of signature key","description":"The endpoint call does not require any body. The endpoint alwaysgenerates a new signature key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateWebhookSignatureKey","name":"Generating of signature key","isWebhook":false,"pointer":"/paths/~1api~1webhooks~1renew-signature-key/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generating of signature key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint call does not require any body. The endpoint always"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generates a new signature key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for calculating the digest mentioned in the HTTP header of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification – "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Shoptet-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The same key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is to be used during check after the receipt of notification. For more"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information see https://developers.shoptet.com/webhooks/#signature"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1webhooks~1renew-signature-key/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/webhooks/renew-signature-key","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/webhooks/renew-signature-key","href":"webhooks/generatewebhooksignaturekey","openApiOperationId":"generateWebhookSignatureKey","summary":"Generating of signature key","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_824"}},"schemaId":"schema_824"}],"pointer":"/paths/~1api~1webhooks~1renew-signature-key/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_824","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_824"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/generatewebhooksignaturekey"}],"panels":[]}]},"httpPath":"/api/webhooks/renew-signature-key"},{"label":"Webhook notification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/shoptet-api/openapi/webhooks/getwebhooknotification","routeSlug":"/shoptet-api/openapi/webhooks/getwebhooknotification","metadata":{"seo":{"title":"Webhook notification","description":"Returns the notification (invoking) list of webhooks and provides information about these. If you do not have a registered webhook, and the given event happens (for example creation of an order), the registered URLs are called. A notification about a call contains information about the webhook that requested the call, the URL called, the time, delivery status, number of delivery attempts and other information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhookNotification","name":"Webhook notification","isWebhook":false,"pointer":"/paths/~1api~1webhooks~1notifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the notification (invoking) list of webhooks and provides information about these. If you do not have \na registered webhook, and the given event happens (for example creation of an order), the registered URLs are \ncalled. A notification about a call contains information about the webhook that requested the call, the URL \ncalled, the time, delivery status, number of delivery attempts and other information.\n\n\nIt is possible to request 7 days history of notification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"shoptetAccessToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"}]},{"schemes":[{"name":"shoptetPrivateApiToken","scopes":[],"type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]}]}]}],"example":"failed"},{"name":"event","in":"query","schemaId":"schema_523","description":"event","example":"order:delete"},{"name":"active","in":"query","schemaId":"schema_542","description":"flag that the notification was not delivered yet, and the number of\nattempts did not reach the maximum amount. The notification will be\nresent to the target URL","example":true},{"name":"from","in":"query","schemaId":"schema_523","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DateTime for the log, up to the present, which we are interested in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the time zone designation, html shall be coded as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%2B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2018-05-28T14:17:00+02:00"},{"name":"itemsPerPage","in":"query","schemaId":"schema_522","description":"Returned items per page. Default value is 20. Max value is 500.","example":50},{"name":"page","in":"query","schemaId":"schema_522","description":"Page number to return. Default value is 1.","example":3}],"pointer":"/paths/~1api~1webhooks~1notifications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_526","required":true}],"pointer":"/paths/~1api~1webhooks~1notifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/webhooks/notifications","servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","example":"failed","schemaId":"schema_523"},{"name":"event","in":"query","example":"order:delete","schemaId":"schema_523"},{"name":"active","in":"query","example":true,"schemaId":"schema_542"},{"name":"from","in":"query","example":"2018-05-28T14:17:00+02:00","schemaId":"schema_523"},{"name":"itemsPerPage","in":"query","example":50,"schemaId":"schema_522"},{"name":"page","in":"query","example":3,"schemaId":"schema_522"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_526"}],"cookie":[]},"security":[{"schemes":[{"id":"shoptetAccessToken","type":"apiKey","name":"Shoptet-Access-Token","in":"header"}],"scopes":[]},{"schemes":[{"id":"shoptetPrivateApiToken","type":"apiKey","name":"Shoptet-Private-Api-Token","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/webhooks/notifications","href":"webhooks/getwebhooknotification","openApiOperationId":"getWebhookNotification","summary":"Webhook notification","securityGroups":[{"shoptetAccessToken":[]},{"shoptetPrivateApiToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/shoptet-api/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.myshoptet.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_825"}},"schemaId":"schema_825"}],"pointer":"/paths/~1api~1webhooks~1notifications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_825","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_825"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhooknotification"}],"panels":[]}]},"httpPath":"/api/webhooks/notifications"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API endpoints for webhook servicing. It offers the possibility to read,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"add, change and delete the registered webhooks. Furthermore, it offers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a list of notifications about invoked webhooks and their status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhooks are HTTP calls, which send HTTPs calls to registered"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscribers if a specific event happens,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for example creating an order. Then the information, in JSON format, is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivered to the defined URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n{\n \"eshopId\": 222651,\n \"event\": \"order:create\",\n \"eventCreated\": \"2019-01-08T15:13:39+0100\",\n \"eventInstance\": \"2018000057\"\n}\n\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n{\n \"eshopId\": 222651,\n \"event\": \"order:create\",\n \"eventCreated\": \"2019-01-08T15:13:39+0100\",\n \"eventInstance\": \"2018000057\"\n}\n\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The meaning of individual items:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eshopId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - number of the e-shop, where the event happened"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - event which invoked the call (see code list"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventCreated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - accurate time, when the event happened"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventInstance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - reference to a specified entity - according to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"context, order number, invoice number, product GUID, etc."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/webhooks","summary":"Overview of registered webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getoverviewofregisteredwebhooks","deprecated":false},{"title":"/api/webhooks","summary":"Registration of new webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/registernewwebhook","deprecated":false},{"title":"/api/webhooks/{id}","summary":"Detail of registered webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getdetailofregisteredwebhooks","deprecated":false},{"title":"/api/webhooks/{id}","summary":"Update of existing webhook","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooks/updateexistingwebhook","deprecated":false},{"title":"/api/webhooks/{id}","summary":"Deletion of registered webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deleteregisteredwebhook","deprecated":false},{"title":"/api/webhooks/renew-signature-key","summary":"Generating of signature key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/generatewebhooksignaturekey","deprecated":false},{"title":"/api/webhooks/notifications","summary":"Webhook notification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhooknotification","deprecated":false}]}]}]}]}},{"type":"separator","label":"JSON lines schemas","content":null},{"type":"group","label":"Batch","link":"/shoptet-api/openapi/batch","routeSlug":"/shoptet-api/openapi/batch","items":[{"type":"link","label":"Brand create","link":"/shoptet-api/openapi/batch/brandbatchcreate","routeSlug":"/shoptet-api/openapi/batch/brandbatchcreate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"brandBatchCreate"},"seo":{"title":"Brand create"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brand create","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/brandBatchCreate"},"children":[]}]}]}},{"type":"link","label":"Category update","link":"/shoptet-api/openapi/batch/categorybatchupdate","routeSlug":"/shoptet-api/openapi/batch/categorybatchupdate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"categoryBatchUpdate"},"seo":{"title":"Category update"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Category update","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/categoryBatchUpdate"},"children":[]}]}]}},{"type":"link","label":"Category product priority update","link":"/shoptet-api/openapi/batch/categoryproductprioritybatchupdate","routeSlug":"/shoptet-api/openapi/batch/categoryproductprioritybatchupdate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"categoryProductPriorityBatchUpdate"},"seo":{"title":"Category product priority update"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Category product priority update","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/categoryProductPriorityBatchUpdate"},"children":[]}]}]}},{"type":"link","label":"Order create","link":"/shoptet-api/openapi/batch/orderbatchcreate","routeSlug":"/shoptet-api/openapi/batch/orderbatchcreate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"orderBatchCreate"},"seo":{"title":"Order create"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order create","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/orderBatchCreate"},"children":[]}]}]}},{"type":"link","label":"Pricelist update","link":"/shoptet-api/openapi/batch/pricelistbatchupdate","routeSlug":"/shoptet-api/openapi/batch/pricelistbatchupdate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"pricelistBatchUpdate"},"seo":{"title":"Pricelist update"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pricelist update","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/pricelistBatchUpdate"},"children":[]}]}]}},{"type":"link","label":"Product batch delete","link":"/shoptet-api/openapi/batch/productbatchdeleteschema","routeSlug":"/shoptet-api/openapi/batch/productbatchdeleteschema","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"productBatchDeleteSchema"},"seo":{"title":"Product batch delete"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product batch delete","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/productBatchDeleteSchema"},"children":[]}]}]}},{"type":"link","label":"Product update","link":"/shoptet-api/openapi/batch/productbatchupdate","routeSlug":"/shoptet-api/openapi/batch/productbatchupdate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"productBatchUpdate"},"seo":{"title":"Product update"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product update","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/productBatchUpdate"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Batch"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch","showPageActions":true},{"nodeType":"markdoc","content":"Schemas related to batch actions."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Brand create","link":"/batch/brandbatchcreate","deprecated":false},{"title":"Category update","link":"/batch/categorybatchupdate","deprecated":false},{"title":"Category product priority update","link":"/batch/categoryproductprioritybatchupdate","deprecated":false},{"title":"Order create","link":"/batch/orderbatchcreate","deprecated":false},{"title":"Pricelist update","link":"/batch/pricelistbatchupdate","deprecated":false},{"title":"Product batch delete","link":"/batch/productbatchdeleteschema","deprecated":false},{"title":"Product update","link":"/batch/productbatchupdate","deprecated":false}]}]}]}]}},{"type":"group","label":"Snapshot","link":"/shoptet-api/openapi/snapshot","routeSlug":"/shoptet-api/openapi/snapshot","items":[{"type":"link","label":"Abandoned cart","link":"/shoptet-api/openapi/snapshot/abandonedcartsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/abandonedcartsnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"abandonedCartSnapshot"},"seo":{"title":"Abandoned cart"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Abandoned cart","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/abandonedCartSnapshot"},"children":[]}]}]}},{"type":"link","label":"Article","link":"/shoptet-api/openapi/snapshot/articlesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/articlesnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"articleSnapshot"},"seo":{"title":"Article"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Article","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/articleSnapshot"},"children":[]}]}]}},{"type":"link","label":"Credit note","link":"/shoptet-api/openapi/snapshot/creditnotesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/creditnotesnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"creditNoteSnapshot"},"seo":{"title":"Credit note"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit note","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/creditNoteSnapshot"},"children":[]}]}]}},{"type":"link","label":"Customer","link":"/shoptet-api/openapi/snapshot/customersnapshot","routeSlug":"/shoptet-api/openapi/snapshot/customersnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"customerSnapshot"},"seo":{"title":"Customer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/customerSnapshot"},"children":[]}]}]}},{"type":"link","label":"Delivery note","link":"/shoptet-api/openapi/snapshot/deliverynotesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/deliverynotesnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"deliveryNoteSnapshot"},"seo":{"title":"Delivery note"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery note","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/deliveryNoteSnapshot"},"children":[]}]}]}},{"type":"link","label":"Discount coupon","link":"/shoptet-api/openapi/snapshot/discountcouponsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/discountcouponsnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"discountCouponSnapshot"},"seo":{"title":"Discount coupon"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discount coupon","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/discountCouponSnapshot"},"children":[]}]}]}},{"type":"link","label":"Invoice","link":"/shoptet-api/openapi/snapshot/invoicesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/invoicesnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"invoiceSnapshot"},"seo":{"title":"Invoice"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/invoiceSnapshot"},"children":[]}]}]}},{"type":"link","label":"Order history","link":"/shoptet-api/openapi/snapshot/orderhistorysnapshot","routeSlug":"/shoptet-api/openapi/snapshot/orderhistorysnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"orderHistorySnapshot"},"seo":{"title":"Order history"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order history","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/orderHistorySnapshot"},"children":[]}]}]}},{"type":"link","label":"Order","link":"/shoptet-api/openapi/snapshot/ordersnapshot","routeSlug":"/shoptet-api/openapi/snapshot/ordersnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"orderSnapshot"},"seo":{"title":"Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/orderSnapshot"},"children":[]}]}]}},{"type":"link","label":"Price list","link":"/shoptet-api/openapi/snapshot/pricelistsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/pricelistsnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"pricelistSnapshot"},"seo":{"title":"Price list"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Price list","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/pricelistSnapshot"},"children":[]}]}]}},{"type":"link","label":"Product price list","link":"/shoptet-api/openapi/snapshot/productpricelistsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/productpricelistsnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"productPricelistSnapshot"},"seo":{"title":"Product price list"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product price list","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/productPricelistSnapshot"},"children":[]}]}]}},{"type":"link","label":"Product","link":"/shoptet-api/openapi/snapshot/productsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/productsnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"productSnapshot"},"seo":{"title":"Product"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/productSnapshot"},"children":[]}]}]}},{"type":"link","label":"Proforma invoice","link":"/shoptet-api/openapi/snapshot/proformainvoicesnapshot","routeSlug":"/shoptet-api/openapi/snapshot/proformainvoicesnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"proformaInvoiceSnapshot"},"seo":{"title":"Proforma invoice"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proforma invoice","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/proformaInvoiceSnapshot"},"children":[]}]}]}},{"type":"link","label":"Proof payment","link":"/shoptet-api/openapi/snapshot/proofpaymentsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/proofpaymentsnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"proofPaymentSnapshot"},"seo":{"title":"Proof payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proof payment","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/proofPaymentSnapshot"},"children":[]}]}]}},{"type":"link","label":"Quantity discount","link":"/shoptet-api/openapi/snapshot/quantitydiscountsnapshot","routeSlug":"/shoptet-api/openapi/snapshot/quantitydiscountsnapshot","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"quantityDiscountSnapshot"},"seo":{"title":"Quantity discount"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quantity discount","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/quantityDiscountSnapshot"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Snapshot"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Snapshot","showPageActions":true},{"nodeType":"markdoc","content":"Schemas related to snapshot actions."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"Abandoned cart","link":"/snapshot/abandonedcartsnapshot","deprecated":false},{"title":"Article","link":"/snapshot/articlesnapshot","deprecated":false},{"title":"Credit note","link":"/snapshot/creditnotesnapshot","deprecated":false},{"title":"Customer","link":"/snapshot/customersnapshot","deprecated":false},{"title":"Delivery note","link":"/snapshot/deliverynotesnapshot","deprecated":false},{"title":"Discount coupon","link":"/snapshot/discountcouponsnapshot","deprecated":false},{"title":"Invoice","link":"/snapshot/invoicesnapshot","deprecated":false},{"title":"Order history","link":"/snapshot/orderhistorysnapshot","deprecated":false},{"title":"Order","link":"/snapshot/ordersnapshot","deprecated":false},{"title":"Price list","link":"/snapshot/pricelistsnapshot","deprecated":false},{"title":"Product price list","link":"/snapshot/productpricelistsnapshot","deprecated":false},{"title":"Product","link":"/snapshot/productsnapshot","deprecated":false},{"title":"Proforma invoice","link":"/snapshot/proformainvoicesnapshot","deprecated":false},{"title":"Proof payment","link":"/snapshot/proofpaymentsnapshot","deprecated":false},{"title":"Quantity discount","link":"/snapshot/quantitydiscountsnapshot","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":["array","null"],"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Short text error identification","examples":["example-error-code"]},"message":{"type":"string","description":"Descriptive error message","examples":["Example error message"]},"instance":{"type":"string","description":"Identification of the entity referenced","examples":["instance"]}},"required":["errorCode","message","instance"],"additionalProperties":false}}},"components/schemas/Metadata":{"id":"components/schemas/Metadata","kind":"json-schema","title":"Metadata","data":{"type":"object","properties":{"requestId":{"type":"string","description":"Request identifier. Useful for logging/reporting purposes.","examples":["019c8c34-64f3-7328-af43-bf1e34fa39d7"]}},"required":["requestId"],"additionalProperties":false}},"components/schemas/typeConstSymbol":{"id":"components/schemas/typeConstSymbol","kind":"json-schema","title":"typeConstSymbol","data":{"type":"string","pattern":"^[0-9]{1,4}$","description":"Const symbol. Only numbers are allowed (max length 4).","examples":["0308"]}},"components/schemas/typeConstSymbolNullable":{"id":"components/schemas/typeConstSymbolNullable","kind":"json-schema","title":"typeConstSymbolNullable","data":{"type":["string","null"],"pattern":"^[0-9]{1,4}$","description":"Const symbol. Only numbers are allowed (max length 4).","examples":["0308"]}},"components/schemas/typeSpecSymbol":{"id":"components/schemas/typeSpecSymbol","kind":"json-schema","title":"typeSpecSymbol","data":{"type":"integer","minimum":0,"maximum":9999999999,"examples":[201323134]}},"components/schemas/typeSpecSymbolNullable":{"id":"components/schemas/typeSpecSymbolNullable","kind":"json-schema","title":"typeSpecSymbolNullable","data":{"type":["integer","null"],"minimum":0,"maximum":9999999999,"examples":[201323134]}},"components/schemas/typeVarSymbol":{"id":"components/schemas/typeVarSymbol","kind":"json-schema","title":"typeVarSymbol","data":{"type":"integer","minimum":0,"maximum":9999999999,"examples":[2021000021]}},"components/schemas/typeVarSymbolNullable":{"id":"components/schemas/typeVarSymbolNullable","kind":"json-schema","title":"typeVarSymbolNullable","data":{"type":["integer","null"],"minimum":0,"maximum":9999999999,"examples":[2021000021]}},"components/schemas/salesChannelCurrency":{"id":"components/schemas/salesChannelCurrency","kind":"json-schema","title":"salesChannelCurrency","data":{"type":"object","additionalProperties":false,"required":["id","code","title","symbol","isSymbolOnLeft","precision","decimalSeparator","thousandSeparator","documentPrecision","rounding"],"properties":{"id":{"type":"integer","description":"Currency id.","examples":[1]},"code":{"$ref":"#/components/schemas/typeCurrencyCode"},"title":{"type":"string","description":"Currency title.","examples":["Koruna"]},"symbol":{"type":"string","description":"Currency symbol.","examples":["Kč"]},"isSymbolOnLeft":{"type":"boolean","description":"Whether the currency symbol is on left side.","examples":[false]},"precision":{"type":"integer","description":"Currency precision.","examples":[2]},"priority":{"type":["integer","null"],"description":"Currency priority.","examples":[1]},"decimalSeparator":{"type":"string","description":"Currency decimal separator.","examples":[","]},"thousandSeparator":{"type":["string","null"],"description":"Currency thousand separator.","examples":["."]},"documentPrecision":{"type":"integer","description":"Document precision.","examples":[0]},"rounding":{"type":"integer","description":"Currency rounding.","examples":[3]}}}},"components/schemas/typeCurrency":{"id":"components/schemas/typeCurrency","kind":"json-schema","title":"typeCurrency","data":{"type":"object","additionalProperties":false,"required":["code","title","symbol","isSymbolOnLeft","precision","decimalSeparator"],"properties":{"code":{"$ref":"#/components/schemas/typeCurrencyCode"},"title":{"type":"string","description":"Currency title.","examples":["Koruna"]},"symbol":{"type":"string","description":"Currency symbol.","examples":["Kč"]},"isSymbolOnLeft":{"type":"boolean","description":"Whether the currency symbol is on left side.","examples":[false]},"precision":{"type":"integer","description":"Currency precision.","examples":[2]},"priority":{"type":["integer","null"],"description":"Currency priority.","examples":[1]},"decimalSeparator":{"type":"string","description":"Currency decimal separator.","examples":[","]},"thousandSeparator":{"type":"string","description":"Currency thousand separator.","examples":["."]},"isDefault":{"type":"boolean","description":"Whether the language is default.","examples":[true]}}}},"components/schemas/typeLanguage":{"id":"components/schemas/typeLanguage","kind":"json-schema","title":"typeLanguage","data":{"type":"object","additionalProperties":false,"required":["code","name","dateFormat","timeFormat","isVisible","isBlocked"],"properties":{"code":{"type":"string","description":"Language code.","examples":["cs"]},"name":{"type":"string","description":"Language name.","examples":["Čeština"]},"dateFormat":{"type":"string","description":"Date format of language.","examples":["Y. n. j."]},"timeFormat":{"type":"string","description":"Time format of language.","examples":["H:i"]},"isVisible":{"type":"boolean","description":"Whether the language is visible.","examples":[true]},"isBlocked":{"type":"boolean","description":"Whether the language is blocked.","examples":[false]},"priority":{"type":["integer","null"],"description":"Language priority.","examples":[3]},"isDefault":{"type":"boolean","description":"Whether the language is default.","examples":[true]}}}},"components/schemas/salesChannelLanguage":{"id":"components/schemas/salesChannelLanguage","kind":"json-schema","title":"salesChannelLanguage","data":{"type":"object","additionalProperties":false,"required":["id","name","indexName","dateFormat","timeFormat","isVisible","isBlocked","priority","locale"],"properties":{"id":{"type":"integer","description":"Language id.","examples":[1]},"name":{"type":"string","description":"Language name.","examples":["Čeština"]},"indexName":{"type":"string","description":"Language index name.","examples":["cs"]},"dateFormat":{"type":"string","description":"Date format of language.","examples":["Y. n. j."]},"timeFormat":{"type":"string","description":"Time format of language.","examples":["H:i"]},"isVisible":{"type":"boolean","description":"Whether the language is visible.","examples":[true]},"isBlocked":{"type":"boolean","description":"Whether the language is blocked.","examples":[false]},"priority":{"type":["integer","null"],"description":"Language priority.","examples":[3]},"locale":{"type":"string","description":"Locale of language.","examples":["cs_CZ"]}}}},"components/schemas/typeAmount":{"id":"components/schemas/typeAmount","kind":"json-schema","title":"typeAmount","data":{"type":"string","pattern":"^(-)?[0-9]+\\.[0-9]{3}$","examples":["1.000"]}},"components/schemas/typeAmountNullable":{"id":"components/schemas/typeAmountNullable","kind":"json-schema","title":"typeAmountNullable","data":{"type":["string","null"],"pattern":"^(-)?[0-9]+\\.[0-9]{3}$","examples":["1.000"]}},"components/schemas/typePositiveAmount":{"id":"components/schemas/typePositiveAmount","kind":"json-schema","title":"typePositiveAmount","data":{"type":"string","pattern":"^[0-9]+\\.[0-9]{3}$","examples":["1.000"]}},"components/schemas/typePositiveAmountNullable":{"id":"components/schemas/typePositiveAmountNullable","kind":"json-schema","title":"typePositiveAmountNullable","data":{"type":["string","null"],"pattern":"^[0-9]+\\.[0-9]{3}$","examples":["1.000"]}},"components/schemas/typePrice":{"id":"components/schemas/typePrice","kind":"json-schema","title":"typePrice","data":{"type":"string","pattern":"^(-)?[0-9]+\\.[0-9]{2}$","examples":["21.00"]}},"components/schemas/typePriceNullable":{"id":"components/schemas/typePriceNullable","kind":"json-schema","title":"typePriceNullable","data":{"type":["string","null"],"pattern":"^(-)?[0-9]+\\.[0-9]{2}$","examples":["21.00"]}},"components/schemas/typePriceRatio":{"id":"components/schemas/typePriceRatio","kind":"json-schema","title":"typePriceRatio","data":{"type":"string","pattern":"[0-9]+\\.[0-9]{4}$","examples":["0.7800"]}},"components/schemas/typeProductPriceRatio":{"id":"components/schemas/typeProductPriceRatio","kind":"json-schema","title":"typeProductPriceRatio","data":{"type":"string","pattern":"[0-9]+\\.[0-9]{3}$","examples":["0.780"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"price ratio. The price of the product shall be calculated by multiplying the price and this coefficient. The price ratio affects only the price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the special discounted price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actionPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is not affected by the ratio. This ratio has 3 decimal places and can be greater than 1,000"},"children":[]}]}]}]}},"components/schemas/typeVatRate":{"id":"components/schemas/typeVatRate","kind":"json-schema","title":"typeVatRate","data":{"type":"string","pattern":"^[0-9]+\\.[0-9]{2}$","examples":["21.00"]}},"components/schemas/typeVatRateNullable":{"id":"components/schemas/typeVatRateNullable","kind":"json-schema","title":"typeVatRateNullable","data":{"type":["string","null"],"pattern":"^[0-9]+\\.[0-9]{2}$","examples":["21.00"]}},"components/schemas/typeCurrencyCode":{"id":"components/schemas/typeCurrencyCode","kind":"json-schema","title":"typeCurrencyCode","data":{"type":"string","pattern":"^[a-zA-Z]{3}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code. List of available currencies within the e-shop can be found in endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/eshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["CZK"]}},"components/schemas/typeCurrencyCodeNullable":{"id":"components/schemas/typeCurrencyCodeNullable","kind":"json-schema","title":"typeCurrencyCodeNullable","data":{"type":["string","null"],"pattern":"^[a-zA-Z]{3}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency code. List of available currencies within the e-shop can be found in endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/eshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["CZK"]}},"components/schemas/typeDimension":{"id":"components/schemas/typeDimension","kind":"json-schema","title":"typeDimension","data":{"type":"string","pattern":"^[0-9]{1,4}\\.[0-9]{1}$","examples":["10.0"]}},"components/schemas/typeWeight":{"id":"components/schemas/typeWeight","kind":"json-schema","title":"typeWeight","data":{"type":"string","pattern":"^[0-9]{1,6}\\.[0-9]{3}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weight in kg, unpacked (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). 3 decimal places. Maximum value 999999."},"children":[]}]}]}],"examples":["1.234"]}},"components/schemas/typeWeightUnlimited":{"id":"components/schemas/typeWeightUnlimited","kind":"json-schema","title":"typeWeightUnlimited","data":{"type":["string","null"],"pattern":"^[0-9]+\\.[0-9]{3}$","description":"weight in kg, unpacked, 3 decimal places. Maximum value 999999.","examples":["1.234"]}},"components/schemas/typeWeightRequest":{"id":"components/schemas/typeWeightRequest","kind":"json-schema","title":"typeWeightRequest","data":{"type":["string","null"],"pattern":"^[0-9]{1,5}\\.[0-9]{3}$","examples":["15.500"]}},"components/schemas/typeDate":{"id":"components/schemas/typeDate","kind":"json-schema","title":"typeDate","data":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","format":"date","examples":["2017-04-04"]}},"components/schemas/typeDateNullable":{"id":"components/schemas/typeDateNullable","kind":"json-schema","title":"typeDateNullable","data":{"type":["string","null"],"pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","format":"date","examples":["2017-04-04"]}},"components/schemas/typeDateTime":{"id":"components/schemas/typeDateTime","kind":"json-schema","title":"typeDateTime","data":{"type":"string","pattern":"^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0-5][0-9]:[0-5][0-9]\\+[0-9]{4}$","examples":["2018-05-29T09:02:27+0200"]}},"components/schemas/typeDateTimeNullable":{"id":"components/schemas/typeDateTimeNullable","kind":"json-schema","title":"typeDateTimeNullable","data":{"type":["string","null"],"pattern":"^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0-5][0-9]:[0-5][0-9]\\+[0-9]{4}$","examples":["2018-05-29T09:02:27+0200"]}},"components/schemas/typeDateTimeRequest":{"id":"components/schemas/typeDateTimeRequest","kind":"json-schema","title":"typeDateTimeRequest","data":{"type":["string","null"],"pattern":"^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0-5][0-9]:[0-5][0-9](\\+[0-9]{4})?$","examples":["2018-05-29T09:02:27"]}},"components/schemas/typeExchangeRate":{"id":"components/schemas/typeExchangeRate","kind":"json-schema","title":"typeExchangeRate","data":{"type":"string","pattern":"^[0-9]+\\.[0-9]{8}$","description":"currency rate of the receipt for the default currency of the shop. This value is saved together with the price and reflects the historical value valid in the instant of the order creation. If the shop changes the default currency, the value still refers to the original currency!","examples":["1.04568087"]}},"components/schemas/typeCustomerFieldValue":{"id":"components/schemas/typeCustomerFieldValue","kind":"json-schema","title":"typeCustomerFieldValue","data":{"type":"string","enum":["required","optional","hidden"],"examples":["required","optional","hidden"]}},"components/schemas/typeUnitRatio":{"id":"components/schemas/typeUnitRatio","kind":"json-schema","title":"typeUnitRatio","data":{"type":"string","pattern":"^[0-9]+\\.[0-9]{9}$","description":"Unit ratio","examples":["0.001000000"]}},"components/schemas/typeGuid":{"id":"components/schemas/typeGuid","kind":"json-schema","title":"typeGuid","data":{"type":"string","maxLength":36,"pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]}},"components/schemas/typeGuidNullable":{"id":"components/schemas/typeGuidNullable","kind":"json-schema","title":"typeGuidNullable","data":{"type":["string","null"],"maxLength":36,"pattern":"^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]}},"components/schemas/typeGuidUnlimited":{"id":"components/schemas/typeGuidUnlimited","kind":"json-schema","title":"typeGuidUnlimited","data":{"type":"string","maxLength":36,"examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]}},"components/schemas/typeNonEmptyString":{"id":"components/schemas/typeNonEmptyString","kind":"json-schema","title":"typeNonEmptyString","data":{"type":"string","minLength":1}},"components/schemas/typeFilename":{"id":"components/schemas/typeFilename","kind":"json-schema","title":"typeFilename","data":{"type":"string","maxLength":255,"pattern":"^[0-9a-zA-Z_\\-.]+$"}},"components/schemas/typeFilenameNullable":{"id":"components/schemas/typeFilenameNullable","kind":"json-schema","title":"typeFilenameNullable","data":{"type":["string","null"],"maxLength":255,"pattern":"^[0-9a-zA-Z_\\-.]+$","examples":["image.png"]}},"components/schemas/typeColor":{"id":"components/schemas/typeColor","kind":"json-schema","title":"typeColor","data":{"type":["string","null"],"pattern":"^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$","examples":["FF00FF","#FF00FF","#ffffff"]}},"components/schemas/typeVariantCodeRequest":{"id":"components/schemas/typeVariantCodeRequest","kind":"json-schema","title":"typeVariantCodeRequest","data":{"type":"string","pattern":"^[a-zA-Z0-9_\\/ \\-\\.]+$","maxLength":64,"description":"Variant's code. Must be unique if set. After processing it will be converted to uppercase. Generated automatically if not set.","examples":["0035"]}},"components/schemas/typeHsCodeNullable":{"id":"components/schemas/typeHsCodeNullable","kind":"json-schema","title":"typeHsCodeNullable","data":{"type":["string","null"],"pattern":"^\\d{6,10}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Harmonized system code with 6–10 digits (accepting leading zeros)."},"children":[]}]}]}],"examples":["95030099","060910"]}},"components/schemas/paginator":{"id":"components/schemas/paginator","kind":"json-schema","title":"paginator","data":{"type":"object","additionalProperties":false,"required":["totalCount","page","pageCount","itemsOnPage","itemsPerPage"],"properties":{"totalCount":{"type":"integer","description":"total number of available records","examples":[55]},"page":{"type":"integer","description":"current page","examples":[1]},"pageCount":{"type":"integer","description":"total available of pages","examples":[3]},"itemsOnPage":{"type":"integer","description":"number of currently returned records","examples":[20]},"itemsPerPage":{"type":"integer","description":"required number of records per page","examples":[20]}}}},"components/schemas/itemSurchargeParameters":{"id":"components/schemas/itemSurchargeParameters","kind":"json-schema","title":"itemSurchargeParameters","data":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"parameterName":{"type":"object","additionalProperties":false,"description":"surcharge parameter name's information","properties":{"code":{"type":["string","null"],"description":"parameters name code, can be null if already deleted","examples":["priplatek"]},"name":{"type":"string","description":"parameters name","examples":["Příplatek"]},"subscription":{"type":["boolean","null"],"description":"indicates whether this surcharge parameter is a subscription (recurring payment)","examples":[true,false]}}},"parameterValue":{"type":"object","additionalProperties":false,"description":"surcharge parameter value's information","properties":{"valueIndex":{"type":["string","null"],"description":"parameters value code, can be null if already deleted","examples":["zlaty"]},"description":{"type":"string","description":"parameters value name","examples":["Zlatý"]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"parameters value additional price","examples":["100.00"]}}}}}}},"components/schemas/itemSpecificSurchargeParameters":{"id":"components/schemas/itemSpecificSurchargeParameters","kind":"json-schema","title":"itemSpecificSurchargeParameters","data":{"type":"array","items":{"type":"object","required":["relationId","name","price"],"additionalProperties":false,"properties":{"relationId":{"type":"string","description":"id which identifies relation between item and surcharge. Can be used to delete surcharge parameter related to item.","examples":["abc123"]},"name":{"type":"string","description":"full name of surcharge parameter.","examples":["Povinný - příplatek"]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"price of surcharge parameter","examples":["123.00"]}}}}},"components/schemas/productFlags":{"id":"components/schemas/productFlags","kind":"json-schema","title":"productFlags","data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","title","system"],"properties":{"code":{"type":"string","description":"flag identifier","examples":["action"]},"title":{"type":"string","description":"flag title","examples":["Action"]},"system":{"type":"boolean","description":"is it a system flag common for all e-shops?","examples":[true]}}}}},"components/schemas/itemSurchargeParametersWithoutPrice":{"id":"components/schemas/itemSurchargeParametersWithoutPrice","kind":"json-schema","title":"itemSurchargeParametersWithoutPrice","data":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"parameterName":{"type":"object","additionalProperties":false,"properties":{"code":{"type":["string","null"]},"name":{"type":"string"},"subscription":{"type":["boolean","null"]}}},"parameterValue":{"type":"object","additionalProperties":false,"properties":{"valueIndex":{"type":["string","null"]},"description":{"type":"string"}}}}}}},"components/schemas/itemSpecificSurchargeParametersWithoutPrice":{"id":"components/schemas/itemSpecificSurchargeParametersWithoutPrice","kind":"json-schema","title":"itemSpecificSurchargeParametersWithoutPrice","data":{"type":"array","items":{"type":"object","required":["relationId","name"],"additionalProperties":false,"properties":{"relationId":{"type":"string"},"name":{"type":"string"}}}}},"components/schemas/surchargeParameterValue":{"id":"components/schemas/surchargeParameterValue","kind":"json-schema","title":"surchargeParameterValue","data":{"type":"object","additionalProperties":false,"required":["id","valueIndex","description","price","priority"],"properties":{"id":{"type":"integer","description":"Id of surcharge parameter value. This identifier is used on eshop frontend.","examples":[23]},"valueIndex":{"type":"string","description":"Code (identifier) of parameter's value","examples":["zlaty"]},"description":{"type":"string","description":"Description (name) of parameter's value","examples":["Zlatý"]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"Price of parameter's value"},"priority":{"type":["integer","null"],"description":"Priority of parameter's value","examples":[1]}}}},"components/schemas/productSurchargeParameter":{"id":"components/schemas/productSurchargeParameter","kind":"json-schema","title":"productSurchargeParameter","data":{"type":"object","additionalProperties":false,"required":["code","name","displayName","description","priority","required","currency","includingVat","values"],"properties":{"code":{"type":"string","description":"parameter identifier","examples":["potisk"]},"name":{"type":"string","description":"parameter name","examples":["S potiskem"]},"displayName":{"type":["string","null"],"description":"parameter display name","examples":["Příplatek za potisk"]},"description":{"type":["string","null"],"description":"parameter description","examples":["Ozdobný potisk"]},"priority":{"type":["integer","null"],"description":"parameter priority","examples":[1]},"required":{"type":"boolean","description":"Is value for parameter required?","examples":[true]},"currency":{"type":"string","description":"Currency of price in parameter's values","examples":["CZK"]},"includingVat":{"type":"boolean","description":"Is price in parameter's values including VAT?","examples":[true]},"subscription":{"type":["boolean","null"],"description":"indicates whether this surcharge parameter is a subscription (recurring payment)","examples":[true,false]},"values":{"type":"array","description":"Possible parameter's values","items":{"$ref":"#/components/schemas/productSurchargeParameterValue"}}}}},"components/schemas/productSurchargeParameterValue":{"id":"components/schemas/productSurchargeParameterValue","kind":"json-schema","title":"productSurchargeParameterValue","data":{"type":"object","additionalProperties":false,"required":["valueIndex","description","price","priority","visible"],"properties":{"valueIndex":{"type":"string","description":"Code (identifier) of parameter's value","examples":["zlaty"]},"description":{"type":"string","description":"Description (name) of parameter's value","examples":["Zlatý"]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"Price of parameter's value","examples":["100.00"]},"priority":{"type":["integer","null"],"description":"Priority of parameter's value","examples":[1]},"visible":{"type":"boolean","description":"Is parameter value visible?","examples":[true]}}}},"components/schemas/productRequestSurchargeParameter":{"id":"components/schemas/productRequestSurchargeParameter","kind":"json-schema","title":"productRequestSurchargeParameter","data":{"type":"object","additionalProperties":false,"required":["code","values"],"properties":{"code":{"type":"string","minLength":1,"maxLength":255,"description":"parameter identifier, language dependent","examples":["pp-1"]},"values":{"type":"array","minItems":1,"description":"Product surcharge parameter values.","items":{"$ref":"#/components/schemas/productRequestSurchargeParameterValue"}}}}},"components/schemas/productRequestSurchargeParameterValue":{"id":"components/schemas/productRequestSurchargeParameterValue","kind":"json-schema","title":"productRequestSurchargeParameterValue","data":{"type":"object","additionalProperties":false,"required":["valueIndex"],"properties":{"valueIndex":{"type":"string","minLength":1,"maxLength":255,"description":"parameter value identifier, language dependent","examples":["hodnota-01"]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"surcharge amount which is added to the product price for the customer when this parameter is chosen.","examples":["650.00"]},"visible":{"type":"boolean","description":"flag, whether the parameter value is visible","examples":[true]}}}},"components/schemas/productFilteringParameterValue":{"id":"components/schemas/productFilteringParameterValue","kind":"json-schema","title":"productFilteringParameterValue","data":{"type":"object","additionalProperties":false,"required":["id","valueIndex","name","priority","color","image"],"description":"Possible parameter's values","properties":{"id":{"type":"integer","description":"Parameter value id","examples":[1]},"valueIndex":{"type":["string","null"],"description":"Code (identifier) of parameter's value","examples":["ag"]},"name":{"type":"string","description":"Description (name) of parameter's value","examples":["Gold"]},"priority":{"type":["integer","null"],"description":"Parameter value priority","examples":[1]},"color":{"type":["string","null"],"description":"Hex code of color","examples":["#34ff34"]},"image":{"type":["string","null"],"description":"Url of image","examples":["https://www.domena-eshopu.cz/user/parameters/100.jpg"]}}}},"components/schemas/productVariantParameterValue":{"id":"components/schemas/productVariantParameterValue","kind":"json-schema","title":"productVariantParameterValue","data":{"type":"object","additionalProperties":false,"required":["id","paramValue","rawValue","color","image","valuePriority"],"properties":{"id":{"type":"integer","description":"Parameter value id","examples":[1]},"paramValue":{"type":"string","description":"Description (name) of parameter's value","examples":["Color Red"]},"rawValue":{"type":"string","description":"Code (identifier) of parameter's value","examples":["color-red"]},"color":{"type":["string","null"],"description":"Hex code of color","examples":["#34ff34"]},"image":{"type":["string","null"],"description":"Url of image","examples":["https://www.domena-eshopu.cz/user/parameters/100.jpg"]},"valuePriority":{"type":["integer","null"],"description":"Parameter value priority","examples":[1]}}}},"components/schemas/consumptionTax":{"id":"components/schemas/consumptionTax","kind":"json-schema","title":"consumptionTax","data":{"type":"object","additionalProperties":false,"required":["id","name","price","currency","isVisible","created","updated"],"properties":{"id":{"type":"integer","description":"Consumption tax id.","examples":[1]},"name":{"type":"string","description":"Consumption tax name.","examples":["ABC"]},"price":{"$ref":"#/components/schemas/typePrice","description":"Consumption tax amount.","examples":["50.00"]},"currency":{"type":"string","description":"Consumption tax currency.","examples":["EUR"]},"isVisible":{"type":"boolean","description":"Flag, whether the consumption tax is visible in documents or not.","examples":[false]},"created":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Consumption tax creation date.","examples":["2018-08-02T17:22:02+0200"]},"updated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Consumption tax update date.","examples":["2018-08-02T17:22:02+0200"]}}}},"components/schemas/measureUnit":{"id":"components/schemas/measureUnit","kind":"json-schema","title":"measureUnit","data":{"type":["object","null"],"additionalProperties":false,"required":["packagingUnitId","packagingAmount","measureUnitId","measureAmount"],"properties":{"packagingUnitId":{"type":["integer","null"],"description":"Packaging unit id","examples":[22]},"packagingAmount":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"amount being in a package","examples":["1.000"]},"measureUnitId":{"type":["integer","null"],"description":"Measure unit id","examples":[1]},"measureAmount":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"referential amount","examples":["1"]}}}},"components/schemas/recyclingFee":{"id":"components/schemas/recyclingFee","kind":"json-schema","title":"recyclingFee","data":{"type":["object","null"],"additionalProperties":false,"required":["category","fee"],"properties":{"category":{"$ref":"#/components/schemas/typeNonEmptyString","description":"Recycling fee category name.","examples":["shoes"]},"fee":{"$ref":"#/components/schemas/typePriceNullable","description":"Recycling fee."},"unit":{"enum":["pcs","kg"],"description":"Recycling fee unit.","examples":["pcs"]}}}},"components/schemas/recyclingFeeCategory":{"id":"components/schemas/recyclingFeeCategory","kind":"json-schema","title":"recyclingFeeCategory","data":{"type":"object","additionalProperties":false,"required":["id","category","fee","unit","currency"],"properties":{"id":{"type":"integer","description":"Recycling fee category id.","examples":[1]},"category":{"type":"string","description":"Recycling fee category name.","examples":["Cups"]},"fee":{"$ref":"#/components/schemas/typePrice","description":"Recycling fee amount."},"unit":{"enum":["pcs","kg"],"description":"Recycling fee unit.","examples":["pcs"]},"currency":{"type":"string","description":"Currency code of recycling fee.","examples":["EUR"]}}}},"components/schemas/productConsumptionTax":{"id":"components/schemas/productConsumptionTax","kind":"json-schema","title":"productConsumptionTax","data":{"type":"object","additionalProperties":false,"required":["id","name","price","currency"],"properties":{"id":{"type":"integer","description":"Consumption tax identifier.","examples":[1]},"name":{"type":"string","description":"Consumption tax name.","examples":["Tobacco"]},"price":{"$ref":"#/components/schemas/typePrice","description":"Consumption tax price."},"currency":{"type":"string","description":"Currency code of consumption tax.","examples":["CZK"]}}}},"components/schemas/billingMethod":{"id":"components/schemas/billingMethod","kind":"json-schema","title":"billingMethod","data":{"type":"object","additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"integer","description":"unique identifier of billing method","examples":[3]},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"designation of the billing method; see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["Cash"]}}}},"components/schemas/itemPrice":{"id":"components/schemas/itemPrice","kind":"json-schema","title":"itemPrice","data":{"type":"object","additionalProperties":false,"required":["withVat","withoutVat","vat","vatRate"],"properties":{"withVat":{"$ref":"#/components/schemas/typePriceNullable","description":"price including tax","examples":["121.00"]},"withoutVat":{"$ref":"#/components/schemas/typePriceNullable","description":"price excluding tax","examples":["100.00"]},"vat":{"$ref":"#/components/schemas/typePriceNullable","description":"VAT value, two decimal places"},"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":"VAT rate"}}}},"components/schemas/productPrices":{"id":"components/schemas/productPrices","kind":"json-schema","title":"productPrices","data":{"type":["object"],"additionalProperties":false,"properties":{"purchasePrice":{"type":"object","additionalProperties":false,"description":"purchase price of the product variant. Currently for preview only! Will be used as replace for buy price. Please watch API news.","required":["price","vatRate","includingVat"],"properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":"purchase price of the product variant","examples":["500.00"]},"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":"VAT rate","examples":[21]},"includingVat":{"type":"boolean","description":"flag, whether the purchase price is including VAT","examples":[true]}}}}}},"components/schemas/cartPrice":{"id":"components/schemas/cartPrice","kind":"json-schema","title":"cartPrice","data":{"type":"object","additionalProperties":false,"required":["withVat","withoutVat","vat"],"properties":{"withVat":{"$ref":"#/components/schemas/typePriceNullable","description":"Total price with VAT","examples":["121.00"]},"withoutVat":{"$ref":"#/components/schemas/typePriceNullable","description":"Total price without VAT","examples":["100.00"]},"vat":{"$ref":"#/components/schemas/typePriceNullable","description":"Total price VAT (not VAT rate)","examples":["21.00"]}}}},"components/schemas/paymentMethod":{"id":"components/schemas/paymentMethod","kind":"json-schema","title":"paymentMethod","data":{"type":"object","additionalProperties":false,"required":["guid","name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment method identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"name":{"type":"string","description":"description of payment method","examples":["Cash"]}}}},"components/schemas/shipping":{"id":"components/schemas/shipping","kind":"json-schema","title":"shipping","data":{"type":["object","null"],"additionalProperties":false,"required":["guid","name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"transport type identifier"},"name":{"type":"string","description":"description of transport method (Czech post, PPL, in person..)","examples":["PPL"]}}}},"components/schemas/stockList":{"id":"components/schemas/stockList","kind":"json-schema","title":"stockList","data":{"type":"object","additionalProperties":false,"required":["id","title","isDeliveryPoint","visibleOnEshop","deliveryPointTitle","deliveryPointAddress"],"properties":{"id":{"type":"integer","description":"stock unique ID","examples":[1]},"title":{"type":"string","description":"stock name","examples":["Main stock"]},"isDeliveryPoint":{"type":"boolean","description":"flag, whether the stock is also a distribution point","examples":[false]},"visibleOnEshop":{"type":"boolean","description":"flag, whether the stock is visible on eshop","examples":[true]},"deliveryPointTitle":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of the distribution point (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Main delivery point"]},"deliveryPointAddress":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address of the distribution point (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Main street 123, Prague"]}}}},"components/schemas/stock":{"id":"components/schemas/stock","kind":"json-schema","title":"stock","data":{"type":"object","additionalProperties":false,"required":["id","title","isDeliveryPoint","visibleOnEshop","deliveryPointTitle","deliveryPointAddress","type","parentStockId"],"properties":{"id":{"type":"integer","description":"stock unique ID","examples":[1]},"title":{"type":"string","description":"stock name","examples":["Main stock"]},"isDeliveryPoint":{"type":"boolean","description":"flag, whether the stock is also a distribution point","examples":[false]},"visibleOnEshop":{"type":"boolean","description":"flag, whether the stock is visible on eshop","examples":[true]},"deliveryPointTitle":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of the distribution point (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Main delivery point"]},"deliveryPointAddress":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address of the distribution point (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Main street 123, Prague"]},"type":{"enum":["internalPhysical","internalVirtual","external",null],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stock type, enum, determines if stock is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internalPhysical"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default setting, same as current ordinary stock), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internalVirtual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (logical subdivision of an internal physical stock, child with a parent stock - see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentStockid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (external standalone warehouse)"},"children":[]}]}]}],"examples":["internalVirtual"]},"parentStockId":{"type":["integer","null"],"description":"Parent stock ID","examples":[1]}}}},"components/schemas/availabilityShort":{"id":"components/schemas/availabilityShort","kind":"json-schema","title":"availabilityShort","data":{"type":["object","null"],"additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"integer","description":"availability unique ID","examples":[-1]},"name":{"type":"string","description":"availability name","examples":["Sold out"]}}}},"components/schemas/supplier":{"id":"components/schemas/supplier","kind":"json-schema","title":"supplier","data":{"type":"object","additionalProperties":false,"required":["guid","name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"supplier unique ID"},"name":{"type":"string","description":"supplier name","examples":["Willy Wonka"]}}}},"components/schemas/brand":{"id":"components/schemas/brand","kind":"json-schema","title":"brand","data":{"type":"object","additionalProperties":false,"required":["guid","name","indexName","description","brandWeb","showInCategoriesMenu","showInBrandList","metaTitle","metaDescription"],"properties":{"guid":{"type":"string","description":"brand GUID","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"name":{"type":"string","description":"Name of brand","examples":["Willy Wonka"]},"indexName":{"type":"string","description":"Unique index name of brand","examples":["willy-wonka"]},"description":{"type":["string","null"],"description":"Description of brand. May contain HTML character","examples":["

Brand new chocolate everyday

"]},"brandWeb":{"type":["string","null"],"description":"URL of brand website","examples":["https://www.willywonka.com"]},"postalAddress":{"type":["string","null"],"description":"GPSR, postal address","examples":["Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789"]},"contactEmail":{"type":["string","null"],"description":"GPSR, contact email","examples":["willywonka@shoptet.cz"]},"europeanResellerPostalAddress":{"type":["string","null"],"description":"GPSR, european reseller postal address","examples":["Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789"]},"europeanResellerContactEmail":{"type":["string","null"],"description":"GPSR, reseller contact email","examples":["europeanreseller@shoptet.cz"]},"manufacturingCompanyName":{"type":["string","null"],"description":"GPSR, manufacturing company name","examples":["Shoptet a.s."]},"europeanResellerManufacturingCompanyName":{"type":["string","null"],"description":"GPSR, reseller manufacturing company name","examples":["Shoptet a.s."]},"showInCategoriesMenu":{"type":"boolean","description":"Is this brand shown in categories menu?","examples":[true]},"showInBrandList":{"type":"boolean","description":"Is this brand shown in brand list?","examples":[false]},"metaTitle":{"type":["string","null"],"description":"Meta title of brand","examples":["Willy Wonka"]},"metaDescription":{"type":["string","null"],"description":"Meta description of brand","examples":["Willy Wonka - Chocolate Factory"]}}}},"components/schemas/brandCreate":{"id":"components/schemas/brandCreate","kind":"json-schema","title":"brandCreate","data":{"type":"object","additionalProperties":false,"minProperties":1,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Brand name","examples":["Willy Wonka"]},"indexName":{"type":["string","null"],"description":"unique index name of brand","examples":["willy-wonka"]},"brandWeb":{"type":["string","null"],"minLength":1,"maxLength":200,"description":"Brand website","examples":["https://willywonka.com"]},"postalAddress":{"type":["string","null"],"minLength":1,"maxLength":65535,"description":"GPSR, postal address","examples":["Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789"]},"contactEmail":{"type":["string","null"],"minLength":1,"maxLength":100,"description":"GPSR, contact email","examples":["willywonka@shoptet.cz"]},"europeanResellerPostalAddress":{"type":["string","null"],"minLength":1,"maxLength":65535,"description":"GPSR, european reseller postal address","examples":["Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789"]},"europeanResellerContactEmail":{"type":["string","null"],"minLength":1,"maxLength":100,"description":"GPSR, reseller contact email","examples":["europeanreseller@shoptet.cz"]},"manufacturingCompanyName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"GPSR, manufacturing company name","examples":["Shoptet a.s."]},"europeanResellerManufacturingCompanyName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"GPSR, Reseller manufacturing company name","examples":["Shoptet a.s."]},"showInCategoriesMenu":{"type":"boolean","description":"Is this brand shown in categories menu? Default is false","examples":[true]},"showInBrandList":{"type":"boolean","description":"Is this brand shown in brand list? Default is false","examples":[true]},"description":{"type":["string","null"],"description":"Description of brand. May contain HTML characters","examples":["

Brand new chocolate everyday

"]},"metaTitle":{"type":["string","null"],"description":"Meta title of brand","examples":["Willy Wonka"]},"metaDescription":{"type":["string","null"],"description":"Meta description of brand","examples":["Brand new chocolate everyday"]}}}},"components/schemas/brandNamed":{"id":"components/schemas/brandNamed","kind":"json-schema","title":"brandNamed","data":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","description":"unique brand code","examples":["willy-wonka"]},"name":{"type":"string","description":"brand name","examples":["Willy Wonka"]}}}},"components/schemas/webhook":{"id":"components/schemas/webhook","kind":"json-schema","title":"webhook","data":{"type":"object","additionalProperties":false,"required":["id","event","url","created","updated","sendPayload"],"properties":{"id":{"type":"integer","description":"notification unique ID","examples":[992801]},"event":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["order:create"]},"url":{"type":"string","description":"webhook URL","examples":["https://myapplication.tld/orders.php"]},"created":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"webhook registration date"},"updated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook update date (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"sendPayload":{"type":["string","null"],"enum":["full",null],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the webhook notification body will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with the full entity data. Only supported for events marked as payload-supported in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means payload delivery is disabled."},"children":[]}]}]}]}}}},"components/schemas/webhookNotification":{"id":"components/schemas/webhookNotification","kind":"json-schema","title":"webhookNotification","data":{"type":"object","additionalProperties":false,"required":["id","webhookId","webhookUrl","event","eventCreated","created","attempted","attempts","status","active","data"],"properties":{"id":{"type":"integer","description":"notification unique ID","examples":[992801]},"webhookId":{"type":"integer","description":"link to webhook, which invoked the notification","examples":[10201]},"webhookUrl":{"type":"string","description":"webhook URL in the instant, when the notification was created","examples":["https://myapplication.tld/orders.php"]},"event":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["order:create"]},"eventCreated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"time of event creation - notification"},"created":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time, when the webhook notification was created"},"attempted":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time of last notification delivery attempt at webhook URL (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"attempts":{"type":"integer","description":"number of implemented attempts to deliver the notification","examples":[3]},"status":{"type":"string","description":"results of the last attempt to deliver the notification","examples":["failed"]},"active":{"type":"boolean","description":"flag that the notification was not delivered yet, and the number of attempts did not reach the maximum amount The notification will be resent to the target URL","examples":[true]},"data":{"$ref":"#/components/schemas/notificationData","description":"content of sent notification"}}}},"components/schemas/notificationData":{"id":"components/schemas/notificationData","kind":"json-schema","title":"notificationData","data":{"type":"object","additionalProperties":false,"required":["eshopId","event","eventCreated","eventInstance"],"properties":{"eshopId":{"type":"integer","description":"number of (id) e-shop","examples":[1]},"event":{"type":"string","examples":["order:create"]},"eventCreated":{"$ref":"#/components/schemas/typeDateTimeNullable"},"eventInstance":{"type":"string","description":"Identification of the entity that the notification concerns. For example order number, product GUID, etc.","examples":["c9e976a5-340b-11e4-b500-ac162d8a2454"]}}}},"components/schemas/price":{"id":"components/schemas/price","kind":"json-schema","title":"price","data":{"type":"object","additionalProperties":false,"required":["vat","toPay","currencyCode","withoutVat","withVat","exchangeRate"],"properties":{"vat":{"$ref":"#/components/schemas/typePriceNullable","description":"VAT value, two decimal places","examples":["42.00"]},"toPay":{"$ref":"#/components/schemas/typePriceNullable","description":"total price to pay","examples":["242.00"]},"currencyCode":{"$ref":"#/components/schemas/typeCurrencyCode"},"withoutVat":{"$ref":"#/components/schemas/typePriceNullable","description":"price excluding tax","examples":["200.00"]},"withVat":{"$ref":"#/components/schemas/typePriceNullable","description":"price including tax","examples":["242.00"]},"exchangeRate":{"$ref":"#/components/schemas/typeExchangeRate"},"invoicingExchangeRate":{"$ref":"#/components/schemas/typeExchangeRate"},"partialPaymentAmount":{"$ref":"#/components/schemas/typePriceNullable","description":"can be value expressed in percents or as exact money value expression (with up to two decimal places) - depends on partialPaymentType value","examples":["100.00"]},"partialPaymentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'percents' = partial payment as percentage from total price | 'absolute' = exact expression of partial payment in money"},"children":[]}]}]}],"examples":["percents"]}}}},"components/schemas/address":{"id":"components/schemas/address","kind":"json-schema","title":"address","data":{"type":["object","null"],"additionalProperties":false,"required":["company","fullName","street","houseNumber","city","district","additional","zip","countryCode","regionName","regionShortcut"],"properties":{"company":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of purchaser''s company (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Shoptet s.r.o."]},"fullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of purchaser (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Doe"]},"street":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street of purchaser (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["French"]},"houseNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street number (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["123"]},"city":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town (village) (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Praha 2"]},"district":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"county (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Praha 2"]},"additional":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional address information (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["4. floor"]},"zip":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP or postal code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["120 00"]},"countryCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-character ISO 3166-1 alpha-2 country code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ"]},"regionName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region name (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Capital city"]},"regionShortcut":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region abbreviation (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CC"]}}}},"components/schemas/billingAddress":{"id":"components/schemas/billingAddress","kind":"json-schema","title":"billingAddress","data":{"type":"object","additionalProperties":false,"required":["company","fullName","street","houseNumber","city","district","additional","zip","countryCode","regionName","regionShortcut","companyId","taxId","vatId"],"properties":{"company":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of purchaser''s company (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Shoptet s.r.o."]},"fullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of purchaser (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Doe"]},"street":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street of purchaser (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["French"]},"houseNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street number (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["123"]},"city":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town (village) (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Praha 2"]},"district":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"county (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Praha 2"]},"additional":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional address information (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["4. floor"]},"zip":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP or postal code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["120 00"]},"countryCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-character ISO 3166-1 alpha-2 country code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ"]},"regionName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region name (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Capital city"]},"regionShortcut":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region abbreviation (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CC"]},"companyId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company registration number. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["12345678"]},"vatId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT identification number. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ289324675"]},"vatIdValidationStatus":{"enum":["unverified","verified","waiting",null],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Info, whether VAT ID has been verified, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unverified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}],"examples":["verified"]},"taxId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX identification number. For Czech address, taxId is same as vatId. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ289324675"]}}}},"components/schemas/billingAddressCustomer":{"id":"components/schemas/billingAddressCustomer","kind":"json-schema","title":"billingAddressCustomer","data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"company":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard shop"]},"fullName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Lard"]},"street":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard street"]},"houseNumber":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"house number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["123"]},"city":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard city"]},"district":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Prague-East"]},"additional":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional address information (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["4. floor"]},"zip":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP or postal code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["120 00"]},"countryCode":{"type":"string","minLength":1,"description":"two-character ISO 3166-1 alpha-2 country code","examples":["CZ"]},"regionName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Capital city"]},"companyId":{"type":["string","null"],"minLength":1,"maxLength":18,"description":"Company registration number of the customer, if purchasing as a company. Optional.","examples":["12345678"]},"vatId":{"type":["string","null"],"minLength":1,"maxLength":16,"description":"VAT identification number of the customer, if purchasing as a company. Optional.","examples":["CZ123456"]},"taxId":{"type":["string","null"],"minLength":1,"maxLength":16,"description":"TAX identification number of the customer, if purchasing on the company. For Czech address, taxId must be the same as vatId, or left empty. Optional.","examples":["CZ123456"]}}}},"components/schemas/deliveryAddressCustomer":{"id":"components/schemas/deliveryAddressCustomer","kind":"json-schema","title":"deliveryAddressCustomer","data":{"type":"object","additionalProperties":false,"required":["guid","company","fullName","street","houseNumber","city","district","additional","zip","countryCode","regionName","regionShortcut"],"properties":{"guid":{"type":"string","description":"customer delivery address identification","examples":["c9e976a5-340b-11e4-b500-ac162d8a2454"]},"company":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard shop"]},"fullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Lard"]},"street":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard street"]},"houseNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"house number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["5647"]},"city":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Čelákovice"]},"district":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Prague-East"]},"additional":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional info (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Arcade"]},"zip":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP/postal code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["25088"]},"countryCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-character ISO 3166-1 alpha-2 country code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ"]},"regionName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Central Bohemia"]},"regionShortcut":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region abbreviation (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["StK"]},"isDefault":{"type":"boolean","examples":[true]}}}},"components/schemas/documentItemsWithPrice":{"id":"components/schemas/documentItemsWithPrice","kind":"json-schema","title":"documentItemsWithPrice","data":{"type":"object","additionalProperties":false,"required":["productGuid","code","itemType","name","variantName","brand","amount","amountUnit","remark","priceRatio","weight","additionalField","itemPrice","unitPrice","purchasePrice","itemId"],"properties":{"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"global unique permanent product identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"code":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variant code (product) (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["159"]},"itemType":{"type":"string","description":"item type","examples":["product"]},"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Flying carpet"]},"variantName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variant name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Red Flying carpet"]},"brand":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Flying carpets Inc."]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"quantity"},"amountUnit":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unit of quantity (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["pcs"]},"remark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["This is a remark"]},"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount - 0.7800 = discount 22%; 1.0000 = no discount"},"children":[]}]}]}]},"weight":{"oneOf":[{"$ref":"#/components/schemas/typeWeight"},{"type":"null"}]},"additionalField":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional info (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["additional info"]},"itemPrice":{"$ref":"#/components/schemas/itemPrice","description":"item price"},"unitPrice":{"$ref":"#/components/schemas/itemPrice","description":"unit price"},"purchasePrice":{"oneOf":[{"$ref":"#/components/schemas/itemPrice"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase price of the part, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"displayPrices":{"type":"array","description":"in some cases, one item is displayed as multiple lines in the administration or a printout. This array contains one or more rows representing the printout version of the item.","items":{"$ref":"#/components/schemas/itemPrice"}},"itemId":{"type":"integer","description":"item identifier for manipulation with this item","examples":[123]},"surchargeParameters":{"$ref":"#/components/schemas/itemSurchargeParameters"},"specificSurchargeParameters":{"$ref":"#/components/schemas/itemSpecificSurchargeParameters"},"itemPriceVatBreakdown":{"type":["array","null"],"description":"Detailed VAT list displaying tax amounts for each VAT rate used in the document. Applied for non product items.","items":{"$ref":"#/components/schemas/itemPrice"}}}}},"components/schemas/inStoreAddress":{"id":"components/schemas/inStoreAddress","kind":"json-schema","title":"inStoreAddress","data":{"type":"object","additionalProperties":false,"required":["id","countryCode","city","zipCode","street"],"properties":{"id":{"type":"integer","description":"in-store address unique ID","examples":[1]},"countryCode":{"type":"string","description":"two-character ISO 3166-1 alpha-2 country code","examples":["CZ"]},"city":{"type":"string","description":"city","examples":["Prague"]},"zipCode":{"type":"string","description":"ZIP code","examples":["11000"]},"street":{"type":"string","description":"street","examples":["Main street 123"]}}}},"components/schemas/inStoreContact":{"id":"components/schemas/inStoreContact","kind":"json-schema","title":"inStoreContact","data":{"type":"object","additionalProperties":false,"required":["email","phone","openingHour","transport"],"properties":{"email":{"type":["string","null"],"description":"in-store contact email","examples":["jan.novak@shoptet.cz"]},"phone":{"type":["string","null"],"description":"in-store contact phone","examples":["+420123456789"]},"openingHour":{"type":["string","null"],"description":"in-store opening hours","examples":["Mon-Fri 9:00-18:00"]},"transport":{"type":["string","null"],"description":"in-store transport information","examples":["Near the central station"]}}}},"components/schemas/invoiceItem":{"id":"components/schemas/invoiceItem","kind":"json-schema","title":"invoiceItem","data":{"type":"object","additionalProperties":false,"required":["productGuid","itemId","code","itemType","name","variantName","brand","amount","amountUnit","remark","priceRatio","weight","additionalField","itemPrice","unitPrice","purchasePrice","consumptionTax"],"properties":{"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"global unique permanent product identifier."},"itemId":{"type":"integer","description":"item identifier for manipulation with this item","examples":[123]},"code":{"type":["string","null"],"description":"variant code (product)","examples":["159"]},"itemType":{"type":"string","description":"item type","examples":["product"]},"name":{"type":["string","null"],"description":"product name","examples":["Flying carpet"]},"variantName":{"type":["string","null"],"description":"variant name","examples":["Red Flying carpet"]},"brand":{"type":["string","null"],"description":"brand (or manufacturer, possibly)","examples":["Flying carpets Inc."]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"quantity","examples":["3.45"]},"amountUnit":{"type":["string","null"],"description":"unit of quantity","examples":["ks"]},"remark":{"type":["string","null"],"description":"remark","examples":["This is a remark"]},"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount - 0.7800 = discount 22%; 1.0000 = no discount"},"children":[]}]}]}]},"weight":{"oneOf":[{"$ref":"#/components/schemas/typeWeight"},{"type":"null"}]},"additionalField":{"type":["string","null"],"description":"additional info","examples":["additional info"]},"itemPrice":{"$ref":"#/components/schemas/itemPrice","description":"item price"},"unitPrice":{"$ref":"#/components/schemas/itemPrice","description":"unit price"},"purchasePrice":{"oneOf":[{"$ref":"#/components/schemas/itemPrice"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase price of the part, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"displayPrices":{"type":"array","description":"in some cases, one item is displayed as multiple lines in the administration or a printout. This array contains one or more rows representing the printout version of the item.","items":{"$ref":"#/components/schemas/itemPrice"}},"recyclingFee":{"$ref":"#/components/schemas/recyclingFee","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recycling fee including category and price (or possibly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"surchargeParameters":{"$ref":"#/components/schemas/itemSurchargeParameters","description":"items surcharge parameters, filled in item creation. Cannot be edited."},"specificSurchargeParameters":{"$ref":"#/components/schemas/itemSpecificSurchargeParameters","description":"List of specific surcharge parameters for item detail."},"consumptionTax":{"$ref":"#/components/schemas/documentConsumptionTax","description":"consumption tax of invoice item"},"itemPriceVatBreakdown":{"type":["array","null"],"description":"Detailed VAT list displaying tax amounts for each VAT rate used in the invoice. Applied for non product items.","items":{"$ref":"#/components/schemas/itemPrice"}}}}},"components/schemas/documentConsumptionTax":{"id":"components/schemas/documentConsumptionTax","kind":"json-schema","title":"documentConsumptionTax","data":{"type":["object","null"],"additionalProperties":false,"required":["currency","price"],"properties":{"currency":{"$ref":"#/components/schemas/typeCurrencyCode"},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"consumption tax value"}}}},"components/schemas/consumptionTaxId":{"id":"components/schemas/consumptionTaxId","kind":"json-schema","title":"consumptionTaxId","data":{"type":["integer","null"],"description":"ID of the consumption tax. You can send this parameter, only if consumption tax module is enabled.","examples":[1]}},"components/schemas/deliveryNoteItem":{"id":"components/schemas/deliveryNoteItem","kind":"json-schema","title":"deliveryNoteItem","data":{"type":"object","additionalProperties":false,"required":["productGuid","itemType","name","variantName","brand","amount","amountUnit","remark","code"],"properties":{"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"global unique permanent product identifier"},"itemType":{"type":"string","description":"item type","examples":["product"]},"name":{"type":["string","null"],"description":"product name","examples":["Flying carpet"]},"variantName":{"type":["string","null"],"description":"variant name","examples":["Red Flying carpet"]},"brand":{"type":["string","null"],"description":"brand (or manufacturer, possibly)","examples":["Flying carpets Inc."]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"quantity"},"amountUnit":{"type":["string","null"],"description":"unit of quantity","examples":["ks"]},"remark":{"type":["string","null"],"description":"remark","examples":["This is a remark"]},"weight":{"oneOf":[{"$ref":"#/components/schemas/typeWeight"},{"type":"null"}]},"code":{"type":["string","null"],"description":"variant code (product)","examples":["159"]},"surchargeParameters":{"$ref":"#/components/schemas/itemSurchargeParametersWithoutPrice"},"specificSurchargeParameters":{"$ref":"#/components/schemas/itemSpecificSurchargeParametersWithoutPrice"}}}},"components/schemas/eshop":{"id":"components/schemas/eshop","kind":"json-schema","title":"eshop","data":{"type":"object","additionalProperties":false,"required":["bankAccount","iban","bic","vatPayer"],"properties":{"bankAccount":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop bank account (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["123456789/1234"]},"iban":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop IBAN (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ6508000000192000145399"]},"bic":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank code - SWIFT (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CNBACZPPXXX"]},"vatPayer":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT payer (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[true]}}}},"components/schemas/documentCustomer":{"id":"components/schemas/documentCustomer","kind":"json-schema","title":"documentCustomer","data":{"type":"object","additionalProperties":false,"required":["guid","phone","email","remark"],"properties":{"guid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"phone":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer phone (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["603481066"]},"email":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer e-mail (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["example@example.com"]},"remark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark for the customer (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["This is a remark"]}}}},"components/schemas/actionPrice":{"id":"components/schemas/actionPrice","kind":"json-schema","title":"actionPrice","data":{"type":["object","null"],"additionalProperties":false,"description":"special discounted price.","required":["price","fromDate","toDate"],"properties":{"price":{"$ref":"#/components/schemas/typePrice","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"special discounted price. It is only used if set and if the validity date is set too, form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["189.00"]},"fromDate":{"$ref":"#/components/schemas/typeDateNullable","description":"date from which the special discounted price is valid."},"toDate":{"$ref":"#/components/schemas/typeDateNullable","description":"date to which the special discounted price is valid."}}}},"components/schemas/pricelist":{"id":"components/schemas/pricelist","kind":"json-schema","title":"pricelist","data":{"type":"object","additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"integer","description":"price list identifier","examples":[1]},"name":{"type":"string","description":"price list name","examples":["Hlavní ceník"]}}}},"components/schemas/variantPrice":{"id":"components/schemas/variantPrice","kind":"json-schema","title":"variantPrice","data":{"type":"object","additionalProperties":false,"required":["price","commonPrice","buyPrice","priceRatio","actionPrice"],"properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":"Price, at which the customer can purchase the product. It can be loaded by the special discounted price and influenced by the price ratio.","examples":["650.00"]},"commonPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"standard price, use for information and comparison to competitors.","examples":["750.00"]},"buyPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"purchase price.","examples":["500.00"]},"priceRatio":{"$ref":"#/components/schemas/typeProductPriceRatio"},"actionPrice":{"$ref":"#/components/schemas/actionPrice"}}}},"components/schemas/productOrderableAmount":{"id":"components/schemas/productOrderableAmount","kind":"json-schema","title":"productOrderableAmount","data":{"type":"object","additionalProperties":false,"required":["minimumAmount","maximumAmount"],"properties":{"minimumAmount":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"minimum orderable quantity.","examples":[2]},"maximumAmount":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"maximum orderable quantity.","examples":[9]}}}},"components/schemas/priceSales":{"id":"components/schemas/priceSales","kind":"json-schema","title":"priceSales","data":{"type":"object","additionalProperties":false,"required":["minPriceRatio","freeShipping","freeBilling","loyaltyDiscount","volumeDiscount","quantityDiscount","discountCoupon"],"properties":{"minPriceRatio":{"$ref":"#/components/schemas/typeProductPriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 decimal places accuracy, (from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), maximum permitted discount."},"children":[]}]}]}],"examples":[0.78]},"freeShipping":{"type":"boolean","description":"flag, whether the product will have a free transport after it is placed in the cart.","examples":[true]},"freeBilling":{"type":"boolean","description":"flag, whether the product will have a free payment after it is placed in the cart.","examples":[true]},"loyaltyDiscount":{"type":"boolean","description":"flag, whether the loyalty discount should be used.","examples":[true]},"volumeDiscount":{"type":"boolean","description":"flag, whether the volume discount should be used.","examples":[true]},"quantityDiscount":{"type":"boolean","description":"flag, whether the volume/multibuy discount should be used.","examples":[true]},"discountCoupon":{"type":"boolean","description":"flag, whether a discount coupon can be applied.","examples":[true]}}}},"components/schemas/productVariantParameterValues":{"id":"components/schemas/productVariantParameterValues","kind":"json-schema","title":"productVariantParameterValues","data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["paramValue"],"properties":{"paramValue":{"type":"string","minLength":1,"maxLength":128,"description":"Name of parameter value. Maximal length of 255 characters.","examples":["Red"]},"rawValue":{"type":["string","null"],"minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter value. Maximal length of 255 characters.","examples":["red"]},"color":{"$ref":"#/components/schemas/typeColor","description":"Color hex code. Minimal length of 1 character. Maximal length of 8 characters.","examples":["FF00FF00"]},"image":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Image name. Image needs to exist in your file folder.","examples":["car-001.jpg"]},"valuePriority":{"type":["integer","null"],"minimum":1,"description":"Parameter value priority.","examples":[1]}}}}},"components/schemas/productFilteringParameterValues":{"id":"components/schemas/productFilteringParameterValues","kind":"json-schema","title":"productFilteringParameterValues","data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"Name of parameter value.","examples":["Bavlna"]},"valueIndex":{"type":["string","null"],"minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter value.","examples":["bavlna"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Parameter value priority.","examples":[1]},"color":{"$ref":"#/components/schemas/typeColor","description":"Color hex code."},"image":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Image name. Image needs to exist in your file folder.","examples":["car-001.jpg"]}}}}},"components/schemas/product":{"id":"components/schemas/product","kind":"json-schema","title":"product","data":{"type":"object","additionalProperties":false,"required":["guid","type","brand","visibility","creationTime","changeTime","shortDescription","description","metaDescription","url","defaultCategory","variants","supplier","internalNote","hsCode"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"unique product indicator"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["product"]},"name":{"type":["string","null"],"description":"product name","examples":["Pelle 1978"]},"indexName":{"type":"string","description":"String which defines product url.","examples":["baleriny-modre-s-puntiky"]},"brand":{"oneOf":[{"$ref":"#/components/schemas/brandNamed"},{"type":"null"}],"description":"product brand (or manufacturer, possibly)"},"supplier":{"oneOf":[{"$ref":"#/components/schemas/supplier"},{"type":"null"}],"description":"product supplier"},"visibility":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visibility of product ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"normal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["normal"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of product creation (date in ISO 8601 format)"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of last product change (date in ISO 8601 format)"},"shortDescription":{"type":["string","null"],"description":"short product description","examples":["A high quality jacket, although its fairly bold design is not to everyone's taste, it has its fans, so you can find it in our offer too. For kids, why not."]},"description":{"type":["string","null"],"description":"product description. May contain html.","examples":["

As it is often the case with jackets for kids, the emphasis is primarily on durability and quality workmanship. It is clear that it will be put through its paces, which the manufacturer has borne in mind. As previously stated, the manufacturer could also afford a less conservative design for a kids product, combining bold colors with a company logo on the front and back.

\n\n
    \n\t
  • Body - 60% Nylon, 40% wool
    • \n
  • Inside - 100% Polyester
    • \n
"]},"metaDescription":{"type":["string","null"],"description":"product label from meta tag.","examples":["Pelle 1978. A high quality jacket, although its fairly bold design is not to everyone's taste .... "]},"url":{"type":["string","null"],"description":"URL of the product in the e-shop","examples":["https://www.domena-eshopu.cz/hodinky/citizen-chronograph-eco-drive/"]},"conditionGrade":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grade condition of second-hand product. It contains value only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type, otherwise, it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["used"]},"conditionDescription":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition description of second-hand product. It contains value only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type, otherwise, it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["Without original package"]},"internalNote":{"type":["string","null"],"description":"product internal note","examples":["This product is not in stock, but it is possible to order it."]},"preauthorizationRequired":{"type":"boolean","description":"whether the preauthorization is required; available only if shoptet pay module is enabled","examples":[true]},"hsCode":{"$ref":"#/components/schemas/typeHsCodeNullable"},"defaultCategory":{"type":"object","additionalProperties":false,"description":"default product category","required":["guid","name","visible"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category unique identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"name":{"type":["string","null"],"description":"category description","examples":["Watches"]},"visible":{"type":["boolean","null"],"description":"whether the parameter is visible","examples":[true]}}},"categories":{"type":"array","description":"information about available product categories","items":{"type":"object","additionalProperties":false,"required":["guid","name","parentGuid"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category unique identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"name":{"type":"string","description":"category name","examples":["Watches"]},"parentGuid":{"$ref":"#/components/schemas/typeGuidNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parent category unique identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["c9e976a5-340b-11e4-b500-ac162d8a2454"]}}}},"descriptiveParameters":{"type":"array","description":"product description parameters","items":{"type":"object","additionalProperties":false,"required":["name","value","description","priority"],"properties":{"name":{"type":"string","description":"parameter name","examples":["Material"]},"value":{"type":["string","null"],"description":"value of the descriptive parameter","examples":["flannel"]},"description":{"type":["string","null"],"description":"parameter name description","examples":["Material of the product"]},"priority":{"type":["integer","null"],"description":"parameter priority","examples":[1]}}}},"additionalName":{"type":["string","null"],"description":"Additional part of product name","examples":["+ free gift"]},"xmlFeedName":{"type":["string","null"],"description":"Name of xml feed","examples":["our-feed.xml"]},"metaTitle":{"type":"string","description":"Meta (seo) title","examples":["Nice product title"]},"adult":{"type":"boolean","description":"Flag, whether the product is for adults only","examples":[true]},"atypicalBilling":{"type":"boolean","description":"(Moved to variant) - Has atypical billing?","deprecated":true},"atypicalShipping":{"type":"boolean","description":"(Moved to variant) - Has atypical shipping?","examples":[true],"deprecated":true},"allowIPlatba":{"type":"boolean","description":"Is Cofidis payment allowed?","examples":[true]},"allowOnlinePayments":{"type":"boolean","description":"Are online Payments allowed?","examples":[true]},"sizeIdName":{"type":["string","null"],"description":"Name for sizeid.com","examples":["adidas - man - shoes (ID 142)"]},"voteAverageScore":{"$ref":"#/components/schemas/typeAmountNullable","description":"Average score of product reviews","examples":[2.6]},"voteCount":{"type":["integer","null"],"description":"Count of product reviews","examples":[16]},"isVariant":{"type":"boolean","description":"define if product has multiple variants.","examples":[true]},"variants":{"type":"array","description":"information about available product variants. For a product without variants, this field contains just one element with product details.","items":{"type":"object","additionalProperties":false,"required":["code","ean","stock","unit","weight","width","height","depth","visible","price","commonPrice","includingVat","vatRate","currencyCode","minStockSupply","actionPrice","manufacturerCode","pluCode","isbn","serialNo","mpn","negativeStockAllowed","amountDecimalPlaces"],"properties":{"code":{"type":"string","description":"unique identification of the product variant","examples":["0035"]},"ean":{"type":["string","null"],"description":"product variant bar code","examples":["4010355051486"]},"stock":{"$ref":"#/components/schemas/typeAmountNullable","description":"quantity of goods in stock","examples":["1.000"]},"unit":{"type":["string","null"],"description":"unit of goods quantity","examples":["ks"]},"weight":{"oneOf":[{"$ref":"#/components/schemas/typeWeight"},{"type":"null"}],"description":"weight in kg","examples":["0.500"]},"width":{"$ref":"#/components/schemas/typeDimension","description":"width of the product in cm"},"height":{"$ref":"#/components/schemas/typeDimension","description":"height of the product in cm"},"depth":{"$ref":"#/components/schemas/typeDimension","description":"depth of the product in cm"},"visible":{"type":"boolean","description":"flag, whether the variant is visible","examples":[true]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"price","examples":["650.00"]},"commonPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"standard price","examples":["750.00"]},"manufacturerCode":{"type":["string","null"],"description":"manufacturer code","examples":["OKI"]},"pluCode":{"type":["string","null"],"description":"PLU code","examples":["0828"]},"isbn":{"type":["string","null"],"description":"ISBN code","examples":["978-80-251-0000-0"]},"serialNo":{"type":["string","null"],"description":"serial number","examples":["123456"]},"mpn":{"type":["string","null"],"description":"manufacturer part number","examples":["H2G2-42"]},"includingVat":{"type":"boolean","description":"flag, whether the price is including VAT","examples":[true]},"vatRate":{"type":"string","description":"VAT rate in percent","examples":["21.00"]},"currencyCode":{"type":"string","description":"currency code","examples":["CZK"]},"minStockSupply":{"$ref":"#/components/schemas/typeAmountNullable","description":"minimum stock supply","examples":["10.000"]},"actionPrice":{"$ref":"#/components/schemas/actionPrice","description":"special discounted price"},"image":{"type":["string","null"],"description":"main image of variant (if set, otherwise the product's main image is to be used).","examples":["1.png"]},"isProductDefaultImage":{"type":"boolean","description":"Determines whether the default product image is given (true) or the product variant image (false).","examples":[true]},"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name composed of the variant parameters, as seen in the e-shop. For products without variants this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=variantParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"examples":["Color: Red, size: 50 cm, shape: Square"]},"amountDecimalPlaces":{"type":"integer","description":"Number of decimal places for amount","examples":[0]},"parameters":{"type":["array","null"],"items":{"type":"object","additionalProperties":false,"required":["paramName","paramIndex","paramValue","rawValue","color","image","valuePriority"],"properties":{"paramName":{"type":["string","null"],"description":"human readable name of the variant parameter.","examples":["Color"]},"paramIndex":{"type":"string","description":"name of the variant parameter without diacritics and spaces","examples":["color"]},"paramValue":{"type":"string","description":"human readable value of the variant parameter","examples":["Red"]},"displayName":{"type":["string","null"],"description":"Parameter display name","examples":["Barva"]},"rawValue":{"type":["string","null"],"description":"value of the parameter without variant, without diacritics and spaces.","examples":["red"]},"color":{"type":["string","null"],"description":"parameter value as color hexadecimal code.","examples":["fffeee"]},"image":{"type":["string","null"],"description":"URL of the image that serves as the parameter value.","examples":["image.jpg"]},"valuePriority":{"type":"integer","description":"priority of the parameter value.","examples":[1]}}}},"measureUnit":{"type":["object","null"],"additionalProperties":false,"description":"product measure unit","required":["packagingAmount","packagingUnitId","packagingUnitName","measureAmount","measureUnitId","measureUnitName","measurePrice"],"properties":{"packagingUnitId":{"type":["integer","null"],"description":"packaging unit identifier","examples":[22]},"packagingUnitName":{"type":["string","null"],"description":"packaging unit name","examples":["g"]},"packagingAmount":{"$ref":"#/components/schemas/typeAmountNullable","description":"amount being in a package","examples":["64"]},"measureUnitId":{"type":["integer","null"],"description":"measure unit identifier","examples":[-22]},"measureUnitName":{"type":["string","null"],"description":"measure unit name","examples":["kg"]},"measureAmount":{"$ref":"#/components/schemas/typeAmountNullable","description":"referential amount","examples":["1"]},"measurePrice":{"$ref":"#/components/schemas/typePriceNullable","description":"price of package for referential amount","examples":["3937.5"]}}},"availability":{"$ref":"#/components/schemas/availabilityShort","description":"product availability"},"availabilityWhenSoldOut":{"$ref":"#/components/schemas/availabilityShort","description":"product availability when not stocked"},"negativeStockAllowed":{"type":"string","enum":["yes-global","no-global","yes"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is negative stock buying allowed? Possible values "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yes-global"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - yes, set globally, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no-global"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - no, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - globally no, but per this variant yes."},"children":[]}]}]}],"examples":["yes-global"]},"recyclingFee":{"oneOf":[{"$ref":"#/components/schemas/recyclingFeeCategory"},{"type":"null"}],"description":"recycling fee including category and fee"},"consumptionTax":{"oneOf":[{"$ref":"#/components/schemas/productConsumptionTax"},{"type":"null"}],"description":"consumption tax"},"heurekaCPC":{"type":["string","null"],"description":"Heureka cost per click","examples":["0.0"]},"zboziCZ":{"type":"object","additionalProperties":false,"description":"Information from zbozi.cz","required":["maximalCPC","maximalSearchCPC","hidden"],"properties":{"maximalCPC":{"type":["string","null"],"description":"Zbozi.cz maximal cost per click","examples":["0.0"]},"maximalSearchCPC":{"type":["string","null"],"description":"Zbozi.cz maximal search cost per click","examples":["0.0"]},"hidden":{"type":["boolean","null"],"examples":[true]}}},"atypicalBilling":{"type":"boolean","description":"Has atypical billing?","examples":[true]},"atypicalShipping":{"type":"boolean","description":"Has atypical shipping?","examples":[true]},"boxRestriction":{"type":"boolean","description":"When enabled, pickup lockers cannot be selected in the cart.","examples":[true]},"perStockAmounts":{"type":["array","null"],"description":"Variant amounts/claims per individual stocks.","items":{"type":"object","additionalProperties":false,"required":["stockId","amount","claim","location","lastAmountUpdate"],"properties":{"stockId":{"type":"integer","description":"stock unique ID","examples":[1]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"amount of items, products","examples":["50.000"]},"claim":{"$ref":"#/components/schemas/typeAmountNullable","description":"requirements on stock quantity","examples":["5.000"]},"location":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stock position, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["Location 4"]},"lastAmountUpdate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time of last change of stock quantity (ISO 8601 format), can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["2024-01-04T10:55:55+0100"]}}}},"perPricelistPrices":{"type":["array","null"],"description":"Variant prices per individual pricelists.","items":{"type":"object","additionalProperties":false,"required":["code","currencyCode","includingVat","vatRate","price","sales","orderableAmount","pricelistId"],"properties":{"code":{"type":"string","description":"identifier of product variant","examples":["0008"]},"currencyCode":{"$ref":"#/components/schemas/typeCurrencyCode","examples":["EUR"]},"includingVat":{"type":"boolean","description":"flag, if price is including VAT","examples":[true]},"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":"VAT rate","examples":[21]},"price":{"$ref":"#/components/schemas/variantPrice"},"sales":{"$ref":"#/components/schemas/priceSales"},"orderableAmount":{"$ref":"#/components/schemas/productOrderableAmount"},"pricelistId":{"type":"integer","description":"price list identifier","examples":[1]},"prices":{"$ref":"#/components/schemas/productPrices"}}}},"url":{"type":["string","null"],"description":"If product has multiple variants, URL of the variant is provided.","examples":["https://www.domena-eshopu.cz/category/?variantId=51238"]},"prices":{"$ref":"#/components/schemas/productPrices"},"ossVatLevels":{"type":"array","description":"OSS VAT levels","items":{"type":"object","additionalProperties":false,"required":["countryCode","taxLevel","taxLevelDescription","taxValue"],"properties":{"countryCode":{"type":["string"],"description":"Country code","examples":["CZ"]},"taxLevel":{"enum":["high","low","third","none","superLow","parking"],"description":"Tax level type. Use Enums: high: Standard tax rate, none: Zero tax rate, low: First reduced tax rate, third: Second reduced tax rate, superLow: Super low tax rate, parking: Parking tax rate.","examples":["high"]},"taxLevelDescription":{"type":"string","description":"Description of tax level type","examples":["Standard tax rate"]},"taxValue":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax value in %"},"children":[]}]}]}],"examples":["21.00"]}}}}}}},"images":{"type":"array","description":"information about images.","items":{"type":"object","additionalProperties":false,"required":["name","seoName","cdnName","signedCdnNames","priority","description","changeTime","gallery"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image file name, also serves as an identifier for the image of the product. To assemble complete URL, it is added to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" obtained from the endpoint e-shop info "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["100.jpg"]},"seoName":{"type":"string","description":"file name modified for SEO - a short label is attached.","examples":["100_purple-apple.jpg"]},"cdnName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seoName with signed CDN query parameters for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"big"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cut. Combine with the cut's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form the full URL. Old-format URLs (bare hash) remain valid on the CDN."},"children":[]}]}]}],"examples":["100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"]},"signedCdnNames":{"type":["array","null"],"items":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string"},"name":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-cut signed CDN filenames. Combine each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value with the matching cut's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form a correctly-signed URL. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when cut configuration is temporarily unavailable."},"children":[]}]}]}],"examples":[[{"type":"big","name":"100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"},{"type":"thumbnail","name":"100_purple-apple.jpg?ff=1&x=300&y=300&q=85&ts=59393c3a&sg=ab12cd34"}]]},"priority":{"type":["integer","null"],"description":"the key for the sequence of images matching the sequence in administration - it's not necessarily from the first, and the series may contain gaps.","examples":[1]},"description":{"type":["string","null"],"description":"image label","examples":["Fresh purple apple for Snow White"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"last image change time If you are saving images together, you can use this timestamp to indicate if you need to reload the image."},"isMainImage":{"type":"boolean","description":"determines whether it is the main image"},"gallery":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of the gallery the image belongs to (e.g. \"shop\" for the standard product gallery, \"shop360\" for the 360° gallery); matches the gallery segment in the image URL."},"children":[]}]}]}],"examples":["shop"]}}}},"flags":{"type":"array","description":"product flags","items":{"type":"object","additionalProperties":false,"required":["code","title","dateFrom","dateTo"],"properties":{"code":{"type":"string","description":"flag identifier","examples":["action"]},"title":{"type":"string","description":"flag name","examples":["Action"]},"dateFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"date from which the flag is valid"},"dateTo":{"$ref":"#/components/schemas/typeDateNullable","description":"date to which the flag is valid"}}}},"surchargeParameters":{"type":"array","description":"product surcharge parameters","items":{"$ref":"#/components/schemas/productSurchargeParameter"}},"setItems":{"type":["array","null"],"description":"information about items, products, in set","items":{"type":"object","additionalProperties":false,"required":["guid","code","amount"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"global unique permanent category identifier"},"code":{"type":"string","minLength":1,"description":"product code","examples":["154"]},"amount":{"$ref":"#/components/schemas/typePositiveAmount","description":"amount of items, products","examples":[1]}}}},"filteringParameters":{"type":"array","description":"product filtering parameters","items":{"type":"object","additionalProperties":false,"required":["code","name","displayName","description","priority","googleMapping","values"],"properties":{"code":{"type":"string","description":"parameter code","examples":["material"]},"name":{"type":"string","description":"parameter name","examples":["Material"]},"displayName":{"type":["string","null"],"description":"parameter display name","examples":["Material of product"]},"description":{"type":["string","null"],"description":"parameter description","examples":["Material of the product"]},"priority":{"type":["integer","null"],"description":"parameter priority","examples":[1]},"googleMapping":{"$ref":"#/components/schemas/googleMappingType","description":"Possible parameter mapping with google"},"values":{"type":"array","description":"possible parameter's values","items":{"type":"object","additionalProperties":false,"required":["valueIndex","name","priority","color","image"],"properties":{"valueIndex":{"type":["string","null"],"description":"Code (identifier) of parameter's value","examples":["ag"]},"name":{"type":"string","description":"Description (name) of parameter's value","examples":["Gold"]},"priority":{"type":["integer","null"],"description":"Priority of parameter's value","examples":[1]},"color":{"type":["string","null"],"description":"Hex code of color","examples":["#34ff34"]},"image":{"type":["string","null"],"description":"URL of image","examples":["https://www.domena-eshopu.cz/user/parameters/100.jpg"]}}}}}}},"warranty":{"type":["object","null"],"additionalProperties":false,"description":"product warranty","required":["id","inMonths","description"],"properties":{"id":{"type":"integer","description":"Warranty id. Negative number indicates system warranties. Positive numbers are defined by customer.","examples":[-1]},"inMonths":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warranty length in months. Negative number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") means infinite (lifetime) warranty."},"children":[]}]}]}],"examples":[24]},"description":{"type":"string","description":"Warranty description","examples":["2 years"]}}},"gifts":{"$ref":"#/components/schemas/productGifts","description":"Gifts related to product"},"alternativeProducts":{"type":["array","null"],"items":{"$ref":"#/components/schemas/relatedProduct"}},"relatedProducts":{"type":["array","null"],"items":{"$ref":"#/components/schemas/relatedProduct"}},"relatedFiles":{"type":"array","description":"files related to product","items":{"type":"object","additionalProperties":false,"required":["id","name","url","size"],"properties":{"id":{"type":"integer","description":"Related file id","examples":[426]},"name":{"type":["string","null"],"description":"related file title","examples":["Example file"]},"url":{"type":"string","description":"related file URL","examples":["https://www.domena-eshopu.cz/user/related_files/example-file.txt"]},"size":{"type":["integer","null"],"description":"related file size","examples":[1024]}}}},"relatedVideos":{"type":"array","description":"Videos related to product","items":{"type":"object","additionalProperties":false,"required":["code","title","type"],"properties":{"code":{"type":"string","maxLength":32,"description":"urelated video YouTube code","examples":["zpvmPA3me7o"]},"title":{"type":["string","null"],"maxLength":128,"description":"related video title","examples":["How to use the product"]},"type":{"type":["string","null"],"enum":["youtube","youtube-short",null],"description":"related video type","examples":["youtube-short"]}}}}}}},"components/schemas/productBatchDelete":{"id":"components/schemas/productBatchDelete","kind":"json-schema","title":"productBatchDelete","data":{"type":"object","additionalProperties":false,"properties":{"guid":{"$ref":"#/components/schemas/typeGuid"},"code":{"type":"string","minLength":1,"maxLength":255}}}},"components/schemas/productUpdate":{"id":"components/schemas/productUpdate","kind":"json-schema","title":"productUpdate","data":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Product GUID. Must be unique if set."},"type":{"type":"string","enum":["product","bazar","service","product-set"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product type. Please note that 'product-set' requires 'sets' module to be enabled. Enum - see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["product","bazar","service","product-set"]},"visibility":{"type":"string","enum":["hidden","visible","blocked","show-registered","block-unregistered","cash-desk-only","detail-only"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility. Optional, default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Enum - see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["hidden"]},"name":{"type":"string","minLength":1,"maxLength":250,"description":"Product's name. Mandatory. Maximal length of 250 characters.","examples":["Velká čokoláda"]},"adult":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the product is for adults only. Optional, default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"shortDescription":{"type":["string","null"],"description":"Product's short description.","examples":["Velice kvalitní a dobrá čokoláda."]},"description":{"type":["string","null"],"description":"Product's full description.","examples":["

Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. Neobsahuje arašídy.

"]},"additionalName":{"type":["string","null"],"maxLength":150,"description":"Product's additional name. Optional. Maximal length of 150 characters.","examples":["Velice kvalitní a dobrá čokoláda."]},"metaTitle":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Product's seo title. Maximal length of 255 characters.","examples":["Velice kvalitní a dobrá čokoláda."]},"metaDescription":{"type":["string","null"],"description":"Product's full description.","examples":["Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. Neobsahuje arašídy."]},"conditionGrade":{"type":["string","null"],"minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grade condition of second-hand product. Allowed only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"examples":["used"]},"conditionDescription":{"type":["string","null"],"minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition description of second-hand product. Allowed only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"examples":["Without original package."]},"defaultCategoryGuid":{"$ref":"#/components/schemas/typeGuid","description":"Product's default category's GUID. Mandatory."},"brandCode":{"type":["string","null"],"minLength":1,"description":"Product's brand indexName/code. Must exist if set.","examples":["milka"]},"internalNote":{"type":["string","null"],"minLength":1,"description":"Product internal note.","examples":["Internal note for product manager."]},"preauthorizationRequired":{"type":"boolean","description":"whether the preauthorization is required; available only if shoptet pay module is enabled","examples":[true]},"hsCode":{"$ref":"#/components/schemas/typeHsCodeNullable"},"supplierGuid":{"$ref":"#/components/schemas/typeGuidNullable","minLength":1,"description":"Supplier GUID. Must exist if set."},"categoryGuids":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/typeGuid"}},"warrantyId":{"type":["integer","null"],"description":"Warranty ID.","examples":[1]},"flags":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must exist if set. Cannot be set together with the param "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flagsManagement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","description":"flag identifier.","examples":["new"]},"dateFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"Date from which the flag is valid."},"dateTo":{"$ref":"#/components/schemas/typeDateNullable","description":"Date to which the flag is valid."}}}},"flagsManagement":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative way to manage the flags by specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cannot be set together with the param "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minItems":1,"items":{"type":"object","additionalProperties":false,"required":["action","code"],"properties":{"action":{"type":"string","enum":["set","unset"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - adds or updates the flag, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - removes the flag"},"children":[]}]}]}],"examples":["set"]},"code":{"type":"string","description":"flag identifier.","examples":["new"]},"dateFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"Date from which the flag is valid."},"dateTo":{"$ref":"#/components/schemas/typeDateNullable","description":"Date to which the flag is valid."}}}},"descriptiveParameters":{"type":"array","description":"Product descriptive parameters.","items":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Parameter name.","examples":["Material"]},"value":{"type":["string","null"],"description":"value of the descriptive parameter.","examples":["Cotton"]},"description":{"type":["string","null"],"description":"Description of the descriptive parameter.","examples":["Material the shirt is made of"]},"priority":{"type":["integer","null"],"maximum":99999,"description":"Priority of the parameter.","examples":[1]}}}},"filteringParameters":{"type":["array","null"],"items":{"type":"object","additionalProperties":false,"required":["code","values"],"properties":{"code":{"type":"string","minLength":1,"maxLength":255,"description":"Filtering parameter code.","examples":["action"]},"values":{"type":"array","minItems":1,"description":"Product filtering parameter values.","items":{"type":"string"},"examples":[["Action"]]}}}},"surchargeParameters":{"type":"array","description":"Product surcharge parameters. Not allowed for products with multiple tax classes.","items":{"$ref":"#/components/schemas/productRequestSurchargeParameter"}},"variants":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"code":{"$ref":"#/components/schemas/typeVariantCodeRequest"},"newCode":{"type":"string","minLength":1,"maxLength":64,"description":"New code of existing variant.","examples":["0036"]},"ean":{"type":["string","null"],"maxLength":255,"description":"Variant's ean.","examples":["8594001234567"]},"unitId":{"type":"integer","description":"Variant's unit id. Optional","examples":[-1]},"weight":{"$ref":"#/components/schemas/typeWeightRequest","description":"Variant's weight in kilograms. 3 decimal places, and maximum value of 99999.999.","examples":["13.500"]},"width":{"$ref":"#/components/schemas/typeDimension","description":"width of the product in cm. 1 decimal place, maximum 9999.9."},"height":{"$ref":"#/components/schemas/typeDimension","description":"height of the product in cm. 1 decimal place, maximum 9999.9."},"depth":{"$ref":"#/components/schemas/typeDimension","description":"depth of the product in cm. 1 decimal place, maximum 9999.9."},"visible":{"type":"boolean","description":"Is variant visible?","examples":[true]},"manufacturerCode":{"type":["string","null"],"maxLength":32,"description":"Variant's manufacturer code.","examples":["OKI"]},"pluCode":{"type":["string","null"],"maxLength":16,"description":"Variant's plu.","examples":["0828"]},"isbn":{"type":["string","null"],"maxLength":32,"description":"Variant's ISBN.","examples":["978-80-251-0000-0"]},"serialNo":{"type":["string","null"],"maxLength":32,"description":"Variant's serial number.","examples":["B412"]},"mpn":{"type":["string","null"],"maxLength":32,"description":"Variant's MPN.","examples":["H3T5-87"]},"availabilityId":{"type":["integer","null"],"description":"Product availability id","examples":[-1]},"availabilityWhenSoldOutId":{"type":["integer","null"],"description":"Product availability id when not stocked","examples":[-3]},"image":{"type":["string","null"],"description":"image filename of this variant (image must exist within product).","examples":["106.jpg"]},"parameters":{"type":"array","description":"Variant's parameters","items":{"type":"object","additionalProperties":false,"required":["nameIndex","valueIndex"],"properties":{"nameIndex":{"type":"string","description":"indexName of parameter name","examples":["color"]},"valueIndex":{"type":"string","description":"indexName of parameter value","examples":["red"]}}}},"minStockSupply":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"Minimum stock supply.","examples":["10.000"]},"stocksLocations":{"type":"array","description":"Locations and amounts in stocks.","items":{"type":"object","additionalProperties":false,"required":["stockId","location"],"properties":{"stockId":{"type":"integer","description":"Id of stock. Required if stocksLocations is set. Must fit existing stock Id. Check List of Stocks.","examples":[1]},"location":{"type":["string","null"],"maxLength":255,"description":"Stock location.","examples":["H6/M11/R13"]}}}},"negativeStockAllowed":{"type":"boolean","description":"Product stock can be in negative numbers","examples":[true]},"measureUnit":{"$ref":"#/components/schemas/measureUnit","description":"Product variant measure and packaging units."},"recyclingFeeId":{"type":["integer","null"],"description":"Product recycling fee id","examples":[123]},"consumptionTaxId":{"type":["integer","null"],"description":"Product consumption tax identifier","examples":[1]},"amountDecimalPlaces":{"type":"integer","enum":[0,1,2,3],"description":"Amount of product variant decimal places.","examples":[2]},"atypicalBilling":{"type":"boolean","description":"Has atypical billing?","examples":[true]},"atypicalShipping":{"type":"boolean","description":"Has atypical shipping?","examples":[true]},"boxRestriction":{"type":"boolean","description":"When enabled, pickup lockers cannot be selected in the cart.","examples":[true]},"ossVatLevels":{"type":"array","description":"OSS Tax setup. Available in OSS mode only.","items":{"type":"object","additionalProperties":false,"required":["countryCode","taxLevel"],"properties":{"countryCode":{"type":"string","maxLength":2,"description":"Country code","examples":["CZ"]},"taxLevel":{"enum":["high","low","third","none","superLow","parking"],"description":"Tax level type. Use Enums: high: Standard tax rate, none: Zero tax rate, low: First reduced tax rate, third: Second reduced tax rate, superLow: Super low tax rate, parking: Parking tax rate.","examples":["high"]}}}}}}},"indexName":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String which defines product url. Value is sanitized to fits url needs = All characters except [a-zA-Z0-9_] will be converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If value is not present, indexName is created from product name."},"children":[]}]}]}],"examples":["baleriny-modre-s-puntiky"]},"relatedVideos":{"type":"array","description":"Product related videos.","items":{"type":"object","additionalProperties":false,"required":["code","type"],"properties":{"code":{"type":"string","maxLength":32,"description":"related video code.","examples":["zpvmPA3me7o"]},"title":{"type":["string","null"],"maxLength":128,"description":"related video title.","examples":["Test video"]},"type":{"enum":["youtube","youtube-short"],"description":"related video type.","examples":["youtube"]}}}}}}},"components/schemas/category":{"id":"components/schemas/category","kind":"json-schema","title":"category","data":{"type":"object","additionalProperties":false,"required":["guid","name","image","description","secondDescription","indexName","url","parentGuid","priority","menuTitle","title","metaTagDescription","visible","customerVisibility","similarProductsCategory","relatedProductsCategory","productOrdering","catalogueMapping"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidNullable","description":"unique category identificator","examples":["0198418d-acde-708e-9389-0c5113d9b5f3"]},"name":{"type":"string","description":"category name","examples":["Category name"]},"image":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header image (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["https://beta.shoptet.cz/user/categories/thumb/supreme-plush-santa-hat.jpg"]},"description":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"top category description (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["

Horní popis kategorie

"]},"secondDescription":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bottom category description (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["

Dolní popis kategorie

"]},"indexName":{"type":"string","description":"ending part of category URL","examples":["sport-a-relax"]},"url":{"type":"string","description":"category URL in the e-shop","examples":["https://beta.shoptet.cz/sport-a-relax"]},"parentGuid":{"$ref":"#/components/schemas/typeGuidNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unique identifier of the parent category ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if there is no parent category)"},"children":[]}]}]}],"examples":["0198566d-2eeb-73ed-8dc4-0c94b5a7e035"]},"priority":{"type":["integer","null"],"description":"priority (specifies the order of categories)","examples":[1]},"menuTitle":{"type":["string","null"],"description":"category name in the e-shop menu","examples":["Watches"]},"title":{"type":["string","null"],"description":"HTML title element in the HTML header of the category page","examples":["Purple M size T-shirts - cotton"]},"metaTagDescription":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTML META header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in category page"},"children":[]}]}]}],"examples":["T-shirts, cotton, M size, purple, pink, wine red"]},"visible":{"type":"boolean","description":"flag, whether the category is visible","examples":[true]},"similarProductsCategory":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUID category, in which the products are similar to this category (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed"]},"relatedProductsCategory":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GUID category, in which the products are related to this category (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed"]},"customerVisibility":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines, which users of the e-shop have the category shown - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = all, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = registered users, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unregistered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = non-registered users, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin-only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = administrators"},"children":[]}]}]}],"examples":["all"]},"productOrdering":{"type":"string","enum":["default","most-selling","cheapest","most-expensive","oldest","newest","alphabetically","alphabetically-desc","product-code","product-code-desc","category-priority","category-priority-desc"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines, how products are sorted in a category. See also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/sorting-of-products-in-category"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting of products in category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["alphabetically"]},"catalogueMapping":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pairing to search engines such as Zboží, Heuréka, Google, etc. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"required":["provider","category"],"properties":{"provider":{"type":"string","description":"provider type","examples":["heureka"]},"category":{"type":"string","description":"provider category","examples":["Clothing | Women's T-Shirts"]}}}}}}},"components/schemas/categoryUpdate":{"id":"components/schemas/categoryUpdate","kind":"json-schema","title":"categoryUpdate","data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Category GUID. Must be unique if set. Optional."},"name":{"type":"string","minLength":1,"maxLength":255,"description":"Category name. Optional.","examples":["Watches"]},"parentGuid":{"$ref":"#/components/schemas/typeGuidNullable","description":"Parent category GUID. Category must exist if set. Optional."},"description":{"type":["string","null"],"description":"Category description. Max length 65535 bytes. Optional.","examples":["

Top category description

"]},"secondDescription":{"type":["string","null"],"description":"Bottom category description. Max length 65535 bytes. Optional.","examples":["

Bottom category description

"]},"imageName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category image. File must exist on the server. Optional. (Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceImageName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead)"},"children":[]}]}]}],"examples":["watches-category-image.jpg"],"deprecated":true},"sourceImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as category image."},"children":[]}]}]}],"examples":["image.png"]},"sortBefore":{"$ref":"#/components/schemas/typeGuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guid of category before which you want to move the category from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional."},"children":[]}]}]}]},"sortAfter":{"$ref":"#/components/schemas/typeGuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guid of category after which you want to move the category from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional."},"children":[]}]}]}]},"indexName":{"type":"string","minLength":1,"description":"Last part of url. Optional, generated from name if not set.","examples":["watches"]},"menuTitle":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Label for menu. Optional.","examples":["Watches"]},"title":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Meta tag title. Optional.","examples":["Watches"]},"metaTagDescription":{"type":["string","null"],"description":"Meta tag description. Optional.","examples":["Watches, Apple watch, black, white, garmin"]},"visible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the category is visible. Optional, default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"customerVisibility":{"type":"string","enum":["all","registered","unregistered","admin-only"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines users of the e-shop who can see the category - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = all (default), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = registered users, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unregistered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = non-registered users. Optional."},"children":[]}]}]}],"examples":["all"]},"productOrdering":{"type":"string","enum":["default","most-selling","cheapest","most-expensive","oldest","newest","alphabetically","alphabetically-desc","product-code","product-code-desc","category-priority","category-priority-desc"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines how products are sorted in a category; see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/sorting-of-products-in-category"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting of products in category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["alphabetically"]},"similarProductsCategory":{"$ref":"#/components/schemas/typeGuidNullable","description":"Similar category guid. Optional."},"relatedProductsCategory":{"$ref":"#/components/schemas/typeGuidNullable","description":"Related category guid. Optional."}}}},"components/schemas/pricelistUpdate":{"id":"components/schemas/pricelistUpdate","kind":"json-schema","title":"pricelistUpdate","data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code"],"minProperties":2,"properties":{"code":{"type":"string","description":"Product variant code","examples":["106/BIL"]},"currencyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code. List of available currencies within the e-shop can be found in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/eshop/geteshopinfo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Eshop info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"examples":["CZK"]},"vatRate":{"$ref":"#/components/schemas/typeVatRateNullable","description":"VatRate for prices","examples":["21.00"]},"includingVat":{"type":"boolean","description":"Whether the product prices are saved with vat or without.","examples":[true]},"orderableAmount":{"type":"object","additionalProperties":false,"description":"Orderable quantity","properties":{"minimumAmount":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"Minimum orderable quantity","examples":["1"]},"maximumAmount":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"Maximum orderable quantity","examples":["10"]}}},"sales":{"type":"object","additionalProperties":false,"description":"Definition of discounts","properties":{"minPriceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 decimal places accuracy, (from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), maximum permitted discount."},"children":[]}]}]}],"examples":["0.880"]},"freeShipping":{"type":"boolean","description":"flag, whether the product will have a free transport after it is placed in the cart.","examples":[true]},"freeBilling":{"type":"boolean","description":"flag, whether the product will have a free payment after it is placed in the cart.","examples":[true]},"loyaltyDiscount":{"type":"boolean","description":"flag, whether the loyalty discount should be used.","examples":[true]},"volumeDiscount":{"type":"boolean","description":"flag, whether the volume discount should be used.","examples":[true]},"quantityDiscount":{"type":"boolean","description":"flag, whether the volume/multibuy discount should be used.","examples":[true]},"discountCoupon":{"type":"boolean","description":"flag, whether a discount coupon can be applied.","examples":[true]}}},"price":{"type":"object","additionalProperties":false,"description":"Prices","properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price, at which the customer can purchase the product. It can be loaded by the special discounted price and influenced by the price ratio. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["650.00"]},"commonPrice":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard price, use for information and comparison to competitors (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["750.00"]},"buyPrice":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase price. Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prices.purchasePrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"examples":["500.00"],"deprecated":true},"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"price ratio. The price of the product shall be calculated by multiplying the price and this coefficient. The price ratio affects only the price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the special discounted price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actionPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is not affected by the ratio. This ratio has 3 decimal places and can be greater than 1,000"},"children":[]}]}]}],"examples":["1.000"]},"actionPrice":{"type":["object","null"],"additionalProperties":false,"description":"Special discounted price","properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"special discounted price. It is only used if set and if the validity date is set too, form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["600.00"]},"fromDate":{"$ref":"#/components/schemas/typeDateNullable","description":"special discounted price effective date - from","examples":["2018-02-19"]},"toDate":{"$ref":"#/components/schemas/typeDateNullable","description":"special discounted price effective date - up to","examples":["2018-02-25"]}}}}},"priceWithVat":{"type":"object","additionalProperties":false,"description":"Prices with VAT","properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price, at which the customer can purchase the product. It can be loaded by the special discounted price and influenced by the price ratio. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["650.00"]},"commonPrice":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard price, use for information and comparison to competitors (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["750.00"]},"buyPrice":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase price. Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prices.purchasePrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"examples":["500.00"],"deprecated":true},"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"price ratio. The price of the product shall be calculated by multiplying the price and this coefficient. The price ratio affects only the price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the special discounted price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actionPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is not affected by the ratio. This ratio has 3 decimal places and can be greater than 1,000"},"children":[]}]}]}],"examples":["1.000"]},"actionPrice":{"type":["object","null"],"additionalProperties":false,"description":"Special discounted price","properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"special discounted price. It is only used if set and if the validity date is set too, form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["600.00"]},"fromDate":{"$ref":"#/components/schemas/typeDateNullable","description":"special discounted price effective date - from","examples":["2018-02-19"]},"toDate":{"$ref":"#/components/schemas/typeDateNullable","description":"special discounted price effective date - up to","examples":["2018-02-25"]}}}}},"priceWithoutVat":{"type":"object","additionalProperties":false,"description":"Prices without VAT","properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price, at which the customer can purchase the product. It can be loaded by the special discounted price and influenced by the price ratio. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["650.00"]},"commonPrice":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard price, use for information and comparison to competitors (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["750.00"]},"buyPrice":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase price. Deprecated, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prices.purchasePrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"examples":["500.00"],"deprecated":true},"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"price ratio. The price of the product shall be calculated by multiplying the price and this coefficient. The price ratio affects only the price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the special discounted price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actionPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is not affected by the ratio. This ratio has 3 decimal places and can be greater than 1,000"},"children":[]}]}]}],"examples":["1.000"]},"actionPrice":{"type":["object","null"],"additionalProperties":false,"description":"Special discounted price","properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"special discounted price. It is only used if set and if the validity date is set too, form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["600.00"]},"fromDate":{"$ref":"#/components/schemas/typeDateNullable","description":"special discounted price effective date - from","examples":["2018-02-19"]},"toDate":{"$ref":"#/components/schemas/typeDateNullable","description":"special discounted price effective date - up to","examples":["2018-02-25"]}}}}},"prices":{"type":["object"],"additionalProperties":false,"properties":{"purchasePrice":{"type":"object","additionalProperties":false,"description":"Purchase price. Currently for preview only! Will be used as replace for buy price. Please watch API news.","properties":{"price":{"$ref":"#/components/schemas/typePriceNullable","description":"purchase price.","examples":["500.00"]},"vatRate":{"$ref":"#/components/schemas/typeVatRateNullable","description":"VatRate for prices","examples":["21.00"]},"includingVat":{"type":"boolean","description":"flag, whether the purchase price is including VAT","examples":[true]}}}}}}}}},"components/schemas/orderItem":{"id":"components/schemas/orderItem","kind":"json-schema","title":"orderItem","data":{"type":"object","additionalProperties":false,"required":["productGuid","code","ean","itemType","name","variantName","brand","remark","weight","additionalField","amount","amountUnit","priceRatio","status","itemPrice","unitPrice","purchasePrice","recyclingFee","itemId","warrantyDescription","amountCompleted"],"properties":{"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product identifier of the item. At the time the order is created, it will be entered in this field, but when the product is deleted, the link will be lost (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"code":{"type":["string","null"],"description":"identifier of the item code (product or variant). At the time the order is created, it will be entered in this field, but when the product is deleted, the link will be lost.","examples":["40/ZEL"]},"ean":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EAN of the product variant (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["12345678901234"]},"itemType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item type (product, service...). See also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/types-of-order-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of order items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["product"]},"productType":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product type at the time of the order (product, product-set..). See also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["product"]},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product name, with possible addition ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Free Gift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Complete + Addition to the name"]},"variantName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variant name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Name"]},"brand":{"type":["string","null"],"description":"product brand (or manufacturer, possibly)","examples":["Test"]},"remark":{"type":["string","null"],"description":"remark","examples":["This is a remark"]},"weight":{"$ref":"#/components/schemas/typeWeight"},"additionalField":{"type":["string","null"],"description":"additional field for remarks","examples":["Online payment"]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"product quantity","examples":[1]},"amountUnit":{"type":["string","null"],"description":"product unit of quantity","examples":["ks"]},"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"price coefficient. This also represents a discount (discount "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10 %"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceRatio = 0.9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"status":{"type":"object","additionalProperties":false,"required":["name","id"],"properties":{"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order item status description (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Canceled"]},"id":{"type":"integer","description":"identifier of order item status","examples":[-1]}}},"itemPrice":{"$ref":"#/components/schemas/itemPrice","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the price of the item including the discount ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceRatio"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and quantity ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"unitPrice":{"$ref":"#/components/schemas/itemPrice","description":"unit price"},"displayPrices":{"type":"array","items":{"$ref":"#/components/schemas/itemPrice"}},"purchasePrice":{"oneOf":[{"$ref":"#/components/schemas/itemPrice"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase price of item, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"recyclingFee":{"$ref":"#/components/schemas/recyclingFee","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recycling fee including category and price (or possibly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"mainImage":{"type":["object","null"],"additionalProperties":false,"required":["name","seoName","cdnName","signedCdnNames","priority","description","changeTime"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image file name, also serves as an identifier for the image of the product. To assemble complete URL, it is added to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" obtained from the endpoint e-shop info "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["100.jpg"]},"seoName":{"type":"string","description":"file name modified for SEO - a short label is attached.","examples":["100_purple-apple.jpg"]},"cdnName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seoName with signed CDN query parameters for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"big"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cut. Combine with the cut's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form the full URL. Old-format URLs (bare hash) remain valid on the CDN."},"children":[]}]}]}],"examples":["100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"]},"signedCdnNames":{"type":["array","null"],"items":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string"},"name":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-cut signed CDN filenames. Combine each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value with the matching cut's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form a correctly-signed URL. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when cut configuration is temporarily unavailable."},"children":[]}]}]}],"examples":[[{"type":"big","name":"100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"},{"type":"thumbnail","name":"100_purple-apple.jpg?ff=1&x=300&y=300&q=85&ts=59393c3a&sg=ab12cd34"}]]},"priority":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the key for the sequence of images matching the sequence in administration - it's not necessarily from the first, and the series may contain gaps. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":[1]},"description":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"description of the image (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["Fresh purple apple for Snow White"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last image change time If you are saving images together, you can use this timestamp to indicate if you need to reload the image. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}},"stockLocation":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"position in stock (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["H6/M11/R13"]},"supplierName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product supplier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Dodavatel s.r.o"]},"itemId":{"type":"integer","description":"order item identifier","examples":[342]},"warrantyDescription":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"textual description of warranty length (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["24 months"]},"amountCompleted":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quantity of completed product. Deprecated - use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section instead."},"children":[]}]}]}],"examples":[1],"deprecated":true},"surchargeParametersTexts":{"type":"array","description":"List of custom surcharge parameters names","items":{"type":"string"},"deprecated":true},"surchargeParameters":{"$ref":"#/components/schemas/itemSurchargeParameters","description":"items surcharge parameters, filled in order creation. Cannot be edited."},"specificSurchargeParameters":{"$ref":"#/components/schemas/itemSpecificSurchargeParameters","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of specific surcharge parameters for order item detail, created from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but editable in order item detail in eshop administration or via order item detail surcharge-parameters endpoint."},"children":[]}]}]}]},"productFlags":{"$ref":"#/components/schemas/productFlags","description":"list of product flags"},"consumptionTax":{"$ref":"#/components/schemas/documentConsumptionTax","description":"consumption tax of order item"},"itemPriceVatBreakdown":{"type":["array","null"],"description":"Detailed VAT list displaying tax amounts for each VAT rate used in the document. Applied for non product items.","items":{"$ref":"#/components/schemas/itemPrice"}}}}},"components/schemas/relatedProduct":{"id":"components/schemas/relatedProduct","kind":"json-schema","title":"relatedProduct","data":{"type":"object","additionalProperties":false,"required":["guid","priority"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"related product identifier"},"priority":{"type":"integer","description":"Priority of product in related products list","examples":[1]},"visibility":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visibility of product ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"normal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["normal"]},"linkType":{"type":"string","description":"Type of the link to the product. Defines if the product is paired physically or reciprocally.","examples":["physical","reciprocal"]}}}},"components/schemas/productSet":{"id":"components/schemas/productSet","kind":"json-schema","title":"productSet","data":{"type":["object","null"],"additionalProperties":false,"required":["guid","code","amount"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"product identifier"},"code":{"type":"string","minLength":1,"description":"product code","examples":["154"]},"amount":{"$ref":"#/components/schemas/typePositiveAmount","description":"amount of items, products","examples":[1]}}}},"components/schemas/productGifts":{"id":"components/schemas/productGifts","kind":"json-schema","title":"productGifts","data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","priority"],"properties":{"code":{"type":"string","description":"product variant identifier","examples":["0008"]},"priority":{"type":"integer","description":"variant priority","examples":[1]}}}}},"components/schemas/orderGift":{"id":"components/schemas/orderGift","kind":"json-schema","title":"orderGift","data":{"type":"object","additionalProperties":false,"required":["id","code","currencyCode","orderPrice","includingVat","priority"],"properties":{"id":{"type":"integer","description":"primary key of gift, should be used when delete gift","examples":[1]},"code":{"type":"string","description":"identifier of product variant, which will be added as a gift","examples":["0008"]},"currencyCode":{"$ref":"#/components/schemas/typeCurrencyCode"},"orderPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"price which order total price should overcome. to add this gift"},"includingVat":{"type":"boolean","description":"flag, if price is including VAT","examples":[true]},"priority":{"type":"integer","description":"define order","examples":[1]}}}},"components/schemas/article":{"id":"components/schemas/article","kind":"json-schema","title":"article","data":{"type":"object","additionalProperties":false,"required":["id","title","indexName","redirectUrl","content","metaTitle","metaKeywords","metaDescription","publishDate","changeDate","visible","access"],"properties":{"id":{"type":"integer","description":"article ID","examples":[1]},"defaultSectionId":{"type":"integer","description":"article section ID","examples":[682]},"sectionIds":{"type":["array","null"],"description":"array of section IDs","items":{"type":"integer","examples":[682]}},"title":{"type":"string","description":"article title","examples":["Test"]},"language":{"type":"string","description":"Article language. Available only if module foreignLanguages is active and initialized.","examples":["cs"]},"indexName":{"type":["string","null"],"description":"ending part of article URL","examples":["new-article"]},"url":{"type":"string","description":"article URL","examples":["https://www.some-eshop-url.com/blog/new-article"]},"urls":{"type":"array","description":"array of section IDs and their URLs","items":{"$ref":"#/components/schemas/articleUrls"}},"redirectUrl":{"type":["string","null"],"description":"canonical URL for redirecting","examples":["https://www.someurl.com"]},"content":{"type":["string","null"],"description":"article content","examples":["

Content of the article

"]},"metaTitle":{"type":["string","null"],"description":"article meta title","examples":["Test article\""]},"metaKeywords":{"type":["string","null"],"description":"article keywords","examples":["test"],"deprecated":true},"metaDescription":{"type":["string","null"],"description":"article meta description","examples":["Test article"]},"publishDate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"article date of publishing","examples":["2014-11-19T00:00:00+0100"]},"changeDate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"article date of the last modification","examples":["2014-11-19T00:00:00+0100"]},"visible":{"type":"boolean","description":"flag whether the article is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out","admin-only"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag indicating, whether the article can be viewed by everyone (value of the flag is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), by logged in users only ('logged-in'), or by logged out users only ('logged-out'), or by administrators only ('admin-only')"},"children":[]}]}]}],"examples":["logged-in"]},"image":{"type":["string","null"],"description":"article image","examples":["https://www.some-eshop-url.com/image.jpg"]},"ogImage":{"type":["string","null"],"description":"article og:image","examples":["https://www.some-eshop-url.com/image.jpg"]}}}},"components/schemas/articleList":{"id":"components/schemas/articleList","kind":"json-schema","title":"articleList","data":{"type":"object","additionalProperties":false,"required":["id","title","publishDate","visible"],"properties":{"id":{"type":"integer","description":"article ID","examples":[1]},"defaultSectionId":{"type":"integer","description":"article section ID","examples":[682]},"sectionId":{"type":"integer","description":"article section ID","examples":[682]},"title":{"type":"string","description":"article title","examples":["Test"]},"url":{"type":"string","description":"article URL","examples":["https://www.some-eshop-url.com/blog/new-article"]},"publishDate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"article date of publishing"},"visible":{"type":"boolean","description":"flag whether the article is visible on web","examples":[true]},"image":{"type":["string","null"],"description":"article image","examples":["https://www.some-eshop-url.com/image.jpg"]}}}},"components/schemas/articleSection":{"id":"components/schemas/articleSection","kind":"json-schema","title":"articleSection","data":{"type":"object","additionalProperties":false,"required":["id","title"],"properties":{"id":{"type":"integer","description":"article section ID","examples":[1]},"parentId":{"type":["integer","null"],"description":"article section parent ID","examples":[1]},"title":{"type":"string","description":"article section title","examples":["Test"]},"language":{"type":"string","description":"Article section language. Available only if module foreignLanguages is active and initialized.","examples":["cs"]},"indexName":{"type":["string","null"],"description":"ending part of article section URL","examples":["new-article"]},"url":{"type":["string"],"description":"article section URL","examples":["new-article"]},"description":{"type":["string","null"],"description":"article section content","examples":["

Content of the article section

"]},"secondDescription":{"type":["string","null"],"description":"article section content secondary","examples":["

Content of the secondary article section

"]},"limit":{"type":["integer","null"],"description":"Number of articles displayed in the listing","examples":[4]},"homepageLimit":{"type":["integer","null"],"description":"Number of articles displayed on the homepage","examples":[4]},"sorting":{"enum":["alphabetically","newest-first","oldest-first"],"description":"Article sorting in the listing","examples":["alphabetically"]},"perexLimit":{"type":["integer","null"],"description":"Number of character displayed in the article perex","examples":[100]},"hidePublishDate":{"type":"boolean","description":"Hide article publish date in the listing","examples":[false]},"showPrevNext":{"type":"boolean","description":"Show next/previous buttons in the listing","examples":[true]},"showOnHomepage":{"type":"boolean","description":"Show articles on the homepage","examples":[false]},"linkText":{"type":["string","null"],"description":"Link text (in the menu)","examples":["Test articles"]},"metaTitle":{"type":["string","null"],"description":"article meta title","examples":["Test articles"]},"metaDescription":{"type":["string","null"],"description":"article meta description","examples":["Test articles"]},"canonicalLinkUrl":{"type":["string","null"],"description":"Canonical link URL","examples":["https://www.someurl.com"]},"visible":{"type":"boolean","description":"flag whether the article section is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out","admin-only"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag indicating, whether the article section can be viewed by everyone (value of the flag is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), by logged in users only ('logged-in'), or by logged out users only ('logged-out'), or by administrators only ('admin-only')"},"children":[]}]}]}],"examples":["logged-in"]},"image":{"type":["string","null"],"description":"article section image","examples":["https://www.some-eshop-url.com/image.jpg"]},"ogImage":{"type":["string","null"],"description":"article section open graph image","examples":["https://www.some-eshop-url.com/image.jpg"]}}}},"components/schemas/articleSectionList":{"id":"components/schemas/articleSectionList","kind":"json-schema","title":"articleSectionList","data":{"type":"object","additionalProperties":false,"required":["id","title"],"properties":{"id":{"type":"integer","description":"article section ID","examples":[683]},"title":{"type":"string","description":"article section title","examples":["Blog"]},"language":{"type":"string","description":"Article section language. Available only if module foreignLanguages is active and initialized.","examples":["cs"]}}}},"components/schemas/googleMappingType":{"id":"components/schemas/googleMappingType","kind":"json-schema","title":"googleMappingType","data":{"type":["object","null"],"additionalProperties":false,"description":"Possible parameter mapping with google","properties":{"value":{"type":"string","description":"Code (identifier) of google mapping parameter","examples":["google:color"]},"description":{"type":["string","null"],"description":"Description (name) of google mapping parameter","examples":["Color"]}}}},"components/schemas/discussionPost":{"id":"components/schemas/discussionPost","kind":"json-schema","title":"discussionPost","data":{"type":"object","additionalProperties":false,"required":["id","parentId","productGuid","articleId","pageId","customerGuid","name","email","title","content","creationDate","authorized"],"properties":{"id":{"type":"integer","description":"discussion post ID","examples":[2]},"parentId":{"type":["integer","null"],"description":"discussion post parent ID","examples":[1]},"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"Discussion post product identifier."},"articleId":{"type":["integer","null"],"description":"Discussion post article identifier.","examples":[2]},"pageId":{"type":["integer","null"],"description":"Discussion post page identifier.","examples":[3]},"customerGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"Discussion post customer identifier."},"name":{"type":["string","null"],"description":"name of the author","examples":["John Doe"]},"email":{"type":["string","null"],"description":"email of the author","examples":["john.doe@example.com"]},"title":{"type":["string","null"],"description":"title of the post","examples":["Some title"]},"content":{"type":["string","null"],"description":"content of the post","examples":["Some content"]},"creationDate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of the post creation"},"authorized":{"type":"boolean","description":"flag whether the post is authorized (visible on the web)","examples":[true]}}}},"components/schemas/discussionSettings":{"id":"components/schemas/discussionSettings","kind":"json-schema","title":"discussionSettings","data":{"type":"object","additionalProperties":false,"required":["context","active","authorizationRequired","onlyRegisteredUsers","usersCanAnswer","itemsPerPage"],"properties":{"context":{"type":"string","enum":["product","article","section_article"],"description":"discussion context the settings apply to","examples":["product"]},"active":{"type":"boolean","description":"flag whether discussions are enabled for this context","examples":[true]},"authorizationRequired":{"type":"boolean","description":"flag whether posts require authorization (moderation) before being published","examples":[false]},"onlyRegisteredUsers":{"type":"boolean","description":"flag whether only registered users may post (anonymous posting disabled)","examples":[false]},"usersCanAnswer":{"type":"boolean","description":"flag whether customers can reply to existing discussion posts","examples":[true]},"itemsPerPage":{"type":"integer","description":"number of discussion posts displayed per page","examples":[20]}}}},"components/schemas/pageList":{"id":"components/schemas/pageList","kind":"json-schema","title":"pageList","data":{"type":"object","additionalProperties":false,"required":["id","title"],"properties":{"id":{"type":"integer","description":"page ID","examples":[1]},"title":{"type":"string","description":"page title","examples":["About us"]},"url":{"type":"string","description":"page URL","examples":["https://www.some-eshop-url.com/about-us"]},"visible":{"type":"boolean","description":"flag whether the page is visible on web","examples":[true]},"ogImage":{"type":["string","null"],"description":"page og:image","examples":["https://www.some-eshop-url.com/image.jpg"]}}}},"components/schemas/page":{"id":"components/schemas/page","kind":"json-schema","title":"page","data":{"type":"object","additionalProperties":false,"required":["id","title","content","url","linkText","metaTitle","metaDescription","canonicalUrl","visible","access","ogImage"],"properties":{"id":{"type":"integer","description":"page ID","examples":[1]},"language":{"type":"string","description":"Page language. Available only if module foreignLanguages is active and initialized.","examples":["cs"]},"title":{"type":"string","description":"page title","examples":["About us"]},"content":{"type":["string","null"],"description":"page content","examples":["

Content of the page

"]},"url":{"type":"string","description":"page URL","examples":["https://www.some-eshop-url.com/about-us"]},"linkText":{"type":["string","null"],"description":"text of the page link","examples":["About us"]},"metaTitle":{"type":["string","null"],"description":"page meta title","examples":["About us page"]},"metaDescription":{"type":["string","null"],"description":"page meta description","examples":["About us page description"]},"canonicalUrl":{"type":["string","null"],"description":"Canonical URL of the page","examples":["https://www.someurl.com"]},"visible":{"type":"boolean","description":"flag whether the page is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out","admin-only"],"description":"flag indicating, whether the page can be viewed by everyone (value of the flag is: 'all'), by logged in users only ('logged-in'), or by logged out users only ('logged-out'), or by administrators only ('admin-only')","examples":["logged-in"]},"ogImage":{"type":["string","null"],"description":"page og:image","examples":["https://www.some-eshop-url.com/image.jpg"]}}}},"components/schemas/reviewProject":{"id":"components/schemas/reviewProject","kind":"json-schema","title":"reviewProject","data":{"type":"object","additionalProperties":false,"required":["id","date","orderCode","rating","description","fullName","email","customerGuid","visible","ipAddress"],"properties":{"id":{"type":"integer","description":"Review id.","examples":[1]},"date":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Review creation date."},"orderCode":{"type":["null","string"],"description":"Order code related to review. Can be null.","examples":["2011000002"]},"rating":{"type":"integer","description":"Number from 1 to 5 representing stars of review's rating.","examples":[5]},"description":{"type":["null","string"],"description":"Review text. Can be null.","examples":["Snack was very good"]},"fullName":{"type":["null","string"],"description":"Fullname of review's author. Can be null.","examples":["John Doe"]},"email":{"type":["null","string"],"description":"Email of the review author. Can be null.","examples":["johndoe@email.tld"]},"customerGuid":{"type":["null","string"],"description":"Customer guid related to review. Can be null.","examples":["443cad54-73bc-11e8-8216-002590dad85e"]},"visible":{"type":"boolean","description":"flag, whether the review is visible","examples":[false]},"ipAddress":{"type":["string","null"],"description":"IP address of the client who made the review. Can be null.","examples":["213.46.237.24"]},"reaction":{"type":"object","additionalProperties":false,"required":["reactionCreated","reactionFullName","reactionEmail","reactionText"],"properties":{"reactionCreated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date of creation of reaction. Can be null."},"reactionFullName":{"type":["null","string"],"description":"Fullname of reaction author. Can be null.","examples":["John Doe"]},"reactionEmail":{"type":["null","string"],"description":"Email of the reaction author. Can be null.","examples":["johndoe@email.tld"]},"reactionText":{"type":["null","string"],"description":"Text of the reaction. Can be null.","examples":["Thank you for your review!"]}}}}}},"components/schemas/parameterValueCombinations":{"id":"components/schemas/parameterValueCombinations","kind":"json-schema","title":"parameterValueCombinations","data":{"type":"object","additionalProperties":false,"required":["parameterCode","parameterName","valueCode","valueName"],"properties":{"parameterCode":{"type":"string","description":"Code of the parameter","examples":["color"]},"parameterName":{"type":"string","description":"Name of the parameter","examples":["Color"]},"valueCode":{"type":"string","description":"Code of the parameter value","examples":["red"]},"valueName":{"type":"string","description":"Name of the parameter value","examples":["Red"]}}}},"components/schemas/parameterValueCombinationsCodes":{"id":"components/schemas/parameterValueCombinationsCodes","kind":"json-schema","title":"parameterValueCombinationsCodes","data":{"type":"object","additionalProperties":false,"required":["parameterCode","valueCode"],"properties":{"parameterCode":{"type":"string","description":"Code of the parameter","examples":["color"]},"valueCode":{"type":"string","description":"Code of the parameter value","examples":["red"]}}}},"components/schemas/xyDiscount":{"id":"components/schemas/xyDiscount","kind":"json-schema","title":"xyDiscount","data":{"type":"object","additionalProperties":false,"required":["id","title","validFrom","validTo","customerGroups","xAmount","yAmount","description","termsAndConditionsUrl","displayFlag","flagColor","priority","usageCount","displayBanner","bannerColor","xTargeting","yTargeting","includeUnregisteredCustomers"],"properties":{"id":{"type":"integer","description":"discount ID","examples":[1]},"title":{"type":"string","description":"discount title","examples":["18 + 4 free"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity from","examples":["2014-11-19"]},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity to","examples":["2014-12-19"]},"customerGroups":{"type":["array","null"],"description":"customer groups connected to discount","items":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","description":"customer group code","examples":["retail"]},"name":{"type":"string","description":"customer group name","examples":["Retail customer"]}}}},"xAmount":{"$ref":"#/components/schemas/typeAmount","description":"amount of products needed to get discount","examples":["2.000"]},"yAmount":{"$ref":"#/components/schemas/typeAmount","description":"amount of products get by discount","examples":["1.000"]},"description":{"type":["string","null"],"description":"discount description","examples":["

Content of the article

"]},"termsAndConditionsUrl":{"type":["string","null"],"description":"url address lead to terms of discount","examples":["https://test.myshoptet.com/test"]},"displayFlag":{"type":"boolean","description":"whether the flag is displayed","examples":[true]},"flagColor":{"$ref":"#/components/schemas/typeColor","description":"color of the flag"},"displayBanner":{"type":"boolean","description":"flag whether the banner is displayed","examples":[true]},"bannerColor":{"$ref":"#/components/schemas/typeColor","description":"color of the banner"},"priority":{"type":["integer","null"],"description":"priority of the discount","examples":[1]},"usageCount":{"type":["integer","null"],"description":"number of how many times can be discount used","examples":[1000]},"xTargeting":{"$ref":"#/components/schemas/xyDiscountTargetingResponse","description":"definition of products needed to get discount"},"yTargeting":{"$ref":"#/components/schemas/xyDiscountTargetingResponse","description":"definition of products get by discount"},"includeUnregisteredCustomers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines if discount is valid for unregistered customers, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"examples":[true]}}}},"components/schemas/xyDiscountTargetingResponse":{"id":"components/schemas/xyDiscountTargetingResponse","kind":"json-schema","title":"xyDiscountTargetingResponse","data":{"type":["object","null"],"required":["productGuids","categoryGuids","brandCodes"],"description":"definition of products needed to get discount","additionalProperties":false,"properties":{"productGuids":{"type":["array","null"],"description":"array of product guids","items":{"type":"string","examples":["356eb81e-d966-11e0-b04f-57a43310b768"]}},"categoryGuids":{"type":["array","null"],"description":"array of page guids (categories)","items":{"type":"string","examples":["07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed"]}},"brandCodes":{"type":["array","null"],"description":"array of brand codes","items":{"type":"string","examples":["brand-1"]}}}}},"components/schemas/xyDiscountTargetingPostRequest":{"id":"components/schemas/xyDiscountTargetingPostRequest","kind":"json-schema","title":"xyDiscountTargetingPostRequest","data":{"type":"object","minProperties":1,"properties":{"productGuids":{"type":"array","minItems":1,"description":"array of product guids","items":{"type":"string","examples":["356eb81e-d966-11e0-b04f-57a43310b768"]}},"categoryGuids":{"type":"array","description":"array of page guids (categories)","minItems":1,"items":{"type":"string","examples":["07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed"]}},"brandCodes":{"type":"array","minItems":1,"description":"array of brand codes","items":{"type":"string","examples":["brand-1"]}}}}},"components/schemas/proofPaymentVatBreakdown":{"id":"components/schemas/proofPaymentVatBreakdown","kind":"json-schema","title":"proofPaymentVatBreakdown","data":{"type":["object","null"],"additionalProperties":false,"required":["items","summary"],"properties":{"items":{"type":"array","description":"breakdown of VAT items","items":{"type":"object","additionalProperties":false,"required":["vatRate","priceWithVat","priceWithoutVat","vat"],"properties":{"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":"VAT rate","examples":[21]},"priceWithVat":{"$ref":"#/components/schemas/typePriceNullable","description":"price with VAT","examples":[121]},"priceWithoutVat":{"$ref":"#/components/schemas/typePriceNullable","description":"price without VAT","examples":[100]},"vat":{"$ref":"#/components/schemas/typePriceNullable","description":"VAT value","examples":[21]}}}},"summary":{"type":"object","additionalProperties":false,"required":["withVat","withoutVat","vat"],"description":"summary of VAT breakdown","properties":{"withVat":{"$ref":"#/components/schemas/typePriceNullable","description":"Total price with VAT","examples":[121]},"withoutVat":{"$ref":"#/components/schemas/typePriceNullable","description":"Total price without VAT","examples":[100]},"vat":{"$ref":"#/components/schemas/typePriceNullable","description":"Total VAT value","examples":[21]}}}}}},"components/schemas/proofPaymentsList":{"id":"components/schemas/proofPaymentsList","kind":"json-schema","title":"proofPaymentsList","data":{"type":"object","additionalProperties":false,"required":["code","orderCode","proformaInvoiceCode","invoiceCode","issueDate","billFullName","payment","isValid","closed","invoicingExchangeRate"],"properties":{"code":{"type":"string","description":"proof payments identifier. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["P--2015000170-1"]},"orderCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2015000001"]},"proformaInvoiceCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proforma invoice code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2015000170"]},"issueDate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linked to invoice code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"billFullName":{"type":["string","null"],"description":"name on the bill","examples":["John Doe"]},"payment":{"$ref":"#/components/schemas/typePriceNullable","description":"total price on the bill","examples":[100]},"isValid":{"type":"boolean","description":"is the proof payment valid?","examples":[true]},"vatMode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT mode, can be null, for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/vat-modes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT modes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["Normal"]},"invoicingExchangeRate":{"$ref":"#/components/schemas/typeExchangeRate"},"invoiceCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linked to invoice code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2017100013"]},"closed":{"type":"boolean","description":"is the proof payment closed?","examples":[true]}}}},"components/schemas/proofPaymentDetail":{"id":"components/schemas/proofPaymentDetail","kind":"json-schema","title":"proofPaymentDetail","data":{"type":"object","additionalProperties":false,"required":["code","orderCode","proformaInvoiceCode","invoiceCode","createdAt","updatedAt","issueDate","taxDate","isValid","currencyCode","payment","closed","billFullName","billCompany","billStreet","billHouseNumber","billCity","billDistrict","billAdditional","billZip","billCountryCode","billRegionName","billRegionShortcut","vatId","taxId","companyId","email","phone","source","cashdeskId","customerGuid","customerProfileId","identificationNumber","remark","varSymbol","constSymbol","specSymbol","billingMethod","billBankAccount","billIban","billBic","bankAccount","iban","bic","documentRemark","vatBreakdown","invoicingExchangeRate"],"properties":{"code":{"type":"string","description":"proof payments identifier. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["P--2015000170-1"]},"orderCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2015000001"]},"proformaInvoiceCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proforma invoice code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2015000170"]},"createdAt":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of create, in ISO 8601 format"},"updatedAt":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of update, in ISO 8601 format"},"issueDate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date on which was proof payment issued, in ISO 8601 format"},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":"date of tax"},"isValid":{"type":"boolean","description":"is proof payment valid?","examples":[true]},"currencyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency code. List of available currencies within the e-shop can be found in endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/eshop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["CZK"]},"payment":{"$ref":"#/components/schemas/typePriceNullable","description":"total price on the bill","examples":["1000.00"]},"closed":{"type":"boolean","description":"is proof payment closed?","examples":[true]},"billFullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Doe"]},"billCompany":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company name on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Shoptet, a.s."]},"billStreet":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Křižíkova"]},"billHouseNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"house number on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["237/36"]},"billCity":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Praha 2"]},"billDistrict":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"county on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Praha 2"]},"billAdditional":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional info for address on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["4. floor"]},"billZip":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP or postal code on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["120 00"]},"billCountryCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-character ISO 3166-1 alpha-2 country code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ"]},"billRegionName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region name on the bil (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Capital city"]},"billRegionShortcut":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region abbreviation on the bil (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CC"]},"vatId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT identification number. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ123456789"]},"taxId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TAX identification number. For Czech address, taxId is same as vatId. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ123456789"]},"companyId":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Company registration number. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["12345678"]},"language":{"type":"string","description":"Language code. Available only if module foreignLanguages is active and initialized.","examples":["cs"]},"email":{"type":["string","null"],"examples":["example@example.com"]},"phone":{"type":["string","null"],"description":"Phone number","examples":["603481066"]},"source":{"type":"object","additionalProperties":false,"description":"proof payments source","required":["id","name"],"properties":{"id":{"type":"integer","description":"source identifier","examples":[1]},"name":{"type":"string","description":"source description","examples":["Administration"]}}},"cashdeskId":{"type":["integer","null"],"description":"cashdesk identifier","examples":[123]},"customerGuid":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"global unique permanent customer identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}]},"customerProfileId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer profile identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[123]},"identificationNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["12345678"],"deprecated":true},"remark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark (not visible for customer) (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["This is a remark"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"variable symbol"},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbolNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"constant symbol (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbolNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific symbol (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"billingMethod":{"description":"information about the method of payment","oneOf":[{"$ref":"#/components/schemas/billingMethod"},{"type":"null"}]},"billBankAccount":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["123456789/1234"]},"billIban":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop IBAN on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ6508000000192000145399"]},"billBic":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank code - SWIFT on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CNBACZPPXXXas"]},"bankAccount":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["123456789/1234"]},"iban":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop IBAN (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ6508000000192000145399"]},"bic":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank code - SWIFT (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CNBACZPPXXXas"]},"documentRemark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark in the document (visible for customer) (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["This is a document remark"]},"invoiceCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linked to invoice code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2017100013"]},"vatBreakdown":{"$ref":"#/components/schemas/proofPaymentVatBreakdown"},"vatMode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT mode, can be null, for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/vat-modes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT modes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["normal"]},"invoicingExchangeRate":{"$ref":"#/components/schemas/typeExchangeRate"}}}},"components/schemas/proofPaymentsForInvoice":{"id":"components/schemas/proofPaymentsForInvoice","kind":"json-schema","title":"proofPaymentsForInvoice","data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","vatBreakdown"],"properties":{"code":{"type":"string","description":"proof payments identifier. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["O-2017000017-01"]},"vatBreakdown":{"$ref":"#/components/schemas/proofPaymentVatBreakdown","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"breakdown of VAT (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}}}}},"components/schemas/proformaInvoiceCodes":{"id":"components/schemas/proformaInvoiceCodes","kind":"json-schema","title":"proformaInvoiceCodes","data":{"type":"array","items":{"type":"string","description":"proforma invoice code","examples":["2015000170"]}}},"components/schemas/quantityDiscount":{"id":"components/schemas/quantityDiscount","kind":"json-schema","title":"quantityDiscount","data":{"type":"object","additionalProperties":false,"required":["id","title","validFrom","validTo","timeUnlimited","customerGroups","displayFlag","flagColor","priority","isActive","status","includeUnregisteredCustomers","targetingLevel","targeting","settings"],"properties":{"id":{"type":"integer","description":"discount ID","examples":[1]},"title":{"type":"string","description":"discount title","examples":["18 + 4 free"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity from","examples":["2014-11-19"]},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity to","examples":["2014-12-19"]},"timeUnlimited":{"type":"boolean","description":"flag whether the discount is time unlimited","examples":[true]},"customerGroups":{"type":["array","null"],"description":"customer groups connected to discount","items":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","description":"customer group code","examples":["retail"]},"name":{"type":"string","description":"customer group name","examples":["Retail customer"]}}}},"displayFlag":{"type":"boolean","description":"whether the flag is displayed","examples":[true]},"flagColor":{"$ref":"#/components/schemas/typeColor","description":"color of the flag"},"priority":{"type":["integer","null"],"description":"priority of the discount","examples":[1]},"isActive":{"type":"boolean","description":"flag whether the discount is active","examples":[true]},"status":{"type":"string","description":"status of the discount","enum":["available","unavailable","expired","planned"],"examples":["available"]},"targetingLevel":{"type":"string","description":"targeting level of the discount","enum":["eshop","product","category","brand"],"examples":["eshop"]},"targeting":{"$ref":"#/components/schemas/quantityDiscountTargetingResponse","description":"definition of products needed to get discount"},"includeUnregisteredCustomers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines if discount is valid for unregistered customers, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"examples":[true]},"settings":{"$ref":"#/components/schemas/quantityDiscountSettingsResponse","description":"settings of the discount"}}}},"components/schemas/quantityDiscountTargetingResponse":{"id":"components/schemas/quantityDiscountTargetingResponse","kind":"json-schema","title":"quantityDiscountTargetingResponse","data":{"type":["object","null"],"required":["productGuids","categoryGuids","brandCodes"],"description":"definition of products needed to get discount","additionalProperties":false,"properties":{"productGuids":{"type":["array","null"],"description":"array of product guids","items":{"type":"string","examples":["356eb81e-d966-11e0-b04f-57a43310b768"]}},"categoryGuids":{"type":["array","null"],"description":"array of page guids (categories)","items":{"type":"string","examples":["07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed"]}},"brandCodes":{"type":["array","null"],"description":"array of brand codes","items":{"type":"string","examples":["brand-1"]}}}}},"components/schemas/quantityDiscountSettingsResponse":{"id":"components/schemas/quantityDiscountSettingsResponse","kind":"json-schema","title":"quantityDiscountSettingsResponse","data":{"type":["array","null"],"description":"settings of the discount","items":{"type":"object","required":["amountFrom","discountType","discountValue"],"additionalProperties":false,"properties":{"amountFrom":{"type":"integer","description":"amount from of products needed to get discount","examples":[2]},"discountType":{"type":"string","description":"type of discount","examples":["percentual"]},"discountValue":{"type":"object","additionalProperties":false,"required":["priceRatio"],"properties":{"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"price ratio of the discount. Calculate as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(100 - percentage) / 100"},"children":[]}]}]}],"examples":[0.85]}}}}}}},"components/schemas/shipmentAddress":{"id":"components/schemas/shipmentAddress","kind":"json-schema","title":"shipmentAddress","data":{"type":"object","additionalProperties":false,"required":["name","countryCode","street","isDefault","type","senderName","contactPerson"],"properties":{"id":{"type":["integer","null"],"description":"carrier address identifier","examples":[1]},"name":{"type":"string","description":"carrier address name","examples":["Usk, a.s."]},"countryCode":{"type":"string","description":"two-character ISO 3166-1 alpha-2 country code","examples":["CZ"]},"street":{"type":"string","description":"address street","examples":["Dlouhá"]},"city":{"type":["string","null"],"description":"address city","examples":["Praha"]},"zipCode":{"type":["string","null"],"description":"address ZIP code","examples":["295 01"]},"houseNumber":{"type":["string","null"],"description":"address house number","examples":["6"]},"contactPhone":{"type":["string","null"],"description":"contact phone","examples":["+420123456789"]},"senderName":{"type":"string","description":"sender name"},"contactPerson":{"type":"string","description":"contact person name"},"contactEmail":{"type":["string","null"],"description":"contact email","examples":["johny@shoptet.cz"]},"isDefault":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if carrier address is set as default, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[true]},"type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of carrier address, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/shipment-carrier-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment carrier types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["core"]}}}},"components/schemas/shipmentCustomer":{"id":"components/schemas/shipmentCustomer","kind":"json-schema","title":"shipmentCustomer","data":{"type":"object","additionalProperties":false,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[DEPRECATED] use recipient. Customer (recipient) info."},"children":[]}]}]}],"properties":{"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer name, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["John Doe"]},"company":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company name, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["Company, Ltd."]},"street":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer street, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["Street 543"]},"city":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer city, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["Prague"]},"zipCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer ZIP code, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["110 00"]},"countryCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-character ISO 3166-1 alpha-2 country code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ"]},"phone":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer phone, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["+420123456789"]},"email":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer email, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["john@example.org"]},"note":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer note, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["some customer note"]}}}},"components/schemas/shipmentSenderRecipientAddress":{"id":"components/schemas/shipmentSenderRecipientAddress","kind":"json-schema","title":"shipmentSenderRecipientAddress","data":{"type":["object","null"],"additionalProperties":false,"description":"Structured sender or recipient address.","properties":{"name":{"type":["string","null"],"description":"Person name. For sender: contact person at the dispatch location. For recipient: customer's full name.","examples":["John Doe"]},"company":{"type":["string","null"],"description":"Organization name. For sender: name printed on the shipping label. For recipient: customer's company (null for private persons).","examples":["Doe Company"]},"street":{"type":["string","null"],"examples":["Green Line 54"]},"city":{"type":["string","null"],"examples":["London"]},"zip":{"type":["string","null"],"examples":["ABC123"]},"countryCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-character ISO 3166-1 alpha-2 country code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ"]},"phone":{"type":["string","null"],"examples":["+420123456789"]},"email":{"type":["string","null"],"examples":["doe@company.com"]}}}},"components/schemas/shipmentPrice":{"id":"components/schemas/shipmentPrice","kind":"json-schema","title":"shipmentPrice","data":{"type":"object","additionalProperties":false,"required":["value","currencyCode"],"properties":{"value":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipment value, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["1000.00"]},"currencyCode":{"type":"string","description":"currency code","examples":["CZK"]}}}},"components/schemas/shipmentCoDPrice":{"id":"components/schemas/shipmentCoDPrice","kind":"json-schema","title":"shipmentCoDPrice","data":{"type":["object","null"],"additionalProperties":false,"required":["value","currencyCode"],"properties":{"value":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the max limit of COD, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["1000.00"]},"currencyCode":{"type":"string","description":"currency code","examples":["CZK"]}}}},"components/schemas/shipmentPackage":{"id":"components/schemas/shipmentPackage","kind":"json-schema","title":"shipmentPackage","data":{"type":"object","additionalProperties":false,"properties":{"width":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package width, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[30]},"height":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package height, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[20]},"depth":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package depth, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[10]},"weight":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package weight, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[1]},"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of shipment package, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["Custom packaging"]},"packagingId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package identifier, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[468]},"labelUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the package label, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["https://www.example.org/label"]},"labelZpl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"label ZPL content, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["^XA^FO50,50^ADN,36,20^FDHello World^FS^XZ"]},"trackingNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tracking number, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["NR0001462551Y"]},"trackingUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tracking URL, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["https://www.balikovna.cz/cs/sledovat-balik/-/balik/NR0001462551Y"]}}}},"components/schemas/shipmentPackageWithHistory":{"id":"components/schemas/shipmentPackageWithHistory","kind":"json-schema","title":"shipmentPackageWithHistory","data":{"type":"object","additionalProperties":false,"required":["history"],"properties":{"width":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package width, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[30]},"height":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package height, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[20]},"depth":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package depth, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[10]},"weight":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package weight, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[1]},"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of shipment package, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["Custom packaging"]},"packagingId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package identifier, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[468]},"labelUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the package label, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["https://www.example.org/label"]},"labelZpl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"label ZPL content, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["^XA^FO50,50^ADN,36,20^FDHello World^FS^XZ"]},"trackingNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tracking number, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["NR0001462551Y"]},"trackingUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tracking URL, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["https://www.balikovna.cz/cs/sledovat-balik/-/balik/NR0001462551Y"]},"history":{"type":"array","description":"shipment history","items":{"$ref":"#/components/schemas/shipmentHistory"}}}}},"components/schemas/shipmentHistory":{"id":"components/schemas/shipmentHistory","kind":"json-schema","title":"shipmentHistory","data":{"type":"object","additionalProperties":false,"required":["fromStatus","toStatus","realDatetime","providerDatetime","note"],"properties":{"fromStatus":{"type":"string","description":"status before change","examples":["created"]},"toStatus":{"type":"string","description":"status after change","examples":["in_transit"]},"realDatetime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"real date and time"},"providerDatetime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"provider date and time"},"note":{"type":"string","description":"shipment history note","examples":["Shipment is in Depo AB 1"]}}}},"components/schemas/shipmentCarrierCountry":{"id":"components/schemas/shipmentCarrierCountry","kind":"json-schema","title":"shipmentCarrierCountry","data":{"type":"object","additionalProperties":false,"required":["countryCode","maxCod","codCurrencyCode","maxWeight"],"properties":{"countryCode":{"type":"string","description":"two-character ISO 3166-1 alpha-2 country code","examples":["CZ"]},"maxCod":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the max limit of COD, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},"codCurrencyCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currency code of COD, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["CZK"]},"maxWeight":{"type":"integer","description":"max weight of shipment","examples":[31]}}}},"components/schemas/onlineStoreCountry":{"id":"components/schemas/onlineStoreCountry","kind":"json-schema","title":"onlineStoreCountry","data":{"type":["object","null"],"additionalProperties":false,"required":["id","name","code","codeAlpha3"],"properties":{"id":{"type":"integer","description":"Country identifier.","examples":[1]},"name":{"type":"string","description":"Country name.","examples":["Česká republika"]},"code":{"type":"string","description":"Country code.","examples":["CZ"]},"isoCode":{"type":"string","description":"Country ISO code.","examples":["CZ"]},"flagCode":{"type":"string","description":"Country flag code.","examples":["CZ"]},"codeAlpha3":{"type":"string","description":"Country alpha-3 code.","examples":["CZE"]},"currency":{"type":["string","null"],"description":"Country currency.","examples":["CZK"]},"language":{"type":["string","null"],"description":"Country language.","examples":["cs"]},"regionCount":{"type":"integer","description":"Region count of country.","examples":[0]}}}},"components/schemas/salesChannel":{"id":"components/schemas/salesChannel","kind":"json-schema","title":"salesChannel","data":{"type":["object","null"],"required":["guid","name","type","currencies","languages","createdAt","updatedAt"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Sales channel GUID."},"name":{"type":"string","description":"Sales channel name.","examples":["My sales channel"]},"type":{"enum":["in_store","market","marketplace"],"description":"Type of sales channel.","examples":["in_store"]},"defaultCurrency":{"type":"string","description":"Sales channel default currency.","examples":["CZK"]},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/salesChannelCurrency"},"description":"Currencies collection."},"defaultLanguage":{"type":"string","description":"Sales channel default language.","examples":["Czech"]},"languages":{"type":"array","items":{"$ref":"#/components/schemas/salesChannelLanguage"},"description":"Languages collection."},"createdAt":{"$ref":"#/components/schemas/typeDateTime"},"updatedAt":{"$ref":"#/components/schemas/typeDateTimeNullable"}}}},"components/schemas/onlineStoreDesign":{"id":"components/schemas/onlineStoreDesign","kind":"json-schema","title":"onlineStoreDesign","data":{"type":"object","required":["header"],"properties":{"header":{"type":"object","additionalProperties":false,"required":["logoUrl"],"properties":{"logoUrl":{"type":["string","null"],"description":"URL of online store logo.","examples":["https://dummy.myshoptet.com/user/logos/shoptet-logo.png"]}}}}}},"components/schemas/onlineStore":{"id":"components/schemas/onlineStore","kind":"json-schema","title":"onlineStore","data":{"type":"object","additionalProperties":false,"required":["id","status","isPasswordProtected","isPrimary"],"properties":{"id":{"type":"integer","description":"Online store identifier.","examples":[1]},"name":{"type":"string","description":"Name of online store.","examples":["Czech republic"]},"status":{"type":"string","description":"Online store status","enum":["active","pending"],"examples":["active"]},"domain":{"type":["string"],"description":"Online store domain.","examples":["store.example.com"]},"domainSetupMethod":{"type":["string","null"],"description":"Online store domain setup method.","examples":["unresolved"]},"addressFormat":{"type":"string","description":"Address format of online store.","examples":["INTERNAL_PROJECT_CZ"]},"timezone":{"type":"string","description":"Timezone of online store.","examples":["Europe/Prague"]},"defaultCountry":{"$ref":"#/components/schemas/onlineStoreCountry","description":"Default country of online store."},"countries":{"type":"array","description":"Countries of online store.","items":{"$ref":"#/components/schemas/onlineStoreCountry"}},"salesChannel":{"$ref":"#/components/schemas/salesChannel","description":"Online store sales channel."},"isPasswordProtected":{"type":"boolean","description":"Whether the online store is protected by password.","examples":[false]},"isPrimary":{"type":"boolean","description":"Whether the online store is primary.","examples":[true]},"design":{"$ref":"#/components/schemas/onlineStoreDesign","description":"Online store design."}}}},"components/schemas/articleUrls":{"id":"components/schemas/articleUrls","kind":"json-schema","title":"articleUrls","data":{"type":"object","additionalProperties":false,"required":["sectionId","url"],"properties":{"sectionId":{"type":"integer","description":"article section ID","examples":[682]},"url":{"type":"string","description":"article URL","examples":["https://www.some-eshop-url.com/blog/new-article"]}}}},"components/schemas/discountCoupon":{"id":"components/schemas/discountCoupon","kind":"json-schema","title":"discountCoupon","data":{"type":"object","additionalProperties":false,"required":["code","creationTime","discountType","amount","ratio","minPrice","currency","template","shippingPrice","validFrom","validTo","reusable","usedCount","remark"],"properties":{"code":{"type":"string","description":"code of discount coupon","examples":["DC14585431"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time, when the discount coupon was created"},"discountType":{"type":"string","enum":["percentual","fixed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of discount. Percentual ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or absolute discount ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["percentual"]},"amount":{"$ref":"#/components/schemas/typePriceNullable","description":"amount of absolute discount (default eshop VAT rate is used)"},"ratio":{"oneOf":[{"$ref":"#/components/schemas/typePriceRatio"},{"type":"null"}],"description":"amount of percentual discount"},"minPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"minimum price of order (default eshop VAT rate is used)"},"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable","description":"currency of fixed discount."},"template":{"$ref":"#/components/schemas/typeGuid","description":"template used for the discount coupon creation."},"shippingPrice":{"type":["string","null"],"enum":["cart","free","beforeDiscount",null],"description":"how the transport prices are calculated: according to the cart before discounts (beforeDiscount), according to the displayed value of the cart (cart), or free (free)","examples":["cart"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"starting date of coupon validity"},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"ending date of coupon validity"},"reusable":{"type":"boolean","description":"Is the discount coupon reusable?","examples":[true]},"usedCount":{"type":"integer","description":"number of times the discount coupon has been used","examples":[0]},"remark":{"type":["string","null"],"description":"remark for the discount coupon.","examples":["Note: This is a test discount coupon"]}}}},"components/schemas/order":{"id":"components/schemas/order","kind":"json-schema","title":"order","data":{"type":"object","additionalProperties":false,"required":["code","guid","externalCode","creationTime","changeTime","email","phone","clientIPAddress","customerGuid","vatPayer","cashDeskOrder","stockId","addressesEqual","billingMethod","paymentMethod","shipping","adminUrl","status","price","paid","billingAddress","deliveryAddress","items"],"properties":{"code":{"type":"string","description":"order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2017000092"]},"guid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"global unique permanent order identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for old orders)"},"children":[]}]}]}],"examples":["c5012051-d7ca-11e0-9a5c-feab5ed617ed"]},"externalCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of the order in external system (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["1234"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time, when the order was created. ISO 8601 format."},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of the order's last change. ISO 8601 format."},"email":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchaser e-mail (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["customer@someemail.com"]},"phone":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchaser phone number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["+420604600444"]},"birthDate":{"type":["string","null"],"description":"customer's date of birth stated in the order","examples":["1980-01-01"]},"clientIPAddress":{"type":["string","null"],"description":"IP address of the client who made the order","examples":["213.46.237.24"]},"customerGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer identifier, if the customer is registered in the e-shop (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"cashDeskOrder":{"type":"boolean","description":"flag, whether the order is from the cash desk (as opposed to the e-shop)","examples":[true]},"stockId":{"type":"integer","description":"identifier of the stock, from which the order was taken","examples":[1]},"addressesEqual":{"type":"boolean","description":"flag, whether the delivery address is the same as the invoicing address","examples":[true]},"vatPayer":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is the tradesman a VAT payer, when purchasing? (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if this is unknown)"},"children":[]}]}]}],"examples":[true]},"vatMode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT mode, for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/vat-modes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT modes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["Normal"]},"billingMethod":{"oneOf":[{"$ref":"#/components/schemas/billingMethod"},{"type":"null"}]},"paymentMethod":{"oneOf":[{"$ref":"#/components/schemas/paymentMethod"},{"type":"null"}]},"shipping":{"$ref":"#/components/schemas/shipping"},"shippingDetails":{"type":["object","null"],"additionalProperties":false,"required":["branchId","shippingCompanyCode","name","note","place","street","city","zipCode","countryCode","link","latitude","longitude","carrierId"],"properties":{"branchId":{"type":["string","null"],"description":"branch identifier","examples":["4"]},"shippingCompanyCode":{"type":["string","null"],"description":"identification of the carrier","examples":["zasilkovna"]},"shippingServiceCode":{"type":["string","null"],"description":"identification of the carrier's service","examples":["zasilkovna-pickup"]},"name":{"type":["string","null"],"description":"name of the branch","examples":["Hradec Králové, Square of 5th May 888"]},"note":{"type":["string","null"],"description":"branch location note, can contain HTML","examples":["

Open: Mon-Fri 8:00-18:00, Sat 8:00-12:00

"]},"place":{"type":["string","null"],"description":"location (specify location within address).","examples":["Creator"]},"street":{"type":["string","null"],"description":"street","examples":["Square of 5th May 888"]},"city":{"type":["string","null"],"description":"city/town","examples":["Hradec Králové"]},"zipCode":{"type":["string","null"],"description":"ZIP or postal code","examples":["50002"]},"countryCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-character ISO 3166-1 alpha-2 country code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ"]},"link":{"type":["string","null"],"description":"link to the branch's website","examples":["https://www.ulozenka.cz/pobocky/4/hradec-kralove-nam-5-kvetna-888"]},"latitude":{"type":["string","null"],"description":"GPS coordinates - north latitude","examples":["50.213673"]},"longitude":{"type":["string","null"],"description":"GPS coordinates - east longitude","examples":["15.832775"]},"carrierId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identification of the carrier - now it's used for Zasilkovna only. The value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Czech Zasilkovna or carrier ID for Zasilkovna in the other countries."},"children":[]}]}]}],"examples":[3060]}}},"adminUrl":{"type":"string","description":"URL to administration leading to order detail. URL keeps the administration language settings.","examples":["https://www.domena-eshopu.cz/admin/objednavky-detail?id=2"]},"status":{"type":["object","null"],"additionalProperties":false,"required":["name","id"],"properties":{"name":{"type":["string","null"],"description":"status name","examples":["Processing"]},"id":{"type":"integer","description":"status identifier","examples":[-1]}}},"source":{"type":["object","null"],"additionalProperties":false,"required":["name","id"],"description":"source of the order","properties":{"name":{"type":["string","null"],"description":"source name","examples":["E-Shop"]},"id":{"type":"integer","description":"DEPRECATED source identifier","examples":[-1]}}},"salesChannelGuid":{"$ref":"#/components/schemas/typeGuidNullable","description":"sales channel guid"},"price":{"$ref":"#/components/schemas/price","description":"price of the order"},"paid":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, whether the order was paid. In addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", can also be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if the payment status is unknown."},"children":[]}]}]}],"examples":[true]},"billingAddress":{"$ref":"#/components/schemas/billingAddress"},"deliveryAddress":{"$ref":"#/components/schemas/address"},"onlinePaymentLink":{"type":["string","null"],"description":"URL to online payment","examples":["https://www.domena-eshopu.cz/api/pay/payu/redir?paymentCode=xyz123"]},"language":{"type":"string","description":"Language code of the order. Available only if module foreignLanguages is active and initialized.","examples":["cs"]},"referer":{"type":["string","null"],"description":"which page (url) has the user come from","examples":["https://www.google.cz/"]},"paymentMethods":{"type":"array","description":"all order payment methods","items":{"type":"object","additionalProperties":false,"required":["paymentMethod","itemId"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/paymentMethod"},"itemId":{"type":"integer","description":"payment method identifier within order","examples":[564]}}}},"shippings":{"type":"array","description":"all order shippings","items":{"type":"object","additionalProperties":false,"required":["shipping","itemId"],"properties":{"shipping":{"type":"object","additionalProperties":false,"required":["guid","name"],"description":"transport method","properties":{"guid":{"$ref":"#/components/schemas/typeGuidNullable","description":"transport method identifier"},"name":{"type":"string","description":"description of transport method","examples":["PPL"]}}},"itemId":{"type":"integer","description":"transport method identifier within order","examples":[897]}}}},"items":{"type":"array","description":"all order items","items":{"$ref":"#/components/schemas/orderItem"}},"notes":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order notes (only filled in on request if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=notes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is listed)"},"children":[]}]}]}],"required":["customerRemark","eshopRemark","trackingNumber","trackingUrl","additionalFields"],"properties":{"customerRemark":{"type":["string","null"],"description":"customer note","examples":["Better in green"]},"eshopRemark":{"type":["string","null"],"description":"e-shop order remark.","examples":["Gift wrapping"]},"trackingNumber":{"type":["string","null"],"description":"shipment number","examples":["DR123456"]},"trackingUrl":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package trace link (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["http://www.ppl.cz/main2.aspx?cls=Package&idSearch=DR123456"]},"additionalFields":{"type":"array","description":"can contain up to six additional fields, which can be freely used by e-shop for its individual needs.","items":{"type":"object","additionalProperties":false,"required":["index","label","text"],"properties":{"index":{"type":"integer","description":"sequence number","examples":[1]},"label":{"type":"string","description":"item name. The name of the field can be edited in the e-shop administration.","examples":["1st field"]},"text":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item value (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["forwarder ID"]}}}}}},"preAuthorization":{"$ref":"#/components/schemas/orderPreAuthorization"},"completion":{"type":"array","description":"All order items completion status. Contains completion info even for product set items.","items":{"type":"object","additionalProperties":false,"required":["productGuid","code","itemType","name","amount","amountUnit","itemId","amountCompleted"],"properties":{"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}]},"code":{"type":["string","null"],"description":"identifier of the item code (product or variant). At the time the order is created, it will be entered in this field, but when the product is deleted, the link will be lost.","examples":["40/ZEL"]},"itemType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item type (product, service...). See also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/types-of-order-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of order items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["product"]},"name":{"type":"string","description":"Product name","examples":["Complete"]},"variantName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variant name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Name"]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"product quantity","examples":[1]},"amountUnit":{"type":["string","null"],"description":"product unit of quantity","examples":["ks"]},"itemId":{"type":["integer","null"],"description":"Order item identifier. This field is null for product set items.","examples":[342]},"amountCompleted":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"quantity of completed product","examples":[1]},"parentProductSetItemId":{"type":"integer","description":"identifier of the parent product set item, if the item is a product set item. If the item is not a product set item, this field is not present.","examples":[123]}}}},"paymentTransactions":{"type":"array","description":"all order payment transactions","items":{"type":"object","additionalProperties":false,"required":["transactionId","price","status","creationTime","changeTime"],"properties":{"transactionId":{"type":["string"],"description":"payment transaction identifier","examples":["018myestp7sjopi9zs5obatbhwcor33e"]},"price":{"$ref":"#/components/schemas/typePrice","description":"payment transaction price"},"status":{"type":"string","description":"status of the payment transaction","examples":["OK","NEW","FAILED","PENDING","UNKNOWN"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"payment transaction creation date and time"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"payment transaction last change date and time"}}}}}}},"components/schemas/orderCreate":{"id":"components/schemas/orderCreate","kind":"json-schema","title":"orderCreate","data":{"type":"object","additionalProperties":false,"required":["externalCode","currency"],"properties":{"creationTime":{"type":"string","description":"time of order creation. Optional, current time is the default value.","examples":["2018-01-21T14:15:47+0100"]},"code":{"type":"string","minLength":1,"maxLength":10,"description":"Unique identifier for an e-shop order. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2024-123"]},"language":{"type":"string","minLength":1,"description":"Language of order. Available only if module foreignLanguages is active and initialized.","examples":["cs"]},"externalCode":{"type":"string","minLength":1,"maxLength":255,"description":"order identification within the external system (mandatory, must be unique).","examples":["X123"]},"cashDeskOrder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, if the order was created via the cash desk. Optional. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the default value."},"children":[]}]}]}]},"statusId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status. Optional. If not indicated, the default status of the order is used, as per e-shop settings. If the status definition sets the payment flag, the parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". if the request also mentions "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variant has priority. If the status definition has selected the setting of item statuses, the status is also set for items. Otherwise, the initial status is the set based on e-shop defaults. If the item has status set explicitly (see below "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items[].statusId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the value from the item shall be used."},"children":[]}]}]}],"examples":[-1]},"sourceId":{"type":["integer","null"],"examples":[-1],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order source id. Optional. If not indicated, no source will be used (null). If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is positive, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashDeskOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is negative, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashDeskOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise error will be returned. Current possible values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be determined by calling the list of order sources endpoint, but marketplace sources are not supported for order creation."},"children":[]}]}]}]},"salesChannelGuid":{"$ref":"#/components/schemas/typeGuidNullable","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales channel GUID. Requires active module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sales Channel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional. Sales channels of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"marketplace"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not supported for order creation."},"children":[]}]}]}],"examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]},"email":{"type":"string","minLength":1,"maxLength":100,"description":"customer e-mail (can be omitted only when ordering via cash desk).","examples":["foo@bar.cz"]},"phone":{"type":["string","null"],"minLength":1,"maxLength":32,"description":"phone number of the customer. Optional, if not set as mandatory item in shop settings.","examples":["+420123456789"]},"birthDate":{"type":["string","null"],"description":"customer birth date (optional, if not made mandatory by the e-shop settings).","examples":["1990-01-01"]},"vatPayer":{"type":"boolean","examples":[true],"description":"Flag, whether the invoice was issued in VAT payer mode, or VAT non-payer mode. Optional, if not indicated, it is used as per current settings of the e-shop (only makes sense for historical orders, if e-shop changed its status form VAT payer to different or vice versa)"},"paymentMethodGuid":{"$ref":"#/components/schemas/typeGuidNullable","minLength":1,"description":"Payment method. Optional, for an order via cash desk or eshop order. Does not automatically generate payment item in the list of items, and does not check the consistency with payment item. Billing item type is mandatory if paymentMethodGuid is filled.","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]},"shippingGuid":{"$ref":"#/components/schemas/typeGuidNullable","minLength":1,"description":"Transport method. Optional, for an order via cash desk or eshop order. Does not automatically generate transport item in the list of items, and does not check the consistency with the transport item. Shipping item type is mandatory if shippingGuid is filled.","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]},"shippingDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional information for transport, if any. typically ID of Zásilkovna branches, postal offices, etc. (optional)"},"children":[]}]}]}],"oneOf":[{"type":"null"},{"type":"object","additionalProperties":false,"required":["branchId"],"properties":{"branchId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"branch ID, if delivered to Uloženka branch, DPD, etc."},"children":[]}]}]}],"examples":["45"]},"branchName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"branch name, if delivered to Uloženka branch, DPD, etc."},"children":[]}]}]}],"examples":["Test branch"]},"carrierId":{"type":"integer","description":"CarrierId, use only for Zasilkovna/Packeta, use their carrierID.","examples":[3060]}}}]},"paid":{"type":["boolean","null"],"description":"flag, whether the order was paid","examples":[true]},"billingMethodCode":{"type":"integer","minimum":1,"maximum":4,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing method identifier - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Optional."},"children":[]}]}]}],"examples":[2]},"clientIPAddress":{"type":["string","null"],"maxLength":255,"description":"IP address of the customer, from where the order was made","examples":["62.128.123.12"]},"customerGuid":{"$ref":"#/components/schemas/typeGuidNullable","minLength":1,"description":"Customer GUID, if not done under known registered customer (optional)."},"billingAddress":{"type":"object","additionalProperties":false,"description":"invoicing address","required":["countryCode"],"properties":{"company":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"company name. Optional, if not set as mandatory item in shop settings.","examples":["Smith & Smith"]},"fullName":{"type":["string","null"],"maxLength":255,"description":"customer name. Optional, if not set as mandatory item in shop settings.","examples":["John Doe"]},"street":{"type":["string","null"],"maxLength":255,"description":"(string, optional) - street of the customer. Optional, if not set as mandatory item in shop settings.","examples":["Main Street"]},"streetWithNr":{"type":["string","null"],"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street, including street number. Optional, if necessary, to be divided to street and street number and saved in respective fields. Use if you only have the combined data. Usually, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"street"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"houseNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not be needed (if they are used, however, they have priority)."},"children":[]}]}]}],"examples":["Main Street 123"]},"houseNumber":{"type":["string","null"],"maxLength":255,"description":"street number. Optional, if not set as mandatory item in shop settings.","examples":["123"]},"city":{"type":["string","null"],"maxLength":255,"description":"City/Town. Optional, if not set as mandatory item in shop settings.","examples":["Flat Country"]},"district":{"type":["string","null"],"maxLength":255,"description":"County. Optional, if not set as mandatory item in shop settings.","examples":["Bohemia"]},"additional":{"type":["string","null"],"maxLength":255,"description":"Additional information for the address. Optional.","examples":["3rd floor"]},"zip":{"type":["string","null"],"maxLength":255,"description":"ZIP or postal code. Optional, if not set as mandatory item in shop settings.","examples":["123 00"]},"countryCode":{"type":"string","minLength":1,"description":"two-character ISO 3166-1 alpha-2 country code","examples":["CZ"]},"regionName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"region. Optional.","examples":["Central Bohemia"]},"regionShortcut":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"region abbreviation. Optional.","examples":["SC"]},"companyId":{"type":["string","null"],"minLength":1,"maxLength":18,"description":"Company registration number of the customer, if purchasing as a company. Optional.","examples":["123456"]},"vatId":{"type":["string","null"],"minLength":1,"maxLength":16,"description":"VAT identification number of the customer, if purchasing on the company.","examples":["CZ123456"]},"taxId":{"type":["string","null"],"minLength":1,"maxLength":16,"description":"TAX identification number of the customer, if purchasing on the company. For Czech address, taxId must be the same as vatId, or left empty. Optional.","examples":["CZ123456"]}}},"addressesEqual":{"type":["boolean","null"],"description":"flag, whether the billing and delivery addresses are the same","default":true,"examples":[true]},"deliveryAddress":{"oneOf":[{"type":"null"},{"type":"object","additionalProperties":false,"properties":{"company":{"type":["string","null"],"maxLength":255,"description":"company name. Optional, if not set as mandatory item in shop settings.","examples":["Smith & Smith"]},"fullName":{"type":["string","null"],"maxLength":255,"description":"customer name. Optional, if not set as mandatory item in shop settings.","examples":["John Doe"]},"street":{"type":["string","null"],"maxLength":255,"description":"(string, optional) - street for delivery. Optional, if not set as mandatory item in shop settings.","examples":["Main Street"]},"streetWithNr":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street, including street number. Optional, if necessary, to be divided to street and street number and saved in the respective fields. Use if you only have the combined data. Usually, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"street"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"houseNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not be needed (if they are used, however, they have priority)."},"children":[]}]}]}],"examples":["Main Street 123"]},"houseNumber":{"type":["string","null"],"maxLength":255,"description":"street number. Optional, if not set as mandatory item in shop settings.","examples":["123"]},"city":{"type":["string","null"],"maxLength":255,"description":"City/Town. Optional, if not set as mandatory item in shop settings.","examples":["Flat Country"]},"district":{"type":["string","null"],"maxLength":255,"description":"County. Optional, if not set as mandatory item in shop settings.","examples":["Bohemia"]},"additional":{"type":["string","null"],"maxLength":255,"description":"Additional information for the address. Optional.","examples":["3rd floor"]},"zip":{"type":["string","null"],"maxLength":255,"description":"ZIP or postal code. Optional, if not set as mandatory item in shop settings.","examples":["123 00"]},"countryCode":{"type":["string"],"description":"two-character ISO 3166-1 alpha-2 country code","examples":["CZ"]},"regionName":{"type":["string","null"],"maxLength":255,"description":"region. Optional.","examples":["Central Bohemia"]},"regionShortcut":{"type":["string","null"],"maxLength":255,"description":"region abbreviation. Optional.","examples":["SC"]}}}]},"notes":{"description":"additional notes for the order","oneOf":[{"type":"null"},{"type":"object","additionalProperties":false,"properties":{"customerRemark":{"type":["string","null"],"description":"Remark of customer. Optional.","examples":["Please deliver in the morning."]},"eshopRemark":{"type":["string","null"],"description":"remark of e-shop (not visible for customer). Optional.","examples":["Order from the cash desk"]},"trackingNumber":{"type":["string","null"],"maxLength":32,"description":"tracking number of the shipment.","examples":["TR123345"]},"additionalFields":{"type":"array","minItems":1,"description":"additional optional fields (maximum 6).","items":{"type":"object","additionalProperties":false,"required":["index","text"],"properties":{"index":{"type":"integer","minimum":1,"maximum":6,"description":"number of optional field (1-6). Mandatory.","examples":[1]},"text":{"type":"string","description":"remark text. Mandatory","examples":["Processed by Doe"]}}}}}}]},"stockId":{"type":"integer","description":"stock number. Optional, the default value is the default stock, taken from e-shop settings. In Shoptet, the only alternative to the default stock is to collect in person at the shop, otherwise the default stock is used.","examples":[1]},"currency":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"$ref":"#/components/schemas/typeCurrencyCode","description":"currency abbreviation. Mandatory.","examples":["CZK"]},"exchangeRate":{"type":["string","null"],"pattern":"^[0-9]+\\.[0-9]{2,8}$","description":"exchange rate for main e-shop currency.","examples":["1.0000"]}}},"vatMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT mode, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Normal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used by default, possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Normal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"One Stop Shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reverse charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outside the EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Please note, that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"One Stop Shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value requires eshop "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OSS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["Normal"]},"items":{"type":"array","minItems":1,"description":"order items. The order must have at least one product item","items":{"type":"object","additionalProperties":false,"required":["itemType","vatRate"],"properties":{"itemType":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item type. Mandatory field. See also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/types-of-order-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of order items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item type is min required. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type is present paymentMethodGuid must be provided. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type is present shippingGuid must be provided."},"children":[]}]}]}],"examples":["product"]},"name":{"type":"string","maxLength":250,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product name (optional, but usually filled in). Mandatory only for transport and payment, for other items, it is loaded according to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["Large chocolate"]},"variantName":{"type":"string","maxLength":128,"description":"Product variant name.","examples":["Dark chocolate"]},"brand":{"type":"string","maxLength":64,"description":"brand (manufacturer). Optional.","examples":["Willy Wonka"]},"supplierName":{"type":"string","maxLength":255,"description":"supplier name.","examples":["Dodavatel s.r.o."]},"productGuid":{"$ref":"#/components/schemas/typeGuid","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product GUID in item. When used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?suppressProductChecking=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, this field has no influence."},"children":[]}]}]}]},"code":{"type":["string","null"],"maxLength":64,"examples":["123-456"]},"remark":{"type":"string","description":"remark for the item. Optional.","examples":["With cubicles"]},"warrantyDescription":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"textual description of warranty length (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2 years"]},"amountCompleted":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"quantity of completed product"},"additionalField":{"type":["string","null"],"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional information. Used for transport to specify the branch (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["TO BALÍKOVNA, Karlínské náměstí 145/1, Karlín, 18600, Prague"]},"amount":{"type":"string","pattern":"^[0-9]+\\.?[0-9]{0,3}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount, 3 decimal places accuracy, optional, default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["1.000"]},"amountUnit":{"type":"string","minLength":1,"maxLength":16,"description":"unit of quantity (optional)","examples":["ks"]},"weight":{"type":"string","description":"product weight in kilograms. Maximum 3 decimal places, and maximum value of 99999.","examples":["100"]},"priceRatio":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount in the form of coefficient (0.7 = 70 % of the original price, i.e. 30 % discount). Optional, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]}]}]}],"examples":["0.7"]},"vatRate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for VAT non-payers). Mandatory."},"children":[]}]}]}],"examples":["21.00"]},"itemPriceWithVat":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price including VAT. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"],"deprecated":true},"itemPriceWithoutVat":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price excluding VAT. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"],"deprecated":true},"unitPriceWithVat":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price including VAT. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"]},"unitPriceWithoutVat":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price excluding VAT. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"]},"buyPriceWithVat":{"type":["string","null"],"description":"Purchase price, including VAT. Price including tax and price excluding tax cannot be combined. This is used for profit margin calculation and statistics.","examples":["121.00"]},"buyPriceWithoutVat":{"type":["string","null"],"description":"Purchase price, excluding VAT. Optional. Price including tax and price excluding tax cannot be combined. This is used for profit margin calculation and statistics.","examples":["100.00"]},"buyPriceVatRate":{"type":["string","null"],"description":"VAT rate for purchase price.","examples":["21.00"]},"statusId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item status. Optional, if not indicated, default value is guided by the order status. If the order status was indicated and this status has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Change status of items in the order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set, then the item will have this status. Otherwise the default status of the e-shop is used."},"children":[]}]}]}],"examples":[-1]},"recyclingFeeId":{"type":["integer","null"],"description":"ID of the recycling fee.","examples":[2]},"surchargeParameters":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["parameterCode","valueIndex"],"properties":{"parameterCode":{"type":"string","minLength":1,"examples":["surchargeCode"]},"valueIndex":{"type":"string","minLength":1,"examples":["high"]},"price":{"$ref":"#/components/schemas/typePrice"}}}},"consumptionTaxId":{"$ref":"#/components/schemas/consumptionTaxId"}}}}}}},"components/schemas/orderHistory":{"id":"components/schemas/orderHistory","kind":"json-schema","title":"orderHistory","data":{"type":"object","additionalProperties":false,"required":["id","creationTime","text","user","system","type"],"properties":{"id":{"type":"integer","description":"order history identifier","examples":[1]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Creation time of the order history record."},"text":{"type":"string","description":"Transaction Id at payment gateway side: GHJ36","examples":["Transaction Id at payment gateway side: GHJ36KHDHDUJDL"]},"user":{"type":["object","null"],"additionalProperties":false,"description":"the user or system process that caused the change","required":["id","name"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identification of change originator, either user’s e-mail, or system process identifier"},"children":[]}]}]}],"examples":["api.service-21@fenix.myshoptet.com"]},"name":{"type":"string","description":"the user name or description of the system service that caused the change","examples":["stock monitoring addon"]}}},"system":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, whether the remark is entered by Shoptet ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), by user, or by API ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"system: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[true]},"type":{"type":"string","enum":["comment","system"],"description":"Record type","examples":["comment","system"]}}}},"components/schemas/orderPreAuthorization":{"id":"components/schemas/orderPreAuthorization","kind":"json-schema","title":"orderPreAuthorization","data":{"type":["object"],"required":["hasPendingPreAuthorization","preAuthorizationAmount"],"additionalProperties":false,"properties":{"hasPendingPreAuthorization":{"type":"boolean"},"preAuthorizationAmount":{"$ref":"#/components/schemas/typePrice","description":"pre-authorization amount of the order. If null, the order is not pre-authorized. If not present, pre-authorization is not supported."}}}},"components/schemas/customer":{"id":"components/schemas/customer","kind":"json-schema","title":"customer","data":{"type":"object","required":["guid","billingAddress","deliveryAddress","creationTime","customerGroup","priceList","remark","priceRatio","birthDate","disabledOrders","accounts","remarks","changeTime","adminUrl"],"additionalProperties":false,"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"Customer GUID"},"billingAddress":{"$ref":"#/components/schemas/billingAddress","description":"invoicing address"},"deliveryAddress":{"type":"array","description":"delivery addresses","items":{"$ref":"#/components/schemas/deliveryAddressCustomer"}},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"registration date"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of last change"},"customerGroup":{"type":["object","null"],"required":["id","name"],"description":"group of customers","properties":{"id":{"type":"integer","description":"customer group ID","examples":[1]},"name":{"type":"string","description":"customer group name","examples":["VIP"]}}},"priceList":{"oneOf":[{"$ref":"#/components/schemas/pricelist"},{"type":"null"}],"description":"inclusion into the price list"},"remark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark for the customer (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["customer is very nice"]},"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional discount - 0.7800 = discount 22%; 1.0000 = no discount"},"children":[]}]}]}]},"birthDate":{"$ref":"#/components/schemas/typeDateNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date of birth. In YYYY-MM-DD format. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"accounts":{"type":"array","description":"customer login accounts","items":{"type":"object","additionalProperties":false,"required":["guid","fullName","email","phone","mainAccount","authorized","emailVerified"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"customer account identifier"},"fullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Doe"]},"email":{"type":"string","description":"email address","examples":["john@example.com"]},"phone":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["+420777888999"]},"mainAccount":{"type":"boolean","description":"Is this the main account?","examples":[true]},"authorized":{"type":"boolean","description":"Is the account authorized? Default: true","examples":[true]},"emailVerified":{"type":"boolean","description":"Is the email verified by eshop owner? Needed for pairing orders created in past. Default: false","examples":[true]}}}},"disabledOrders":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordering disabled? If so, newly created orders will be cancelled automatically. Dependent on the addition of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" customerReviews"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If e-shop does not have an option active, the answer will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[false]},"remarks":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer notes and ratings, dependent on addon "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerReviews"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If e-shop does not have an option active, the answer will be blank."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"required":["id","remark","rating"],"properties":{"id":{"type":"integer","description":"uniq identification number","examples":[1]},"remark":{"type":"string","description":"note","examples":["customer is very nice"]},"rating":{"type":"string","description":"type of rating","examples":["positive"]}}}},"adminUrl":{"type":"string","description":"link to the customer details in administration","examples":["https://www.domena-eshopu.cz/admin/zakaznici-detail?id=16"]}}}},"components/schemas/deliveryNote":{"id":"components/schemas/deliveryNote","kind":"json-schema","title":"deliveryNote","data":{"type":"object","additionalProperties":false,"required":["code","isValid","orderCode","creationTime","changeTime","billingAddress","deliveryAddress","addressesEqual","customer","items","documentRemark"],"properties":{"code":{"type":"string","description":"variant code (product)","examples":["00000018"]},"isValid":{"type":"boolean","description":"Is the delivery note valid?","examples":[true]},"orderCode":{"type":["string","null"],"description":"purchase order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2017000090"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of issue, in ISO 8601 format"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of last change, in ISO 8601 format"},"billingAddress":{"$ref":"#/components/schemas/billingAddress","description":"invoicing address"},"deliveryAddress":{"$ref":"#/components/schemas/address"},"addressesEqual":{"type":"boolean","description":"Are the billing and delivery addresses the same?","examples":[true]},"customer":{"$ref":"#/components/schemas/documentCustomer"},"items":{"type":"array","description":"content of the delivery note","items":{"$ref":"#/components/schemas/deliveryNoteItem"}},"documentRemark":{"type":["string","null"],"description":"remark for the document.","examples":["Note: This is a test delivery note"]}}}},"components/schemas/creditNote":{"id":"components/schemas/creditNote","kind":"json-schema","title":"creditNote","data":{"type":"object","required":["code","isValid","invoiceCode","orderCode","proofPaymentCode","creationTime","changeTime","dueDate","taxDate","varSymbol","constSymbol","specSymbol","stockAmountChangeType","weight","completePackageWeight","billingMethod","billingAddress","deliveryAddress","addressesEqual","price","customer","eshop","items","documentRemark","vatPayer"],"additionalProperties":false,"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"variant code (product) (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["00000008"]},"isValid":{"type":"boolean","description":"is the credit note valid?","examples":[true]},"invoiceCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Caution! This does not have to be just a number, it can also contain letters, a dash, etc."},"children":[]}]}]}],"examples":["2017200011"]},"orderCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase order number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Caution! This does not have to be just a number, it can also contain letters, a dash, etc."},"children":[]}]}]}],"examples":["2017000017"]},"proofPaymentCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proof payment code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Caution! This does not have to be just a number, it can also contain letters, a dash, etc."},"children":[]}]}]}],"examples":["P--2017200011-1"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of issue, in ISO 8601 format"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of change, in ISO 8601 format"},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"due date in ISO 8601 format (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxation date in ISO 8601 format (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"variable symbol"},"constSymbol":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"constant symbol (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[6583]},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbolNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific symbol (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"restocked":{"type":"boolean","description":"Items in credit note were restocked?","examples":[true]},"stockAmountChangeType":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of change in stock quantity (can "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"be null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["load","unload",null]},"weight":{"$ref":"#/components/schemas/typeWeightUnlimited"},"completePackageWeight":{"$ref":"#/components/schemas/typeWeightUnlimited"},"billingMethod":{"description":"information about the method of payment","oneOf":[{"$ref":"#/components/schemas/billingMethod"},{"type":"null"}]},"billingAddress":{"$ref":"#/components/schemas/billingAddress","description":"invoicing address"},"deliveryAddress":{"$ref":"#/components/schemas/address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery address (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"addressesEqual":{"type":"boolean","description":"Are delivery and invoicing address the same?","examples":[true]},"price":{"$ref":"#/components/schemas/price"},"customer":{"$ref":"#/components/schemas/documentCustomer"},"eshop":{"$ref":"#/components/schemas/eshop"},"items":{"type":"array","items":{"$ref":"#/components/schemas/documentItemsWithPrice"}},"documentRemark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark on the document (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["This is a remark"]},"vatPayer":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the tradesman a VAT payer? (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[true]},"vatMode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT mode, can be null, possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Normal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"One Stop Shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mini One Stop Shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reverse charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outside the EU"},"children":[]}]}]}],"examples":["Normal"]},"reasonRemark":{"type":["string","null"],"description":"Reason for credit note; default reason can be applied if not send.","examples":["Order cancellation"]}}}},"components/schemas/proformaInvoice":{"id":"components/schemas/proformaInvoice","kind":"json-schema","title":"proformaInvoice","data":{"type":"object","additionalProperties":false,"required":["code","isValid","paid","orderCode","creationTime","changeTime","dueDate","varSymbol","constSymbol","specSymbol","weight","completePackageWeight","billingMethod","billingAddress","deliveryAddress","addressesEqual","price","customer","eshop","items","documentRemark","vatPayer"],"properties":{"code":{"type":"string","description":"proforma invoice number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2015000001"]},"isValid":{"type":"boolean","description":"is the proforma invoice valid?","examples":[true]},"paid":{"type":["boolean","null"],"description":"is the proforma invoice paid?","examples":[true]},"orderCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase order number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Caution! This does not have to be just a number, it can also contain letters, a dash, etc."},"children":[]}]}]}],"examples":["2017000017"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of issue, in ISO 8601 format"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of last change, in ISO 8601 format"},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":"due date, in ISO 8601 format"},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"variable symbol"},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbolNullable","description":"constant symbol"},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbolNullable","description":"specific symbol"},"weight":{"$ref":"#/components/schemas/typeWeightUnlimited","description":"weight in kg, unpacked. 3 decimal places."},"completePackageWeight":{"$ref":"#/components/schemas/typeWeightUnlimited","description":"total weight of package in kg. 3 decimal places."},"billingMethod":{"description":"information about the method of payment.","oneOf":[{"$ref":"#/components/schemas/billingMethod"},{"type":"null"}]},"billingAddress":{"$ref":"#/components/schemas/billingAddress","description":"invoicing address"},"deliveryAddress":{"$ref":"#/components/schemas/address"},"addressesEqual":{"type":"boolean","description":"are the billing and delivery addresses the same?","examples":[true]},"price":{"$ref":"#/components/schemas/price","description":"price information"},"customer":{"$ref":"#/components/schemas/documentCustomer"},"eshop":{"$ref":"#/components/schemas/eshop"},"items":{"type":"array","description":"content of the proforma invoice","items":{"$ref":"#/components/schemas/documentItemsWithPrice"}},"documentRemark":{"type":["string","null"],"description":"remark for the document","examples":["This is a remark."]},"vatPayer":{"type":"boolean","description":"was the tradesman a VAT payer, when the receipt was issued?","examples":[true]},"vatMode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT mode, can be null, for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/vat-modes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT modes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["Normal"]}}}},"components/schemas/invoice":{"id":"components/schemas/invoice","kind":"json-schema","title":"invoice","data":{"type":"object","required":["code","isValid","proformaInvoiceCodes","orderCode","creationTime","changeTime","dueDate","taxDate","varSymbol","constSymbol","specSymbol","weight","completePackageWeight","billingMethod","billingAddress","deliveryAddress","addressesEqual","price","customer","eshop","items","documentRemark","vatPayer","paid"],"additionalProperties":false,"properties":{"code":{"type":"string","description":"variant code (product)","examples":["2015000001"]},"isValid":{"type":"boolean","description":"is the invoice valid?","examples":[true]},"proformaInvoiceCodes":{"$ref":"#/components/schemas/proformaInvoiceCodes","description":"List of linked proforma invoices"},"orderCode":{"type":["string","null"],"description":"purchase order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2017000017"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of issue, in ISO 8601 format"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of change, in ISO 8601 format"},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":"due date in ISO 8601 format"},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":"taxation date in ISO 8601 format"},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"variable symbol"},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbolNullable","description":"constant symbol"},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbolNullable","description":"specific symbol"},"weight":{"$ref":"#/components/schemas/typeWeightUnlimited","description":"weight in kg, unpacked. 3 decimal places."},"completePackageWeight":{"$ref":"#/components/schemas/typeWeightUnlimited","description":"total weight of package in kg. 3 decimal places."},"billingMethod":{"description":"information about the method of payment","oneOf":[{"$ref":"#/components/schemas/billingMethod"},{"type":"null"}]},"billingAddress":{"$ref":"#/components/schemas/billingAddress","description":"invoicing address"},"deliveryAddress":{"$ref":"#/components/schemas/address"},"addressesEqual":{"type":"boolean","description":"are the billing and delivery addresses the same?","examples":[true]},"price":{"$ref":"#/components/schemas/price"},"customer":{"$ref":"#/components/schemas/documentCustomer"},"eshop":{"$ref":"#/components/schemas/eshop"},"items":{"type":"array","description":"content of the invoice","items":{"$ref":"#/components/schemas/invoiceItem"}},"documentRemark":{"type":["string","null"],"description":"remark for the document","examples":["remark"]},"vatPayer":{"type":"boolean","description":"is the e-shop a VAT payer?"},"vatMode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT mode, can be null, possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Normal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"One Stop Shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Mini One Stop Shop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reverse charge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Outside the EU"},"children":[]}]}]}],"examples":["Normal"]},"proofPayments":{"$ref":"#/components/schemas/proofPaymentsForInvoice","description":"List of linked proof payments"},"paid":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, whether the invoice was paid. In addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", can also be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if the payment status is unknown."},"children":[]}]}]}],"examples":[true]}}}},"components/schemas/pricelistDetail":{"id":"components/schemas/pricelistDetail","kind":"json-schema","title":"pricelistDetail","data":{"type":"object","additionalProperties":false,"required":["code","currencyCode","includingVat","vatRate","price","orderableAmount","sales"],"properties":{"code":{"type":"string","examples":["0006"]},"currencyCode":{"$ref":"#/components/schemas/typeCurrencyCode","examples":["CZK"]},"includingVat":{"type":"boolean","examples":[true]},"vatRate":{"$ref":"#/components/schemas/typeVatRate"},"price":{"$ref":"#/components/schemas/variantPrice"},"orderableAmount":{"$ref":"#/components/schemas/productOrderableAmount","description":"orderable quantity."},"sales":{"$ref":"#/components/schemas/priceSales","description":"definition of discounts."},"prices":{"$ref":"#/components/schemas/productPrices"}}}},"components/schemas/abandonedCartSnapshot":{"id":"components/schemas/abandonedCartSnapshot","kind":"json-schema","title":"Abandoned cart","data":{"title":"Abandoned cart","x-tags":["Snapshot"],"type":"object","additionalProperties":false,"required":["date","age","items","cartValue","coupon","customer","returns","lastStep"],"properties":{"date":{"$ref":"#/components/schemas/typeDateTime","description":"date and time the cart was last visited"},"age":{"type":"integer","description":"number of days since the cart was last visited","examples":[3]},"items":{"type":"array","description":"products in the abandoned cart","items":{"type":"object","additionalProperties":false,"required":["code","name","amount"],"properties":{"code":{"type":"string","description":"product code","examples":["0006"]},"name":{"type":"string","description":"product name","examples":["Product name"]},"amount":{"type":"number","description":"amount of the product in the cart","examples":[2]}}}},"cartValue":{"$ref":"#/components/schemas/typePrice","description":"total price of the cart (default eshop VAT rate is used)"},"coupon":{"type":["object","null"],"additionalProperties":false,"required":["code","discountType","amount","ratio"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount coupon applied to the cart ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if none was used)"},"children":[]}]}]}],"properties":{"code":{"type":"string","description":"code of discount coupon","examples":["DC14585431"]},"discountType":{"type":"string","enum":["percentual","fixed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of discount. Percentual ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or absolute discount ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["percentual"]},"amount":{"$ref":"#/components/schemas/typePriceNullable","description":"amount of absolute discount (default eshop VAT rate is used)"},"ratio":{"oneOf":[{"$ref":"#/components/schemas/typePriceRatio"},{"type":"null"}],"description":"amount of percentual discount"}}},"customer":{"type":"object","additionalProperties":false,"required":["name","email","phone"],"properties":{"name":{"type":"string","description":"customer's full name","examples":["John Doe"]},"email":{"type":["string","null"],"description":"customer's e-mail","examples":["john.doe@example.com"]},"phone":{"type":["string","null"],"description":"customer's phone number","examples":["+420123456789"]}}},"returns":{"type":"integer","description":"number of times the customer returned to (revisited) the cart","examples":[2]},"lastStep":{"type":"integer","enum":[0,1,2,3],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last step reached in the cart before it was abandoned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cart (checkout not started), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" delivery and payment method selection, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customer/contact details, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order was created"},"children":[]}]}]}],"examples":[0]}}}},"components/schemas/articleSnapshot":{"id":"components/schemas/articleSnapshot","kind":"json-schema","title":"Article","data":{"title":"Article","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/article"}]}},"components/schemas/brandBatchCreate":{"id":"components/schemas/brandBatchCreate","kind":"json-schema","title":"Brand create","data":{"title":"Brand create","x-tags":["Batch"],"allOf":[{"$ref":"#/components/schemas/brandCreate"}]}},"components/schemas/categoryBatchUpdate":{"id":"components/schemas/categoryBatchUpdate","kind":"json-schema","title":"Category update","data":{"title":"Category update","x-tags":["Batch"],"properties":{"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"language of entity (available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignLanguages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active and initialized)"},"children":[]}]}]}],"examples":["cs"]}},"allOf":[{"$ref":"#/components/schemas/categoryUpdate"}]}},"components/schemas/categoryProductPriorityBatchUpdate":{"id":"components/schemas/categoryProductPriorityBatchUpdate","kind":"json-schema","title":"Category product priority update","data":{"title":"Category product priority update","x-tags":["Batch"],"type":"object","additionalProperties":false,"required":["categoryGuid","data"],"properties":{"categoryGuid":{"$ref":"#/components/schemas/typeGuid","description":"Category GUID."},"data":{"type":"array","description":"Product priorities in a defined category.","items":{"type":"object","oneOf":[{"additionalProperties":false,"required":["productGuid","priority"],"properties":{"productGuid":{"$ref":"#/components/schemas/typeGuid","description":"Product GUID."},"priority":{"type":["integer","null"],"description":"Product priority.","examples":[1]}}},{"additionalProperties":false,"required":["productCode","priority"],"properties":{"productCode":{"type":"string","maxLength":255,"minLength":1,"description":"Product code.","examples":["ABC123"]},"priority":{"type":["integer","null"],"description":"Product priority.","examples":[1]}}}]}}}}},"components/schemas/pricelistBatchUpdate":{"id":"components/schemas/pricelistBatchUpdate","kind":"json-schema","title":"Pricelist update","data":{"title":"Pricelist update","x-tags":["Batch"],"allOf":[{"$ref":"#/components/schemas/pricelistUpdate"}]}},"components/schemas/creditNoteSnapshot":{"id":"components/schemas/creditNoteSnapshot","kind":"json-schema","title":"Credit note","data":{"title":"Credit note","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/creditNote"}]}},"components/schemas/customerSnapshot":{"id":"components/schemas/customerSnapshot","kind":"json-schema","title":"Customer","data":{"title":"Customer","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/customer"}]}},"components/schemas/deliveryNoteSnapshot":{"id":"components/schemas/deliveryNoteSnapshot","kind":"json-schema","title":"Delivery note","data":{"title":"Delivery note","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/deliveryNote"}]}},"components/schemas/discountCouponSnapshot":{"id":"components/schemas/discountCouponSnapshot","kind":"json-schema","title":"Discount coupon","data":{"title":"Discount coupon","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/discountCoupon"}]}},"components/schemas/invoiceSnapshot":{"id":"components/schemas/invoiceSnapshot","kind":"json-schema","title":"Invoice","data":{"title":"Invoice","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/invoice"}]}},"components/schemas/orderBatchCreate":{"id":"components/schemas/orderBatchCreate","kind":"json-schema","title":"Order create","data":{"title":"Order create","x-tags":["Batch"],"type":"object","additionalProperties":false,"required":["data"],"properties":{"settings":{"type":"object","additionalProperties":false,"properties":{"suppressDocumentGeneration":{"type":"boolean","description":"Suppress the generation of linked documents.","examples":[true]},"suppressEmailSending":{"type":"boolean","description":"Suppress sending the linked information e-mails.","examples":[true]},"suppressProductChecking":{"type":"boolean","description":"Suppress the product existence check as per code and GUID.","examples":[true]},"suppressStockMovements":{"type":"boolean","description":"Suppress deduction of the products from stock.","examples":[true]},"suppressHistoricalMandatoryFields":{"type":"boolean","description":"Set the flag that disables mandatory fields checking.","examples":[true]},"suppressHistoricalPaymentChecking":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the flag that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"suppressHistoricalShippingChecking":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the flag that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shippingGuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]}}},"data":{"properties":{"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"language of entity (available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignLanguages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active and initialized)"},"children":[]}]}]}],"examples":["cs"]}},"$ref":"#/components/schemas/orderCreate"}}}},"components/schemas/orderSnapshot":{"id":"components/schemas/orderSnapshot","kind":"json-schema","title":"Order","data":{"title":"Order","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/order"}]}},"components/schemas/orderHistorySnapshot":{"id":"components/schemas/orderHistorySnapshot","kind":"json-schema","title":"Order history","data":{"title":"Order history","x-tags":["Snapshot"],"required":["orderCode"],"properties":{"orderCode":{"type":"string","description":"Code of order, which identifies the relation to the order.","examples":["2025000056"]}},"allOf":[{"$ref":"#/components/schemas/orderHistory"}]}},"components/schemas/pricelistSnapshot":{"id":"components/schemas/pricelistSnapshot","kind":"json-schema","title":"Price list","data":{"title":"Price list","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/pricelistDetail"}]}},"components/schemas/productBatchUpdate":{"id":"components/schemas/productBatchUpdate","kind":"json-schema","title":"Product update","data":{"title":"Product update","x-tags":["Batch"],"properties":{"language":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"language of entity (available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"foreignLanguages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active and initialized)"},"children":[]}]}]}],"examples":["cs"]}},"allOf":[{"$ref":"#/components/schemas/productUpdate"}]}},"components/schemas/productBatchDeleteSchema":{"id":"components/schemas/productBatchDeleteSchema","kind":"json-schema","title":"Product batch delete","data":{"title":"Product batch delete","x-tags":["Batch"],"allOf":[{"$ref":"#/components/schemas/productBatchDelete"}]}},"components/schemas/productSnapshot":{"id":"components/schemas/productSnapshot","kind":"json-schema","title":"Product","data":{"title":"Product","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/product"}]}},"components/schemas/productPricelistSnapshot":{"id":"components/schemas/productPricelistSnapshot","kind":"json-schema","title":"Product price list","data":{"title":"Product price list","x-tags":["Snapshot"],"required":["productGuid","productId"],"properties":{"productGuid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"unique product indicator"},"productId":{"type":"integer","description":"product identifier","examples":[2]}},"allOf":[{"$ref":"#/components/schemas/pricelistDetail"}]}},"components/schemas/proformaInvoiceSnapshot":{"id":"components/schemas/proformaInvoiceSnapshot","kind":"json-schema","title":"Proforma invoice","data":{"title":"Proforma invoice","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/proformaInvoice"}]}},"components/schemas/proofPaymentSnapshot":{"id":"components/schemas/proofPaymentSnapshot","kind":"json-schema","title":"Proof payment","data":{"title":"Proof payment","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/proofPaymentDetail"}]}},"components/schemas/quantityDiscountSnapshot":{"id":"components/schemas/quantityDiscountSnapshot","kind":"json-schema","title":"Quantity discount","data":{"title":"Quantity discount","x-tags":["Snapshot"],"allOf":[{"$ref":"#/components/schemas/quantityDiscount"}]}},"schema_522":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_522"},"schema_523":{"kind":"json-schema","data":{"type":"string"},"id":"schema_523"},"schema_524":{"kind":"json-schema","data":{"type":"string","example":"+420123456789"},"id":"schema_524"},"schema_525":{"kind":"json-schema","data":{"type":"string","example":"15/ZLU"},"id":"schema_525"},"schema_526":{"kind":"json-schema","data":{"type":"string","default":"application/json"},"id":"schema_526"},"schema_527":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["orders","paginator"],"properties":{"orders":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","guid","creationTime","changeTime","fullName","company","email","remark","customerGuid","cashDeskOrder","adminUrl","status","shipping","paymentMethod","price","paid"],"properties":{"code":{"type":"string","description":"order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2017000092"]},"guid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"global unique permanent order identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for old orders)"},"children":[]}]}]}],"examples":["c5012051-d7ca-11e0-9a5c-feab5ed617ed"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time, when the order was created. ISO 8601 format."},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of the order's last change. ISO 8601 format."},"fullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Doe"]},"company":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Shoptet s.r.o."]},"email":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchaser e-mail (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["customer@someemail.com"]},"phone":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchaser phone number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["+420604600444"]},"remark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer remark (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"examples":["Please deliver the goods to the back door."]},"customerGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer identifier, if the customer is registered in the e-shop (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"cashDeskOrder":{"type":"boolean","description":"flag, whether the order is from the cash desk (as opposed to the e-shop)","examples":[true]},"adminUrl":{"type":"string","description":"URL to administration leading to order detail. URL keeps the administration language settings.","examples":["https://www.domena-eshopu.cz/admin/objednavky-detail?id=2"]},"status":{"type":["object","null"],"additionalProperties":false,"required":["name","id"],"properties":{"name":{"type":["string","null"],"description":"status name","examples":["Processing"]},"id":{"type":"integer","description":"status identifier","examples":[-1]}}},"source":{"type":["object","null"],"additionalProperties":false,"required":["name","id"],"properties":{"name":{"type":["string","null"],"description":"source name","examples":["E-Shop"]},"id":{"type":"integer","description":"source identifier","examples":[-1]}}},"shipping":{"$ref":"#/components/schemas/shipping"},"paymentMethod":{"oneOf":[{"$ref":"#/components/schemas/paymentMethod"},{"type":"null"}]},"price":{"$ref":"#/components/schemas/price","description":"price of the order"},"paid":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, whether the order was paid. In addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", can also be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if the payment status is unknown."},"children":[]}]}]}],"examples":[true]},"preAuthorization":{"$ref":"#/components/schemas/orderPreAuthorization"},"salesChannelGuid":{"$ref":"#/components/schemas/typeGuidNullable","description":"sales channel guid"}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_527"},"schema_528":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":["object","null"]},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"id":"schema_528"},"schema_529":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_529"},"schema_530":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/orderCreate"}}},"id":"schema_530"},"schema_531":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["order"],"properties":{"order":{"$ref":"#/components/schemas/order"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_531"},"schema_532":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["jobId"],"properties":{"jobId":{"examples":["ad24xod"],"description":"token of job","type":"string"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"id":"schema_532"},"schema_533":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["orderCodes","statusId"],"additionalProperties":false,"properties":{"orderCodes":{"type":"array","minItems":1,"maxItems":100,"description":"order codes","items":{"type":"string","examples":["2017000052"]}},"statusId":{"type":"number","description":"order status identifier","examples":[-1]}}}}},"id":"schema_533"},"schema_534":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":["object","null"],"additionalProperties":false},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_534"},"schema_535":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"creationTime":{"type":"string","description":"time of order creation. Optional, current time is the default value.","examples":["2018-01-21T14:15:47+0100"]},"email":{"type":["string","null"],"minLength":1,"maxLength":100,"description":"customer e-mail (can be omitted only when ordering via cash desk).","examples":["foo@bar.cz"]},"phone":{"type":["string","null"],"minLength":1,"maxLength":32,"description":"phone number of the customer. Optional, if not set as mandatory item in shop settings.","examples":["+420123456789"]},"birthDate":{"type":["string","null"],"description":"customer birth date (optional, if not made mandatory by the e-shop settings).","examples":["1990-01-01"]},"customerGuid":{"$ref":"#/components/schemas/typeGuidUnlimited","minLength":1,"description":"Customer GUID, if not done under known registered customer (optional)."},"addressesEqual":{"type":["boolean","null"],"description":"flag, whether the billing and delivery addresses are the same","examples":[true]},"billingAddress":{"type":"object","additionalProperties":false,"required":["countryCode"],"properties":{"company":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"company name. Optional, if not set as mandatory item in shop settings.","examples":["Smith & Smith"]},"fullName":{"type":["string","null"],"maxLength":255,"description":"customer name. Optional, if not set as mandatory item in shop settings.","examples":["John Doe"]},"street":{"type":["string","null"],"maxLength":255,"description":"(string, optional) - street of the customer. Optional, if not set as mandatory item in shop settings.","examples":["Main Street"]},"houseNumber":{"type":["string","null"],"maxLength":255,"description":"street number. Optional, if not set as mandatory item in shop settings.","examples":["123"]},"city":{"type":["string","null"],"maxLength":255,"description":"City/Town. Optional, if not set as mandatory item in shop settings.","examples":["Flat Country"]},"district":{"type":["string","null"],"maxLength":255,"description":"County. Optional, if not set as mandatory item in shop settings.","examples":["Bohemia"]},"additional":{"type":["string","null"],"maxLength":255,"description":"Additional information for the address. Optional.","examples":["3rd floor"]},"zip":{"type":["string","null"],"maxLength":255,"description":"ZIP or postal code. Optional, if not set as mandatory item in shop settings.","examples":["123 00"]},"countryCode":{"type":"string","minLength":1,"description":"Customer's country code","examples":["CZ"]},"regionName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"region. Optional.","examples":["Central Bohemia"]},"regionShortcut":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"region abbreviation. Optional.","examples":["SC"]},"companyId":{"type":["string","null"],"minLength":1,"maxLength":18,"description":"Company registration number of the customer, if purchasing as a company. Optional.","examples":["123456"]},"vatId":{"type":["string","null"],"minLength":1,"maxLength":16,"description":"VAT identification number of the customer, if purchasing on the company.","examples":["CZ123456"]},"taxId":{"type":["string","null"],"minLength":1,"maxLength":16,"description":"TAX identification number of the customer, if purchasing on the company. For Czech address, taxId must be the same as vatId, or left empty. Optional.","examples":["CZ123456"]}}},"deliveryAddress":{"type":["object","null"],"additionalProperties":false,"properties":{"company":{"type":["string","null"],"maxLength":255,"description":"company name. Optional, if not set as mandatory item in shop settings.","examples":["Smith & Smith"]},"fullName":{"type":["string","null"],"maxLength":255,"description":"customer name. Optional, if not set as mandatory item in shop settings.","examples":["John Doe"]},"street":{"type":["string","null"],"maxLength":255,"description":"(string, optional) - street for delivery. Optional, if not set as mandatory item in shop settings.","examples":["Main Street"]},"houseNumber":{"type":["string","null"],"maxLength":255,"description":"street number. Optional, if not set as mandatory item in shop settings.","examples":["123"]},"city":{"type":["string","null"],"maxLength":255,"description":"City/Town. Optional, if not set as mandatory item in shop settings.","examples":["Flat Country"]},"district":{"type":["string","null"],"maxLength":255,"description":"County. Optional, if not set as mandatory item in shop settings.","examples":["Bohemia"]},"additional":{"type":["string","null"],"maxLength":255,"description":"Additional information for the address. Optional.","examples":["3rd floor"]},"zip":{"type":["string","null"],"maxLength":255,"description":"ZIP or postal code. Optional, if not set as mandatory item in shop settings.","examples":["123 00"]},"countryCode":{"type":"string","minLength":1,"description":"Customer's country code","examples":["CZ"]},"regionName":{"type":["string","null"],"maxLength":255,"description":"region. Optional.","examples":["Central Bohemia"]},"regionShortcut":{"type":["string","null"],"maxLength":255,"description":"region abbreviation. Optional.","examples":["SC"]}}}}}}},"id":"schema_535"},"schema_536":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"customerRemark":{"type":["string","null"]},"trackingNumber":{"type":["string","null"],"maxLength":32},"additionalFields":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["index","text"],"properties":{"index":{"type":"integer","enum":[1,2,3,4,5,6]},"text":{"type":["string","null"]}}}},"eshopRemark":{"type":["string","null"]}}}}},"id":"schema_536"},"schema_537":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"statusId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New order status. The order statuses are specific for each e-shop and it is possible to gain these from the endpoint "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/eshop/geteshopinfo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Eshop info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=orderStatuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter"},"children":[]}]}]}],"examples":[-1]},"paid":{"type":["boolean","null"],"description":"paid flag","examples":[true]},"billingMethodId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing method identifier - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":[1]}}}}},"id":"schema_537"},"schema_538":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["scope"],"properties":{"scope":{"type":"string","enum":["all","no-billing-shipping","contact-only"],"examples":["all"],"description":"Scope of the order copy. Check endpoint description for more information."}}}}},"id":"schema_538"},"schema_539":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["statuses","defaultStatus"],"additionalProperties":false,"properties":{"defaultStatus":{"type":"integer"},"statuses":{"type":"array","items":{"type":"object","required":["id","name","system","order","markAsPaid","changeOrderItems","stockClaimResolved","documents"],"additionalProperties":false,"properties":{"id":{"type":"integer","description":"order status id","examples":[1]},"name":{"type":"string","description":"order status name","examples":["Pending"]},"system":{"type":"boolean","description":"Is this the system status?","examples":[true]},"order":{"type":"integer","description":"status order sequence in the administration","examples":[1]},"markAsPaid":{"type":"boolean","description":"Should the order be marked as paid in this status?","examples":[false]},"color":{"type":["string","null"],"description":"color of orders in this status","examples":["#bada55"]},"backgroundColor":{"type":["string","null"],"description":"background of order in this status","examples":["#bada55"]},"changeOrderItems":{"type":"boolean","description":"change status of the items in the order","examples":[false]},"stockClaimResolved":{"type":"boolean","description":"stock demand resolved","examples":[false]},"documents":{"type":"object","required":["generateProformaInvoice","generateInvoice","generateDeliveryNote","generateProofPayment"],"additionalProperties":false,"properties":{"generateProformaInvoice":{"type":"boolean","description":"proforma invoice is generated in this status.","examples":[true]},"generateInvoice":{"type":"boolean","description":"tax document is generated in this status.","examples":[true]},"generateDeliveryNote":{"type":"boolean","description":"delivery note is generated in this status.","examples":[true]},"generateProofPayment":{"type":["boolean","null"],"description":"proof of payment is generated in this status.","examples":[true]}}}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_539"},"schema_540":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["sources"],"additionalProperties":false,"properties":{"sources":{"type":"array","items":{"type":"object","required":["id","name"],"additionalProperties":false,"properties":{"id":{"type":"integer","description":"order source ID, it can also be negative","examples":[-1]},"name":{"type":"string","description":"The name of the order source.","examples":["E-shop"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_540"},"schema_541":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["changes","paginator"],"properties":{"changes":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","changeTime","changeType"],"properties":{"code":{"type":"string","description":"identifier (number) of the order, which can be used to query about the details.","examples":["201800001"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time when the event happened. ISO 8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-12-12T22:08:01+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"changeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of event that happened with the entity. Possible values are following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["edit"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_541"},"schema_542":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_542"},"schema_543":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["orders","paginator"],"properties":{"orders":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["orderCode","statusId","productCode","amount","amountCompleted"],"properties":{"orderCode":{"type":"string","description":"identifier (number) of the order, which can be used to query about the details.","examples":["201800001"]},"statusId":{"type":"integer","description":"Order status.","examples":[-1]},"productCode":{"type":"string","description":"unique identification of the product variant.","examples":["26/BIL"]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"amount ordered","examples":["50"]},"amountCompleted":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"amount of completed product","examples":[1]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_543"},"schema_544":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["batchFileUrlPath"],"properties":{"batchFileUrlPath":{"type":"string","description":"Url to batch file with products data. File must be in JSONL format.","examples":["https://cdn.myshoptet.com/batch-products-update.jsonl"]}}},"id":"schema_544"},"schema_545":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["jobId"],"properties":{"jobId":{"examples":["ad24xod"],"description":"token of job","type":"string"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_545"},"schema_546":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/orderGift"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_546"},"schema_547":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","required":["code","orderPrice","currencyCode"],"additionalProperties":false,"properties":{"code":{"type":"string","description":"code od product variant","examples":["0005"]},"currencyCode":{"$ref":"#/components/schemas/typeCurrencyCode"},"orderPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"price which order total price should overcome. to add this gift"},"includingVat":{"type":"boolean","description":"if true, orderPrice is including VAT","examples":[true]}}}}},"id":"schema_547"},"schema_548":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["orderHistory"],"properties":{"orderHistory":{"type":"array","items":{"$ref":"#/components/schemas/orderHistory"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_548"},"schema_549":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["text"],"additionalProperties":false,"properties":{"text":{"type":"string","minLength":1,"examples":["Transported from Jičín, will be here on Wednesday"]},"type":{"type":"string","enum":["comment","system"],"minLength":1,"description":"Record type","examples":["comment","system"]}}}}},"id":"schema_549"},"schema_550":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":["object","null"]},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_550"},"schema_551":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","minProperties":1,"additionalProperties":false,"required":["itemType"],"properties":{"itemType":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item type. Mandatory field. See also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/types-of-order-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of order items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume-discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount-coupon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item type is allowed."},"children":[]}]}]}],"examples":["product"]},"code":{"type":"string","minLength":1,"maxLength":64,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item code. For transportation, payment and discounts the ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount-coupon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume-discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") must remain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for the other types of items, this is mandatory."},"children":[]}]}]}],"examples":["179/B"]},"vatRate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for VAT non-payers). Mandatory."},"children":[]}]}]}],"examples":["21.00"]},"itemPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"],"deprecated":true},"itemPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"],"deprecated":true},"unitPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"]},"unitPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"]},"buyPriceWithVat":{"type":"string","description":"Purchase price, including VAT. Optional. Price including tax and price excluding tax cannot be combined. This is used for profit margin calculation and statistics.","examples":["121.00"]},"buyPriceWithoutVat":{"type":"string","description":"Purchase price, excluding VAT. Optional. Price including tax and price excluding tax cannot be combined. This is used for profit margin calculation and statistics.","examples":["100.00"]},"buyPriceVatRate":{"type":"string","description":"VAT rate for purchase price. Optional.","examples":["21.00"]},"name":{"type":"string","minLength":1,"maxLength":250,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product name (optional, but usually filled in). Mandatory only for volume-discount, discount-coupon, transport and payment, for other items, it is loaded according to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["Large chocolate"]},"variantName":{"type":["string","null"],"minLength":1,"maxLength":128,"description":"Variant name. Optional.","examples":["Type: walnut"]},"brand":{"type":["string","null"],"minLength":1,"maxLength":64,"description":"brand (manufacturer). Optional.","examples":["Willy Wonka"]},"supplierName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"supplier. Optional.","examples":["Dodavatel s.r.o."]},"productGuid":{"$ref":"#/components/schemas/typeGuidNullable","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product GUID in item. When used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?suppressProductChecking=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, this field has no influence."},"children":[]}]}]}]},"remark":{"type":["string","null"],"minLength":1,"description":"With cubicles","examples":["This is a gift for my friend."]},"warrantyDescription":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"textual description of warranty length (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2 years"]},"amountCompleted":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"quantity of completed product"},"additionalField":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"additional information. Used for transport to specify the branch.","examples":["TO BALÍKOVNA, Karlínské náměstí 145/1, Karlín, 18600, Prague"]},"amount":{"type":"string","pattern":"^[0-9]+\\.?[0-9]{0,3}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount, 3 decimal places accuracy, optional, default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["1.000"]},"amountUnit":{"type":"string","minLength":1,"maxLength":16,"description":"unit of quantity (optional)","examples":["ks"]},"weight":{"type":"string","description":"product weight in kilograms. Maximum 3 decimal places, and maximum value of 99999.","examples":["100"]},"priceRatio":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount in the form of coefficient (0.7 = 70 % of the original price, i.e. 30 % discount). Optional, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]}]}]}],"examples":["0.7000"]},"recyclingFeeId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product recycling fee id, replacement for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recyclingFee"},"children":[]}]}]}],"examples":[1]},"statusId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item status. Optional, if not indicated, default value is guided by the order status. If the order status was indicated and this status has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Change status of items in the order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set, then the item will have this status. Otherwise the default status of the e-shop is used."},"children":[]}]}]}],"examples":[-1]},"surchargeParameters":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["parameterCode","valueIndex"],"properties":{"parameterCode":{"type":"string","minLength":1,"examples":["pp-1"]},"valueIndex":{"type":"string","minLength":1,"examples":["hodnota-01"]},"price":{"$ref":"#/components/schemas/typePrice","description":"custom price for surcharge parameter, price is in currency of order. Optional. If attribute price is not present, then price from surcharge parameter itself is used.","examples":["123.43"]}}}},"consumptionTaxId":{"$ref":"#/components/schemas/consumptionTaxId"}}}}},"id":"schema_551"},"schema_552":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","minProperties":1,"additionalProperties":false,"required":["itemType"],"properties":{"itemType":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item type. Mandatory field; see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/types-of-order-items"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of order items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product-set"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume-discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount-coupon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item type is allowed."},"children":[]}]}]}],"examples":["product"]},"code":{"type":"string","minLength":1,"maxLength":64,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item code. For transportation, payment and discounts the ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount-coupon"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume-discount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") must remain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for the other types of items, this is mandatory."},"children":[]}]}]}],"examples":["179/B"]},"vatRate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for VAT non-payers). Mandatory."},"children":[]}]}]}],"examples":["21.00"]},"itemPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"],"deprecated":true},"itemPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"],"deprecated":true},"unitPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"]},"unitPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"]},"buyPriceWithVat":{"type":"string","description":"Purchase price, including VAT. Optional. Price including tax and price excluding tax cannot be combined. This is used for profit margin calculation and statistics.","examples":["121.00"]},"buyPriceWithoutVat":{"type":"string","description":"Purchase price, excluding VAT. Optional. Price including tax and price excluding tax cannot be combined. This is used for profit margin calculation and statistics.","examples":["100.00"]},"buyPriceVatRate":{"type":"string","description":"VAT rate for purchase price. Optional.","examples":["21.00"]},"name":{"type":"string","minLength":1,"maxLength":250,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product name (optional, but usually filled in). Mandatory only for transport and payment, for other items, it is loaded according to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["Large chocolate"]},"variantName":{"type":["string","null"],"minLength":1,"maxLength":128,"description":"Variant name. Optional.","examples":["Type: walnut"]},"brand":{"type":["string","null"],"minLength":1,"maxLength":64,"description":"brand (manufacturer). Optional.","examples":["Willy Wonka"]},"supplierName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"supplier. Optional.","examples":["Dodavatel s.r.o."]},"productGuid":{"$ref":"#/components/schemas/typeGuidNullable","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product GUID in item. When used with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?suppressProductChecking=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, this field has no influence."},"children":[]}]}]}]},"remark":{"type":["string","null"],"minLength":1,"description":"With cubicles","examples":["This is a gift for my friend."]},"warrantyDescription":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"textual description of warranty length (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["2 years"]},"amountCompleted":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"quantity of completed product"},"additionalField":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"additional information. Used for transport to specify the branch.","examples":["TO BALÍKOVNA, Karlínské náměstí 145/1, Karlín, 18600, Prague"]},"amount":{"type":"string","pattern":"^[0-9]+\\.?[0-9]{0,3}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"amount, 3 decimal places accuracy, optional, default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["1.000"]},"amountUnit":{"type":"string","minLength":1,"maxLength":16,"description":"unit of quantity (optional)","examples":["ks"]},"weight":{"type":"string","description":"product weight in kilograms. Maximum 3 decimal places, and maximum value of 99999.","examples":["100"]},"priceRatio":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount in the form of coefficient (0.7 = 70 % of the original price, i.e. 30 % discount). Optional, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]}]}]}],"examples":["0.7000"]},"recyclingFeeId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product recycling fee id, replacement for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recyclingFee"},"children":[]}]}]}],"examples":[1]},"statusId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item status. Optional, if not indicated, default value is guided by the order status. If the order status was indicated and this status has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Change status of items in the order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set, then the item will have this status. Otherwise the default status of the e-shop is used."},"children":[]}]}]}],"examples":[-1]},"consumptionTaxId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consumption tax, cannot be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consumptionTax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can send this parameter, only if consumption tax module is enabled."},"children":[]}]}]}],"$ref":"#/components/schemas/consumptionTaxId"},"consumptionTax":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consumption tax with custom value, cannot be used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consumptionTaxId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can send this parameter, only if consumption tax module is enabled."},"children":[]}]}]}],"additionalProperties":false,"required":["currency","price"],"properties":{"currency":{"$ref":"#/components/schemas/typeCurrencyCode"},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"consumption tax value"}}}}}}},"id":"schema_552"},"schema_553":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["orderItem"],"additionalProperties":false,"properties":{"orderItem":{"$ref":"#/components/schemas/orderItem"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_553"},"schema_554":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"oneOf":[{"type":"object","additionalProperties":false,"required":["parameterCode","valueIndex"],"properties":{"parameterCode":{"type":"string","description":"Code of the parameter","examples":["pp-1"]},"valueIndex":{"type":"string","description":"Index of the value","examples":["hodnota-01"]},"price":{"$ref":"#/components/schemas/typePrice","description":"custom price for surcharge parameter, price is in currency of order. Optional. If attribute price is not present, then price from surcharge parameter itself is used."}}},{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","examples":["special parameter 1"]},"price":{"$ref":"#/components/schemas/typePrice","description":"custom price for surcharge parameter, price is in currency of order. Optional. If attribute price is not present, then price from surcharge parameter itself is used."}}}]}}},"id":"schema_554"},"schema_555":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["guid","vatRate"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Guid of payment method."},"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for VAT non-payers)."},"children":[]}]}]}],"examples":["21.00"]},"itemPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"],"deprecated":true},"itemPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"],"deprecated":true},"unitPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"]},"unitPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"]},"buyPriceWithVat":{"type":"string","description":"Purchase price, including VAT. Optional. Price including tax and price excluding tax cannot be combined. This is used for profit margin calculation and statistics.","examples":["121.00"]},"additionalField":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"additional information.","examples":["Payment information"]},"statusId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item status. Optional, if not indicated, default value is guided by the order status. If the order status was indicated and this status has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Change status of items in the order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set, then the item will have this status. Otherwise the default status of the e-shop is used."},"children":[]}]}]}],"examples":[-1]}}}}},"id":"schema_555"},"schema_556":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Guid of payment method."},"vatRate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for VAT non-payers)."},"children":[]}]}]}],"examples":["21.00"]},"itemPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"],"deprecated":true},"itemPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"],"deprecated":true},"unitPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"]},"unitPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"]},"additionalField":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"additional information.","examples":["Payment information"]},"statusId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item status. Optional, if not indicated, default value is guided by the order status. If the order status was indicated and this status has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Change status of items in the order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set, then the item will have this status. Otherwise the default status of the e-shop is used."},"children":[]}]}]}],"examples":[-1]}}}}},"id":"schema_556"},"schema_557":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["guid","vatRate"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Guid of shipping method."},"vatRate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for VAT non-payers)."},"children":[]}]}]}],"examples":["21.00"]},"itemPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"],"deprecated":true},"itemPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"],"deprecated":true},"unitPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"]},"unitPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"]},"additionalField":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"In case of pickup, given value must be a unique identificator of pickup place. You can find these identificators on website of delivery company. In case of other delivery type (e.g. home delivery) it works as a note.","examples":["Home delivery"]},"statusId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item status. Optional, if not indicated, default value is guided by the order status. If the order status was indicated and this status has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Change status of items in the order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set, then the item will have this status. Otherwise the default status of the e-shop is used."},"children":[]}]}]}],"examples":[-1]}}}}},"id":"schema_557"},"schema_558":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Guid of shipping method."},"vatRate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for VAT non-payers)."},"children":[]}]}]}],"examples":["21.00"]},"itemPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"],"deprecated":true},"itemPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated: use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Item price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"itemPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"],"deprecated":true},"unitPriceWithVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price including VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["121.00"]},"unitPriceWithoutVat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit price excluding VAT. Optional. Only one of the items "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unitPriceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be entered."},"children":[]}]}]}],"examples":["100.00"]},"additionalField":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"In case of pickup, given value must be a unique identificator of pickup place. You can find these identificators on website of delivery company. In case of other delivery type (e.g. home delivery) it works as a note.","examples":["Home delivery"]},"statusId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item status. Optional, if not indicated, default value is guided by the order status. If the order status was indicated and this status has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Change status of items in the order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag set, then the item will have this status. Otherwise the default status of the e-shop is used."},"children":[]}]}]}],"examples":[-1]}}}}},"id":"schema_558"},"schema_559":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["creditNotes","paginator"],"properties":{"creditNotes":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","varSymbol","isValid","invoiceCode","proofPaymentCode","orderCode","creationTime","billCompany","billFullName","price","changeTime"],"properties":{"code":{"type":"string","description":"credit note number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["0000000006"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbolNullable"},"isValid":{"type":"boolean","description":"is the credit note valid?","examples":[true]},"invoiceCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Caution! This does not have to be just a number, it can also contain letters, a dash, etc."},"children":[]}]}]}],"examples":["2017200011"]},"proofPaymentCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proof payment code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Caution! This does not have to be just a number, it can also contain letters, a dash, etc."},"children":[]}]}]}],"examples":["P--2017200011-1"]},"orderCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase order number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Caution! This does not have to be just a number, it can also contain letters, a dash, etc."},"children":[]}]}]}],"examples":["2017000017"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of issue, in ISO 8601 format"},"billCompany":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of the company (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Company s.r.o."]},"billFullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name of the customer (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Doe"]},"price":{"$ref":"#/components/schemas/price","description":"price informations"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of last change, in ISO 8601 format"},"reasonRemark":{"type":["string","null"],"description":"Reason for credit note; default reason can be applied if not send.","examples":["Order cancellation"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_559"},"schema_560":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["creditNote"],"properties":{"creditNote":{"$ref":"#/components/schemas/creditNote"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_560"},"schema_561":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"Variable symbol. Optional, generated by eshop settings if not set."},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Due date. Optional, generated by eshop settings if not set."},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Date of taxation. Default is today."},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbolNullable"},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbolNullable","description":"Specific symbol."},"billingMethodId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing method identifier - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Defaults to order's."},"children":[]}]}]}],"examples":[1]},"orderCode":{"type":["string","null"],"minLength":1,"maxLength":10,"description":"Order code. Optional.","examples":["201323134"]},"reasonRemark":{"type":["string","null"],"minLength":1,"description":"Reason for credit note; default reason can be applied if not send.","examples":["Order cancellation"]}}}}},"id":"schema_561"},"schema_562":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["notes"],"properties":{"notes":{"type":"array","description":"Notes about no longer existing products which cannot be restocked. Messages are in administration language.","items":{"type":"string","examples":["Product is no longer available."]}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_562"},"schema_563":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"creditNoteCode":{"type":"string","description":"Credit nore code. Optional, generated by eshop settings if not set.","examples":["0000000099"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"Variable symbol. Optional, generated by eshop settings if not set."},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Due date. Optional, generated by eshop settings if not set."},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Date of taxation. Default is today."},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbol"},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbol","description":"Spec symbol."},"billingMethodId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing method identifier - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Defaults to order."},"children":[]}]}]}],"examples":[1]},"orderCode":{"type":"string","minLength":1,"maxLength":10,"description":"Order Code. Optional.","examples":["201323134"]},"useItemIds":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of invoice item ids. Can be found in field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.invoice.items.itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Invoice detail."},"children":[]}]}]}],"items":{"type":"integer"},"deprecated":true},"items":{"type":"array","minItems":1,"description":"List of invoice item ids and their amounts.","items":{"type":"object","additionalProperties":false,"required":["invoiceItemId"],"properties":{"invoiceItemId":{"type":"integer","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of invoice item. Can be found in field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.invoice.items.itemId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Invoice detail."},"children":[]}]}]}],"examples":[231]},"amount":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"Amount of given item. Optional. If the property is not provided, the amount is automatically taken from the invoice.","examples":[1]}}}},"reasonRemark":{"type":["string","null"],"minLength":1,"description":"Reason for credit note; default reason can be applied if not send.","examples":["Order cancellation"]}}}}},"id":"schema_563"},"schema_564":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"creditNoteCode":{"type":"string","description":"Credit note code. Optional, generated by eshop settings if not set.","examples":["0000000099"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"Variable symbol. Optional, generated by eshop settings if not set."},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Due date. Optional, generated by eshop settings if not set."},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Date of taxation. Optional, default is today."},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbol","description":"Constant symbol. Optional"},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbol","description":"Specific symbol. Optional"},"billingMethodId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing method identifier - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Optional."},"children":[]}]}]}],"examples":[1]},"orderCode":{"type":"string","minLength":1,"maxLength":10,"description":"Order Code. Optional, defaults to proof payment's order code if not set.","examples":["201323134"]},"reasonRemark":{"type":["string","null"],"minLength":1,"description":"Reason for credit note; default reason can be applied if not send.","examples":["Order cancellation"]}}}}},"id":"schema_564"},"schema_565":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["itemType","name","amount"],"properties":{"itemType":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item type, required (allowed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only)"},"children":[]}]}]}],"enum":["billing","shipping"],"examples":["billing"]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"name of item, required"},"name":{"type":["string","null"],"description":"name of item, required","examples":["Item name"]},"price":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"price of item, 2 decimal places accuracy (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]}]}]}],"examples":["100.00"]},"priceRatio":{"$ref":"#/components/schemas/typePriceRatio","description":"price ratio of item, required"},"includingVat":{"type":"boolean","description":"default value is false; whether the credit note item price is saved with VAT or without","examples":[true]},"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":"VAT rate in percent"},"remark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item note (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["item note"]},"additionalField":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field for additional info (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["additional info"]}}}}},"id":"schema_565"},"schema_566":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"amount":{"$ref":"#/components/schemas/typeAmount","description":"amount of item, 3 decimal places accuracy. For credit note use negative amount. Value cannot be greater than amount of original invoice item."},"price":{"type":"string","description":"price of item, without vat, 3 decimal places accuracy. Value cannot be greater than price of original invoice item or lower than 0.","examples":["125.00"]},"includingVat":{"type":"boolean","description":"default value is false; whether the credit note item price is saved with VAT or without","examples":[true]},"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":"VAT rate in percent"}}}}},"id":"schema_566"},"schema_567":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["creditNoteItem"],"additionalProperties":false,"properties":{"creditNoteItem":{"$ref":"#/components/schemas/documentItemsWithPrice"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_567"},"schema_568":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":["object","null"]},"errors":{"$ref":"#/components/schemas/Errors"}}},"id":"schema_568"},"schema_569":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["changes","paginator"],"properties":{"changes":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","changeTime","changeType"],"properties":{"code":{"type":"string","description":"identifier (number) of the document, which can be used to query about the details.","examples":["201800014"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time when the event happened. ISO 8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-12-12T22:08:01+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"changeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of event that happened with the document. Possible values are following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["edit"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_569"},"schema_570":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","description":"Delivery note code.","examples":["2021000021"]},"date":{"$ref":"#/components/schemas/typeDate","description":"Document creation date."}}}}},"id":"schema_570"},"schema_571":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["deliveryNote"],"properties":{"deliveryNote":{"$ref":"#/components/schemas/deliveryNote"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_571"},"schema_572":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["deliveryNotes","paginator"],"properties":{"deliveryNotes":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","orderCode","creationTime","isValid","billCompany","billFullName"],"properties":{"code":{"type":"string","description":"variant code (product)","examples":["00000018"]},"isValid":{"type":"boolean","description":"Is the delivery note valid?","examples":[true]},"orderCode":{"type":["string","null"],"description":"purchase order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2017000090"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of issue, in ISO 8601 format"},"billCompany":{"type":["string","null"],"description":"name of the company","examples":["John Doe Corp."]},"billFullName":{"type":["string","null"],"description":"name and surname","examples":["John Doe"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_572"},"schema_573":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["invoices","paginator"],"properties":{"invoices":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","varSymbol","isValid","proformaInvoiceCodes","orderCode","creationTime","billCompany","billFullName","price","paid"],"properties":{"code":{"type":"string","description":"variant code (product)","examples":["2015000001"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbolNullable","description":"variable symbol"},"isValid":{"type":"boolean","description":"is the invoice valid?","examples":[true]},"proformaInvoiceCodes":{"$ref":"#/components/schemas/proformaInvoiceCodes","description":"List of linked proforma invoices"},"orderCode":{"type":["string","null"],"description":"purchase order number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2017000017"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of issue, in ISO 8601 format"},"billCompany":{"type":["string","null"],"description":"company name","examples":["Company s.r.o."]},"billFullName":{"type":["string","null"],"description":"full name","examples":["John Doe"]},"price":{"$ref":"#/components/schemas/price"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of change, in ISO 8601 format"},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":"due date in ISO 8601 format"},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":"taxation date in ISO 8601 format"},"paid":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, whether the invoice was paid. In addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", can also be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if the payment status is unknown."},"children":[]}]}]}],"examples":[true]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_573"},"schema_574":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["jobId"],"properties":{"jobId":{"examples":["ad24xod"],"description":"token of job","type":"string"}}}}},"id":"schema_574"},"schema_575":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["invoice"],"properties":{"invoice":{"$ref":"#/components/schemas/invoice"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_575"},"schema_576":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"invoiceCode":{"type":"string","description":"Invoice code. Optional, generated by eshop settings if not set.","examples":["2021000021"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"Variable symbol. Optional, generated by eshop settings if not set."},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Due date. Optional, generated by eshop settings if not set."},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Date of taxation. Default is today."},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbol","description":"Const symbol. Only numbers are allowed (max length 4)."},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbol","description":"Spec symbol."},"billingMethodId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing method identifier - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Defaults to order's."},"children":[]}]}]}],"examples":[1]},"proformaInvoiceCode":{"type":"string","description":"Code of proforma invoice. Must exist if set.","examples":["202100032"]},"proofPaymentCodes":{"type":"array","description":"List of linked proof payments.","items":{"type":"string","examples":["O-2018000053-01"]}}}}}},"id":"schema_576"},"schema_577":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"invoiceCode":{"type":"string","description":"Invoice code. Optional, generated by eshop settings if not set.","examples":["2021000021"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"Variable symbol. Optional, generated by eshop settings if not set."},"dueDate":{"$ref":"#/components/schemas/typeDate","description":"Due date. Optional, generated by eshop settings if not set."},"taxDate":{"$ref":"#/components/schemas/typeDate","description":"Date of taxation. Default is today."},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbol","description":"Const symbol. Only numbers are allowed (max length 4)."},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbol","description":"Spec symbol."},"billingMethodId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/Invoice-Billing-Methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to order's."},"children":[]}]}]}],"examples":[1]}}}}},"id":"schema_577"},"schema_578":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["proformaInvoiceCodes"],"properties":{"proformaInvoiceCodes":{"type":"array","minItems":1,"description":"List of linked proforma invoices.","items":{"type":"string","description":"Proforma invoice code. The proforma payment invoice be related to the order, must be in same currency as the order, must be valid and cannot be linked to another invoice.","examples":["2024249998","2024249999"]}}}}}},"id":"schema_578"},"schema_579":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["proofPaymentCodes"],"properties":{"proofPaymentCodes":{"type":"array","minItems":1,"description":"List of linked proof payments.","items":{"type":"string","description":"Proof payment code. The proof payment must be related to the order, must be in same currency as the order, must be valid and cannot be linked to another invoice.","examples":["O-2018000053-01","O-2018000053-02"]}}}}}},"id":"schema_579"},"schema_580":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"proformaInvoiceCode":{"type":"string","maxLength":10,"description":"Proforma invoice code. Optional, generated by eshop settings if not set.","examples":["2021000021"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"Variable symbol. Optional, generated by eshop settings if not set."},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Proforma invoice date time creation, in ISO 8601 format."},"dueDate":{"$ref":"#/components/schemas/typeDateNullable","description":"Due date. Optional, generated by eshop settings if not set."},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbolNullable"},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbolNullable","description":"Specific symbol."},"billingMethodId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing method identifier - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. Defaults to order's."},"children":[]}]}]}],"examples":[1]}}}}},"id":"schema_580"},"schema_581":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["proformaInvoice"],"properties":{"proformaInvoice":{"$ref":"#/components/schemas/proformaInvoice"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_581"},"schema_582":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["proformaInvoices"],"properties":{"proformaInvoices":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","varSymbol","isValid","orderCode","creationTime","billCompany","billFullName","price","changeTime","paid"],"properties":{"code":{"type":"string","description":"proforma invoice number. Caution! This does not have to be just a number, it can also contain letters, a dash, etc.","examples":["2015000001"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbolNullable","description":"variable symbol"},"isValid":{"type":"boolean","description":"is the proforma invoice valid?","examples":[true]},"orderCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purchase order number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Caution! This does not have to be just a number, it can also contain letters, a dash, etc."},"children":[]}]}]}],"examples":["2017000017"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of issue, in ISO 8601 format"},"billCompany":{"type":["string","null"],"description":"company name","examples":["Company s.r.o."]},"billFullName":{"type":["string","null"],"description":"full name","examples":["John Doe"]},"price":{"$ref":"#/components/schemas/price","description":"price information"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date of last change, in ISO 8601 format"},"paid":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, whether the proforma invoice was paid. In addition to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", can also be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if the payment status is unknown."},"children":[]}]}]}],"examples":[true]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_582"},"schema_583":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["changes"],"properties":{"changes":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","changeTime","changeType"],"properties":{"code":{"type":"string","description":"identifier (number) of the document, which can be used to query about the details.","examples":["201800014"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time when the event happened. ISO 8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-12-12T22:08:01+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"changeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of event that happened with the document. Possible values are following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["edit"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_583"},"schema_584":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["items","paginator"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/proofPaymentsList"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_584"},"schema_585":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"required":["payment","currencyCode","varSymbol"],"properties":{"proformaInvoiceCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"proforma invoice code; required if no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderCode"},"children":[]}]}]}],"examples":["2015000170"]},"orderCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order code; required if no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proformaInvoiceCode"},"children":[]}]}]}],"examples":["2015000001"]},"payment":{"$ref":"#/components/schemas/typePriceNullable","description":"total price on the bill","examples":["1000.00"]},"currencyCode":{"$ref":"#/components/schemas/typeCurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code. List of available currencies within the e-shop can be found in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/eshop/geteshopinfo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Eshop info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"examples":["CZK"]},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"variable symbol"},"issueDate":{"$ref":"#/components/schemas/typeDateTimeRequest","description":"date on which was proof payment issued, in ISO 8601 format. Deprecation of required timezone part of datetime, and will be removed in the future"},"taxDate":{"$ref":"#/components/schemas/typeDateNullable","description":"date of tax"},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbolNullable","description":"constant symbol"},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbolNullable","description":"specific symbol"},"invoiceBillingMethodId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing method identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":[4]},"billBankAccount":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["12345678/1234"]},"billIban":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop IBAN on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ650800000000123456789"]},"billBic":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank code - SWIFT on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["GIBACZPX"]},"documentRemark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document remark (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Payment for order 2015000001"]}}}}},"id":"schema_585"},"schema_586":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["proofPayments"],"properties":{"proofPayments":{"$ref":"#/components/schemas/proofPaymentDetail"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_586"},"schema_587":{"kind":"json-schema","data":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"taxDate":{"$ref":"#/components/schemas/typeDate","description":"date of tax"},"issueDate":{"$ref":"#/components/schemas/typeDateTimeRequest","description":"date on which was proof payment issued, in ISO 8601 format. Deprecation of required timezone part of datetime, and will be removed in the future"},"varSymbol":{"$ref":"#/components/schemas/typeVarSymbol","description":"variable symbol"},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbolNullable","description":"constant symbol"},"specSymbol":{"$ref":"#/components/schemas/typeSpecSymbolNullable","description":"specific symbol"},"invoiceBillingMethodId":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing method identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/invoice-billing-methods"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice billing methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":[4]},"billBankAccount":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["12345678/1234"]},"billIban":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop IBAN on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ650800000000123456789"]},"billBic":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank code - SWIFT on the bill (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["GIBACZPX"]},"bankAccount":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["12345678/1234"]},"iban":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop IBAN (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CZ650800000000123456789"]},"bic":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank code - SWIFT (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["GIBACZPX"]},"isValid":{"type":"boolean","description":"is proof payment valid?","examples":[true]},"documentRemark":{"type":["string","null"],"description":"remark on the document","examples":["Payment for order 2015000001"]}}}}},"id":"schema_587"},"schema_588":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["proofPayments"],"properties":{"proofPayments":{"type":"array","items":{"$ref":"#/components/schemas/proofPaymentDetail"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_588"},"schema_589":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"unlink":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to unlink the proof of payment from the invoice"},"children":[]}]}]}],"examples":[false]},"closed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to close the proof of payment, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to open the proof of payment"},"children":[]}]}]}],"examples":[false]}}}}},"id":"schema_589"},"schema_590":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"changes":{"type":"array","items":{"type":"object","properties":{"changeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of event that happened with the document."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values are following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"changeTime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time when the event happened. ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format (\"2017-12-12T22:08:01+0100\")."},"children":[]}]}]}]},"code":{"type":"string","description":"identifier (number) of the document, which can be\nused to query about the details."}},"required":["changeType","changeTime","code"],"additionalProperties":false}},"paginator":{"type":"object","properties":{"totalCount":{"type":"integer","description":"total number of available records"},"page":{"type":"integer","description":"current page"},"pageCount":{"type":"integer","description":"total number of available pages"},"itemsOnPage":{"type":"integer","description":"number of currently returned records"},"itemsPerPage":{"type":"integer","description":"required number of records per page"}},"required":["totalCount","page","pageCount","itemsOnPage","itemsPerPage"],"additionalProperties":false}},"required":["changes","paginator"],"additionalProperties":false},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_590"},"schema_591":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/relatedProduct"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_591"},"schema_592":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["alternativeProduct"],"additionalProperties":false,"properties":{"alternativeProduct":{"type":"object","additionalProperties":false,"required":["guid"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"GUID of new the alternative product"}}}}}}},"id":"schema_592"},"schema_593":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["alternativeProducts"],"additionalProperties":false,"properties":{"alternativeProducts":{"type":"array","description":"Array of new alternative products, minimum 0 item, maximum 50 items on request","minItems":0,"maxItems":50,"items":{"type":"object","required":["guid"],"additionalProperties":false,"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited"}}}}}}}},"id":"schema_593"},"schema_594":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["brands","paginator"],"properties":{"brands":{"type":"array","items":{"$ref":"#/components/schemas/brand"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_594"},"schema_595":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/brandCreate"}}},"id":"schema_595"},"schema_596":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/brand"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_596"},"schema_597":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Brand name","examples":["Willy Wonka"]},"indexName":{"type":"string","description":"unique index name of brand","examples":["willy-wonka"]},"brandWeb":{"type":["string","null"],"minLength":1,"maxLength":200,"description":"Brand website","examples":["https://willywonka.com"]},"postalAddress":{"type":["string","null"],"minLength":1,"maxLength":65535,"description":"GPSR, postal address","examples":["Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789"]},"contactEmail":{"type":["string","null"],"minLength":1,"maxLength":100,"description":"GPSR, contact email","examples":["willywonka@shoptet.cz"]},"europeanResellerPostalAddress":{"type":["string","null"],"minLength":1,"maxLength":65535,"description":"GPSR, european reseller postal address","examples":["Chocolate Factory, 1234 Candy Lane, Sweet City, SC 56789"]},"europeanResellerContactEmail":{"type":["string","null"],"minLength":1,"maxLength":100,"description":"GPSR, reseller contact email","examples":["europeanreseller@shoptet.cz"]},"manufacturingCompanyName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"GPSR, manufacturing company name","examples":["Shoptet a.s."]},"europeanResellerManufacturingCompanyName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"GPSR, Reseller manufacturing company name","examples":["Shoptet a.s."]},"showInCategoriesMenu":{"type":"boolean","description":"Is this brand shown in categories menu?","examples":[true]},"showInBrandList":{"type":"boolean","description":"Is this brand shown in brand list?","examples":[true]},"description":{"type":["string","null"],"description":"Description of brand. May contain HTML characters","examples":["

Brand new chocolate everyday

"]},"metaTitle":{"type":["string","null"],"description":"Meta title of brand","examples":["Willy Wonka"]},"metaDescription":{"type":["string","null"],"description":"Meta description of brand","examples":["Brand new chocolate everyday"]}}}}},"id":"schema_597"},"schema_598":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["pricelists"],"properties":{"pricelists":{"type":"array","items":{"$ref":"#/components/schemas/pricelist"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_598"},"schema_599":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"Name of the pricelist","examples":["Hlavní ceník"]}}}}},"id":"schema_599"},"schema_600":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/pricelist"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_600"},"schema_601":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["pricelist"],"properties":{"pricelist":{"type":"array","items":{"$ref":"#/components/schemas/pricelistDetail"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_601"},"schema_602":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/pricelistUpdate"}}},"id":"schema_602"},"schema_603":{"kind":"json-schema","data":{"type":"number"},"id":"schema_603"},"schema_604":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["jobId"],"properties":{"jobId":{"examples":["ad24xod"],"description":"token of job","type":"string"}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_604"},"schema_605":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["products","paginator"],"properties":{"products":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","name","type","url","visibility","brand","defaultCategory","creationTime","changeTime","supplier"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"unique product indicator"},"name":{"type":"string","description":"product name","examples":["Pelle 1978"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["product"]},"url":{"type":["string","null"],"examples":["https://www.your-eshop.cz/pelle-1978"]},"visibility":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visibility of product ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"normal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ...) - see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["normal"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of product creation (date in ISO 8601 format)"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of last product change (date in ISO 8601 format)"},"brand":{"oneOf":[{"$ref":"#/components/schemas/brandNamed"},{"type":"null"}],"description":"product brand (or manufacturer, possibly)"},"supplier":{"oneOf":[{"$ref":"#/components/schemas/supplier"},{"type":"null"}],"description":"product supplier"},"defaultCategory":{"type":"object","additionalProperties":false,"description":"default product category","required":["guid","name","visible"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category unique identifier (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"name":{"type":["string","null"],"description":"category description","examples":["Watches"]},"visible":{"type":["boolean","null"],"description":"whether the parameter is visible","examples":[true]}}},"mainImage":{"type":["object","null"],"additionalProperties":false,"required":["name","seoName","cdnName","signedCdnNames","priority","description","changeTime"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image information (filled in only on request. if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=images"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is defined)"},"children":[]}]}]}],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image file name, also serves as an identifier for the image of the product. To assemble complete URL, it is added to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" obtained from the endpoint e-shop info "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["100.jpg"]},"seoName":{"type":"string","description":"file name modified for SEO - a short label is attached.","examples":["100_purple-apple.jpg"]},"cdnName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seoName with signed CDN query parameters for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"big"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cut. Combine with the cut's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form the full URL. Old-format URLs (bare hash) remain valid on the CDN."},"children":[]}]}]}],"examples":["100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"]},"signedCdnNames":{"type":["array","null"],"items":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string"},"name":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-cut signed CDN filenames. Combine each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value with the matching cut's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form a correctly-signed URL. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when cut configuration is temporarily unavailable."},"children":[]}]}]}],"examples":[[{"type":"big","name":"100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"},{"type":"thumbnail","name":"100_purple-apple.jpg?ff=1&x=300&y=300&q=85&ts=59393c3a&sg=ab12cd34"}]]},"priority":{"type":"integer","description":"the key for the sequence of images matching the sequence in administration - it's not necessarily from the first, and the series may contain gaps.","examples":[1]},"description":{"type":["string","null"],"description":"image label","examples":["Fresh purple apple for Snow White"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"last image change time If you are saving images together, you can use this timestamp to indicate if you need to reload the image."}}},"voteAverageScore":{"$ref":"#/components/schemas/typeAmountNullable","description":"Average score of product reviews","examples":[2.6]},"voteCount":{"type":["integer","null"],"description":"Count of product reviews","examples":[16]},"preauthorizationRequired":{"type":"boolean","description":"whether the preauthorization is required; available only if shoptet pay module is enabled","examples":[true]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_605"},"schema_606":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["name","defaultCategoryGuid","variants"],"additionalProperties":false,"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Product GUID. Must be unique if set."},"type":{"type":"string","enum":["product","bazar","service","product-set"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product type. Optional, default value 'product'. Please note that 'product-set' requires 'sets' module to be enabled. Enum - see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["product","bazar","service","product-set"]},"visibility":{"type":"string","enum":["hidden","visible","blocked","show-registered","block-unregistered","cash-desk-only","detail-only"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility. Optional, default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Enum - see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-visibility"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product visibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["hidden"]},"name":{"type":"string","minLength":1,"maxLength":250,"description":"Product's name. Mandatory. Maximal length of 250 characters.","examples":["Velká čokoláda"]},"adult":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the product is for adults only. Optional, default value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"shortDescription":{"type":["string","null"],"description":"Product's short description.","examples":["Velice kvalitní a dobrá čokoláda."]},"description":{"type":["string","null"],"description":"Product's full description.","examples":["

Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. Neobsahuje arašídy.

"]},"additionalName":{"type":["string","null"],"maxLength":150,"description":"Product's additional name. Optional. Maximal length of 150 characters.","examples":["Velice kvalitní a dobrá čokoláda."]},"metaTitle":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Product's seo title. Maximal length of 255 characters.","examples":["Velice kvalitní a dobrá čokoláda."]},"metaDescription":{"type":["string","null"],"description":"Product's full description.","examples":["Velice kvalitní a dobrá čokoláda. Chutná vždy dobře. Neobsahuje arašídy."]},"conditionGrade":{"type":["string","null"],"minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grade condition of second-hand product. Allowed only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"examples":["used"]},"conditionDescription":{"type":["string","null"],"minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition description of second-hand product. Allowed only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bazar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"examples":["Without original package."]},"defaultCategoryGuid":{"$ref":"#/components/schemas/typeGuid","description":"Product's default category's GUID. Mandatory."},"brandCode":{"type":"string","minLength":1,"description":"Product's brand indexName/code. Must exist if set.","examples":["milka"]},"internalNote":{"type":"string","minLength":1,"description":"Product internal note.","examples":["Internal note for product manager."]},"preauthorizationRequired":{"type":"boolean","description":"whether the preauthorization is required; available only if shoptet pay module is enabled","examples":[true]},"hsCode":{"$ref":"#/components/schemas/typeHsCodeNullable"},"supplierGuid":{"$ref":"#/components/schemas/typeGuid","minLength":1,"description":"Supplier GUID. Must exist if set."},"categoryGuids":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/typeGuid"}},"warrantyId":{"type":["integer","null"],"description":"Warranty ID.","examples":[1]},"flags":{"type":"array","description":"Must exist if set.","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","description":"flag identifier.","examples":["new"]},"dateFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"Date from which the flag is valid."},"dateTo":{"$ref":"#/components/schemas/typeDateNullable","description":"Date to which the flag is valid."}}}},"descriptiveParameters":{"type":"array","description":"Product descriptive parameters.","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Parameter name.","examples":["Material"]},"value":{"type":["string","null"],"description":"value of the descriptive parameter.","examples":["Cotton"]},"description":{"type":["string","null"],"description":"Description of the descriptive parameter.","examples":["Material the shirt is made of"]},"priority":{"type":["integer","null"],"maximum":99999,"description":"Priority of the parameter.","examples":[1]}}}},"filteringParameters":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["code","values"],"properties":{"code":{"type":"string","minLength":1,"maxLength":255,"description":"Filtering parameter code.","examples":["action"]},"values":{"type":"array","minItems":1,"description":"Product filtering parameter values.","items":{"type":"string"},"examples":[["Action"]]}}}},"surchargeParameters":{"type":"array","minItems":1,"description":"Product surcharge parameters. Not allowed for products with multiple tax classes.","items":{"$ref":"#/components/schemas/productRequestSurchargeParameter"}},"variants":{"type":"array","description":"Product's variants","minItems":1,"items":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/typeVariantCodeRequest"},"ean":{"type":["string","null"],"maxLength":255,"description":"Variant's ean.","examples":["8594001234567"]},"unitId":{"type":"integer","description":"Variant's unit id. Optional","examples":[-1]},"weight":{"$ref":"#/components/schemas/typeWeightRequest","description":"Variant's weight in kilograms. 3 decimal places, and maximum value of 99999.999.","examples":["13.500"]},"width":{"$ref":"#/components/schemas/typeDimension","description":"width of the product in cm. 1 decimal place, maximum 9999.9."},"height":{"$ref":"#/components/schemas/typeDimension","description":"height of the product in cm. 1 decimal place, maximum 9999.9."},"depth":{"$ref":"#/components/schemas/typeDimension","description":"depth of the product in cm. 1 decimal place, maximum 9999.9."},"visible":{"type":"boolean","description":"Is variant visible?","examples":[true]},"price":{"$ref":"#/components/schemas/typePrice","description":"Product price.","examples":["123.45"]},"currencyCode":{"$ref":"#/components/schemas/typeCurrencyCode"},"manufacturerCode":{"type":["string","null"],"maxLength":32,"description":"Variant's manufacturer code.","examples":["OKI"]},"pluCode":{"type":["string","null"],"maxLength":16,"description":"Variant's plu.","examples":["0828"]},"isbn":{"type":["string","null"],"maxLength":32,"description":"Variant's ISBN.","examples":["978-80-251-0000-0"]},"serialNo":{"type":["string","null"],"maxLength":32,"description":"Variant's serial number.","examples":["B412"]},"mpn":{"type":["string","null"],"maxLength":32,"description":"Variant's MPN.","examples":["H3T5-87"]},"availabilityId":{"type":["integer","null"],"description":"Product availability id","examples":[-1]},"availabilityWhenSoldOutId":{"type":["integer","null"],"description":"Product availability id when not stocked","examples":[-3]},"parameters":{"type":"array","description":"Variant's parameters","items":{"type":"object","additionalProperties":false,"required":["nameIndex","valueIndex"],"properties":{"nameIndex":{"type":"string","description":"indexName of parameter name","examples":["color"]},"valueIndex":{"type":"string","description":"indexName of parameter value","examples":["red"]}}}},"minStockSupply":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"Minimum stock supply.","examples":["10.000"]},"stocksLocations":{"type":"array","description":"Locations and amounts in stocks.","items":{"type":"object","additionalProperties":false,"required":["stockId"],"properties":{"stockId":{"type":"integer","description":"Id of stock. Required if stocksLocations is set. Must fit existing stock Id. Check List of Stocks.","examples":[1]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"Current quantity in stock. 0 if not set.","examples":[50]},"location":{"type":"string","maxLength":255,"description":"Stock location.","examples":["H6/M11/R13"]}}}},"negativeStockAllowed":{"type":"boolean","description":"Product stock can be in negative numbers","examples":[true]},"measureUnit":{"$ref":"#/components/schemas/measureUnit","description":"Product variant measure and packaging units."},"recyclingFeeId":{"type":["integer","null"],"description":"Product recycling fee id","examples":[123]},"consumptionTaxId":{"type":["integer","null"],"description":"Product consumption tax identifier","examples":[1]},"amountDecimalPlaces":{"type":"integer","enum":[0,1,2,3],"description":"Amount of product variant decimal places.","examples":[2]},"atypicalBilling":{"type":"boolean","description":"Has atypical billing?","examples":[true]},"atypicalShipping":{"type":"boolean","description":"Has atypical shipping?","examples":[true]},"boxRestriction":{"type":"boolean","description":"When enabled, pickup lockers cannot be selected in the cart.","examples":[true],"default":false},"ossVatLevels":{"type":"array","description":"OSS Tax setup. Available in OSS mode only.","items":{"type":"object","additionalProperties":false,"required":["countryCode","taxLevel"],"properties":{"countryCode":{"type":"string","maxLength":2,"description":"Country code","examples":["CZ"]},"taxLevel":{"enum":["high","low","third","none","superLow","parking"],"description":"Tax level type. Use Enums: high: Standard tax rate, none: Zero tax rate, low: First reduced tax rate, third: Second reduced tax rate, superLow: Super low tax rate, parking: Parking tax rate.","examples":["high"]}}}}}}},"indexName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String which defines product url. Value is sanitized to fits url needs = All characters except [a-zA-Z0-9_] will be converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If value is not present, indexName is created from product name."},"children":[]}]}]}],"examples":["baleriny-modre-s-puntiky"],"minLength":1},"relatedVideos":{"type":"array","description":"Product related videos.","items":{"type":"object","additionalProperties":false,"required":["code","type"],"properties":{"code":{"type":"string","maxLength":32,"description":"related video code.","examples":["zpvmPA3me7o"]},"title":{"type":["string","null"],"maxLength":128,"description":"related video title.","examples":["Test video"]},"type":{"enum":["youtube","youtube-short"],"description":"related video type.","examples":["youtube"]}}}}}}}},"id":"schema_606"},"schema_607":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["product"],"properties":{"product":{"$ref":"#/components/schemas/product"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_607"},"schema_608":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","minProperties":1,"additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product`s name. Maximal length of 250 characters. Mandatory."},"children":[]}]}]}],"examples":["Velká čokoláda"]},"isVisible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determine whether the copied product will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is optional; if not set, the visibility will be inherited from the source product."},"children":[]}]}]}],"examples":[true]},"copyProperties":{"type":"object","additionalProperties":false,"description":"Properties to copy. All properties are optional; if not set, the default value is true.","minProperties":1,"properties":{"generalData":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy general data, which includes 'shortDescription', 'description', 'internalNote', 'manufacturer', 'warranty', 'supplier', 'itemType' and 'visibility' (if not set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isVisible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property)."},"children":[]}]}]}],"examples":[true]},"images":{"type":"boolean","description":"Whether to copy product gallery images.","examples":[true]},"images360":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy product 360° gallery images."},"children":[]}]}]}],"examples":[true]},"pricelist":{"type":"boolean","description":"Whether to copy the pricelist with all settings, including any variants from the source product.","examples":[true]},"categories":{"type":"boolean","description":"Whether to copy all categories.","examples":[true]},"properties":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy properties, which includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descriptiveParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"related":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy all related properties. It includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only when the relatedProducts module is active), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternativeProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternativeProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module is active), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedVideos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedVideos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module is active), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedGifts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gifts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module is active) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (only when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downPayments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module is active)."},"children":[]}]}]}],"examples":[true]},"advanced":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy advanced properties like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metaDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appendix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"xmlFeedName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seoTitle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IPlatba"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PayOnline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"adult"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryPairing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryPairing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" settings for Google, Glami, Heureka, Zbozi.cz will be copied."},"children":[]}]}]}],"examples":[true]},"stocks":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy stocks. Available only with active "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module. The pricelist must be also setted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in order for the stock requirements to be copied."},"children":[]}]}]}],"examples":[true]},"globalSaleVat":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy global sale VAT. Available only with active "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Global Sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module."},"children":[]}]}]}],"examples":[true]},"zboziCzSettings":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy Zboží.cz settings. Available only with active "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Seznam"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module."},"children":[]}]}]}],"examples":[true]},"heurekaSettings":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy Heureka settings. Available only with active "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HeurekaCZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module."},"children":[]}]}]}],"examples":[true]},"categoryPairing":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to copy category pairing settings for Google, Glami, Heureka, Zbozi.cz. Property "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"advanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]}}}}}}},"id":"schema_608"},"schema_609":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/product"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_609"},"schema_610":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/product"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"id":"schema_610"},"schema_611":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/productUpdate"}}},"id":"schema_611"},"schema_612":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["batchFileUrlPath"],"properties":{"batchFileUrlPath":{"type":"string","description":"Url to batch file with product images data. File must be in JSONL format.","examples":["https://cdn.myshoptet.com/batch-product-images-delete.jsonl"]},"removeReference":{"type":"boolean","default":false,"description":"When true, images referenced by product variants are deleted and the variant reference is cleared automatically. When false (default), a referenced single image is refused (the row is logged as an error), and referenced images are skipped when deleting all images of a gallery."}}},"id":"schema_612"},"schema_613":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["changes","paginator"],"properties":{"changes":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","changeTime","changeType"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"product identifier that can be used to query about the customer''s details."},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time, when the event happened. ISO 8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-12-12T22:08:01+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"changeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of event that happened with the entity. Possible values are following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["add"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_613"},"schema_614":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["availabilities","defaultAvailabilities"],"properties":{"availabilities":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","description","color","system","onStockInHours","deliveryInHours","googleAvailability"],"properties":{"id":{"type":"integer","description":"ID of the availability","examples":[-5]},"name":{"type":"string","description":"Name of the availability","examples":["On request"]},"indexName":{"type":["string","null"],"description":"Code name of the availability","examples":["on-request"]},"description":{"type":["string","null"],"description":"Description of the availability","examples":["Ordered from an external partner, details on request."]},"color":{"type":["string","null"],"description":"Color hex code of the availability","examples":["#cb0000"]},"system":{"type":"boolean","description":"Is availability default (system) and not user made?","examples":[true]},"onStockInHours":{"type":["integer","null"],"description":"When will a product be on stock. (in hours)","examples":[48]},"deliveryInHours":{"type":["integer","null"],"description":"When will a product be delivered. (in hours)","examples":[48]},"googleAvailability":{"type":["object","null"],"additionalProperties":false,"description":"Google availability info","required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of the google availability","examples":[1]},"name":{"type":"string","description":"Name of the google availability","examples":["On stock"]}}}}}},"defaultAvailabilities":{"type":"object","additionalProperties":false,"required":["onStock","soldOutNegativeStockAllowed","soldOutNegativeStockForbidden"],"properties":{"onStock":{"type":["integer","null"],"description":"ID of default availability when product is on stock","examples":[1]},"soldOutNegativeStockAllowed":{"type":["integer","null"],"description":"ID of default availability when sold out and buying sold out products is allowed","examples":[-4]},"soldOutNegativeStockForbidden":{"type":["integer","null"],"description":"ID of default availability when sold out and buying sold out products is forbidden","examples":[-2]}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_614"},"schema_615":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","description":"Name of the availability","examples":["On request"],"minLength":1},"indexName":{"type":["string","null"],"description":"Code name of the availability","examples":["on-request"],"maxLength":16},"description":{"type":["string","null"],"description":"Description of the availability","examples":["Ordered from an external partner, details on request."]},"color":{"$ref":"#/components/schemas/typeColor","description":"Color hex code of the availability","examples":["#cb0000"]},"onStockInHours":{"type":["integer","null"],"description":"When will a product be on stock. (in hours)","examples":[48],"maximum":2500},"deliveryInHours":{"type":["integer","null"],"description":"When will a product be delivered. (in hours)","examples":[48],"maximum":2500},"googleAvailabilityId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the google availability. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (in stock), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (out of stock), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (preorder), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (backorder)."},"children":[]}]}]}],"examples":[1,3,4,5]}}}}},"id":"schema_615"},"schema_616":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["availability"],"properties":{"availability":{"type":"object","additionalProperties":false,"required":["id","name","description","color","system","onStockInHours","deliveryInHours","googleAvailability"],"properties":{"id":{"type":"integer","description":"ID of the availability","examples":[-5]},"name":{"type":"string","description":"Name of the availability","examples":["On request"]},"indexName":{"type":["string","null"],"description":"Code name of the availability","examples":["on-request"]},"description":{"type":["string","null"],"description":"Description of the availability","examples":["Ordered from an external partner, details on request."]},"color":{"type":["string","null"],"description":"Color hex code of the availability","examples":["#cb0000"]},"system":{"type":"boolean","description":"Is availability default (system) and not user made?","examples":[true]},"onStockInHours":{"type":["integer","null"],"description":"When will a product be on stock. (in hours)","examples":[48]},"deliveryInHours":{"type":["integer","null"],"description":"When will a product be delivered. (in hours)","examples":[48]},"googleAvailability":{"type":["object","null"],"additionalProperties":false,"description":"Google availability info","required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of the google availability","examples":[1]},"name":{"type":"string","description":"Name of the google availability","examples":["On stock"]}}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_616"},"schema_617":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"id":"schema_617"},"schema_618":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","description":"Name of the availability","examples":["On request"],"minLength":1},"indexName":{"type":["string","null"],"description":"Code name of the availability","examples":["on-request"],"maxLength":16},"description":{"type":["string","null"],"description":"Description of the availability","examples":["Ordered from an external partner, details on request."]},"color":{"$ref":"#/components/schemas/typeColor","description":"Color hex code of the availability","examples":["#cb0000"]},"onStockInHours":{"type":["integer","null"],"description":"When will a product be on stock. (in hours)","examples":[48],"maximum":2500},"deliveryInHours":{"type":["integer","null"],"description":"When will a product be delivered. (in hours)","examples":[48],"maximum":2500},"googleAvailabilityId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the google availability. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (in stock), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (out of stock), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (preorder), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (backorder)."},"children":[]}]}]}],"examples":[1,3,4,5]}}}}},"id":"schema_618"},"schema_619":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null","additionalProperties":false},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_619"},"schema_620":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["items"],"properties":{"items":{"$ref":"#/components/schemas/productGifts"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_620"},"schema_621":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["giftCode"],"additionalProperties":false,"properties":{"giftCode":{"type":"string","description":"Code of product variant.","examples":["0006"]}}}}},"id":"schema_621"},"schema_622":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["giftCodes"],"additionalProperties":false,"properties":{"giftCodes":{"type":"array","maxItems":50,"description":"array of gift codes.","items":{"type":"object","required":["code"],"additionalProperties":false,"properties":{"code":{"type":"string","description":"Code of product variant.","examples":["0006"]}}}}}}}},"id":"schema_622"},"schema_623":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["images"],"properties":{"images":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","priority","description","changeTime","seoName","cdnName","signedCdnNames","isMainImage","gallery"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image file name, also serves as an identifier for the image of the product. To assemble complete URL, it is added to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" obtained from the endpoint e-shop info "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["product-image-1.jpg"]},"priority":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the key for the sequence of images matching the sequence in administration - it''s not necessarily from the first, and the series may contain gaps. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[10]},"description":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image label (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Fresh purple apple for Snow White"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last image change time If you are saving images together, you can use this timestamp to indicate if you need to reload the image. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"seoName":{"type":"string","description":"file name modified for SEO - a short label is attached.","examples":["100_purple-apple.jpg"]},"cdnName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seoName with signed CDN query parameters for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"big"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cut. Combine with the cut''s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form the full URL. Old-format URLs (bare hash) remain valid on the CDN."},"children":[]}]}]}],"examples":["100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"]},"signedCdnNames":{"type":["array","null"],"items":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string"},"name":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-cut signed CDN filenames. Combine each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value with the matching cut''s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form a correctly-signed URL. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when cut configuration is temporarily unavailable."},"children":[]}]}]}],"examples":[[{"type":"big","name":"100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"},{"type":"thumbnail","name":"100_purple-apple.jpg?ff=1&x=300&y=300&q=85&ts=59393c3a&sg=ab12cd34"}]]},"isMainImage":{"type":"boolean"},"gallery":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of the gallery the image belongs to (e.g. \"shop\" for the standard product gallery, \"shop360\" for the 360° gallery); matches the gallery segment in the image URL."},"children":[]}]}]}],"examples":["shop"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_623"},"schema_624":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["images"],"properties":{"images":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"description":"Name of image.","examples":["127.png"]},"priority":{"type":"integer","minimum":1,"maximum":65535,"description":"Image priority.","examples":[100]},"description":{"type":"string","description":"Image description.","examples":["Dobrá čokoláda"]}}}}}}}},"id":"schema_624"},"schema_625":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["images"],"properties":{"images":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","priority","description","changeTime","seoName","cdnName","signedCdnNames","isMainImage","gallery"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image file name, also serves as an identifier for the image of the product. To assemble complete URL, it is added to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urlPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" obtained from the endpoint e-shop info "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["100_purple-apple.jpg"]},"priority":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the key for the sequence of images matching the sequence in administration - it''s not necessarily from the first, and the series may contain gaps. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[10]},"description":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image label (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Fresh purple apple for Snow White"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last image change time If you are saving images together, you can use this timestamp to indicate if you need to reload the image. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"seoName":{"type":"string","description":"file name modified for SEO - a short label is attached.","examples":["100_purple-apple.jpg"]},"cdnName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seoName with signed CDN query parameters for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"big"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cut. Combine with the cut''s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form the full URL. Old-format URLs (bare hash) remain valid on the CDN."},"children":[]}]}]}],"examples":["100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"]},"signedCdnNames":{"type":["array","null"],"items":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string"},"name":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-cut signed CDN filenames. Combine each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value with the matching cut''s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cdnPath"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/eshop?include=imageCuts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to form a correctly-signed URL. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when cut configuration is temporarily unavailable."},"children":[]}]}]}],"examples":[[{"type":"big","name":"100_purple-apple.jpg?ff=1&x=1024&y=768&q=85&ts=59393c3a&sg=df3f0411"},{"type":"thumbnail","name":"100_purple-apple.jpg?ff=1&x=300&y=300&q=85&ts=59393c3a&sg=ab12cd34"}]]},"isMainImage":{"type":"boolean"},"gallery":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of the gallery the image belongs to (e.g. \"shop\" for the standard product gallery, \"shop360\" for the 360° gallery); matches the gallery segment in the image URL."},"children":[]}]}]}],"examples":["shop"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_625"},"schema_626":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["images"],"properties":{"images":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","additionalProperties":false,"required":["sourceUrl"],"properties":{"sourceUrl":{"type":"string","minLength":1,"maxLength":2000,"description":"URL of the image.","examples":["https://www.your-eshop.com/cokolada.jpg"]},"priority":{"type":"integer","minimum":1,"maximum":65535,"description":"Image priority.","examples":[100]},"description":{"type":"string","description":"Image description.","examples":["Dobrá čokoláda"]}}}}}}}},"id":"schema_626"},"schema_627":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["images"],"properties":{"images":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["name","sourceUrl"],"properties":{"name":{"type":"string","minLength":1,"description":"Name of the image","examples":["127.png"]},"sourceUrl":{"type":"string","minLength":1,"maxLength":2000,"description":"URL of the image","examples":["https://www.your-eshop.com/cokolada.jpg"]},"priority":{"type":"integer","minimum":1,"maximum":99999,"description":"Priority of the image","examples":[1]},"description":{"type":"string","description":"Description of the image","examples":["Dobrá čokoláda"]}}}}}}}},"id":"schema_627"},"schema_628":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["relatedProduct"],"additionalProperties":false,"properties":{"relatedProduct":{"type":"object","additionalProperties":false,"required":["guid"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"Guid of new related product"}}}}}}},"id":"schema_628"},"schema_629":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["relatedProducts"],"additionalProperties":false,"properties":{"relatedProducts":{"type":"array","minItems":0,"maxItems":50,"description":"Array of new related products, minimum 0 item, maximum 50 items on request","items":{"type":"object","additionalProperties":false,"required":["guid"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"Guid of new related product"}}}}}}}},"id":"schema_629"},"schema_630":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["sourceFileName"],"properties":{"sourceFileName":{"type":"string","minLength":1,"maxLength":255,"description":"Source file name uploaded to temporary storage or url path to external file","examples":["productsheet.pdf","https://cdn.myshoptet.com/productsheet.pdf"]},"description":{"type":"string","description":"File description.","examples":["Product technical sheet"]}}}}},"id":"schema_630"},"schema_631":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["relatedFiles"],"properties":{"relatedFiles":{"type":"array","description":"files related to product","items":{"type":"object","additionalProperties":false,"required":["id","name","url","size"],"properties":{"id":{"type":"integer","description":"Related file id","examples":[426]},"name":{"type":["string","null"],"description":"related file title","examples":["Example file"]},"url":{"type":"string","description":"related file URL","examples":["https://www.domena-eshopu.cz/user/related_files/example-file.txt"]},"size":{"type":["integer","null"],"description":"related file size","examples":[1024]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_631"},"schema_632":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["setItem"],"additionalProperties":false,"properties":{"setItem":{"type":"object","additionalProperties":false,"required":["code","amount"],"properties":{"code":{"type":"string","description":"product variant identifier","examples":["0008"]},"amount":{"$ref":"#/components/schemas/typePositiveAmount"}}}}}}},"id":"schema_632"},"schema_633":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["items"],"properties":{"items":{"type":["array","null"],"description":"information about items, products, in set","items":{"$ref":"#/components/schemas/productSet"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_633"},"schema_634":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["setItems"],"additionalProperties":false,"properties":{"setItems":{"type":"array","minItems":0,"maxItems":50,"description":"Array of new products assigned to set, minimum 0 item, maximum 50 items on request","items":{"type":"object","additionalProperties":false,"required":["code","amount"],"properties":{"code":{"type":"string","description":"product variant identifier","examples":["0008"]},"amount":{"$ref":"#/components/schemas/typePositiveAmount"}}}}}}}},"id":"schema_634"},"schema_635":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["items","paginator"],"properties":{"items":{"type":"array","items":{"type":"object","properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Shipment GUID"},"orderCode":{"type":["string","null"],"description":"Order code","examples":["2024000008"]},"sender":{"$ref":"#/components/schemas/shipmentSenderRecipientAddress","description":"Sender address."},"recipient":{"$ref":"#/components/schemas/shipmentSenderRecipientAddress","description":"Recipient address."},"carrierAddress":{"$ref":"#/components/schemas/shipmentAddress","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[DEPRECATED] use sender."},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment status, for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/shipment-statuses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["requested"]},"shipmentType":{"type":"string","enum":["standard","return"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment type. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a return label (customer sends goods back to the shop)."},"children":[]}]}]}],"examples":["standard"]},"serviceCode":{"type":"string","description":"Service code","examples":["logistics-ppl-parcel-cz-private-home-delivery"]},"cod":{"$ref":"#/components/schemas/shipmentCoDPrice","description":"Cash on delivery"},"value":{"$ref":"#/components/schemas/shipmentPrice","description":"total cost sum of products inside of shipment"},"customer":{"$ref":"#/components/schemas/shipmentCustomer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[DEPRECATED] use recipient."},"children":[]}]}]}]},"packages":{"type":"array","items":{"$ref":"#/components/schemas/shipmentPackage"}},"note":{"type":["string","null"],"description":"Shipment note","examples":["This is a note"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_635"},"schema_636":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"required":["orderCode"],"properties":{"orderCode":{"type":"string","description":"Order code","examples":["2024000008"]},"note":{"type":["string","null"],"description":"shipment note","examples":["shipment note"]},"cod":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COD price of shipment. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted, COD is resolved from the order. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"0.00\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", COD is overridden to no COD regardless of the order. Any other value overrides the COD amount."},"children":[]}]}]}]},"shippingId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipping ID; required; you can get this ID via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/delivery/getshipmentshippingoptionsbyordercode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment shipping options"},"children":[]}]}]}]}],"examples":[250]},"addressId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address ID; required; you can get this ID via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/delivery/getshipmentshippingoptionsbyordercode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment shipping options"},"children":[]}]}]}]}],"examples":[1]},"bankAccountId":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shipper bank account ID; optional, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" send"},"children":[]}]}]}],"examples":[1]},"packages":{"type":["array","null"],"minItems":1,"description":"shipment packages; at least one package is required","items":{"oneOf":[{"type":"object","additionalProperties":false,"required":["orderPackagingId"],"properties":{"orderPackagingId":{"type":"integer","description":"packaging ID; required if sent","examples":[3]}}},{"type":"object","additionalProperties":false,"required":["packaging","weight"],"properties":{"packaging":{"type":"integer","description":"packaging ID; required if sent","examples":[6]},"weight":{"type":["string","null","integer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package weight; required, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["1.00"]}}},{"type":"object","additionalProperties":false,"required":["width","height","depth","weight"],"properties":{"width":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package width; required, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[10]},"height":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package height; required, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[20]},"depth":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package depth; required, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":[10]},"weight":{"type":["string","null","integer"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package weight; required, can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"examples":["1.00"]}}}]}}}}}},"id":"schema_636"},"schema_637":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"properties":{"guid":{"type":"string","description":"Shipment GUID","examples":["1e3f3f32-3f3f-6766-3f3f-02423f1f0004"]},"checkUrls":{"type":["array","null"],"description":"URL to check and create blocking request until shipment is done. This feature is not available by default and this field is always null. To enable this feature consult your use case with your Shoptet contact.","examples":[["https://example.com/check-shipment-example?ids=123"]],"items":{"type":"string"}}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_637"},"schema_638":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"}}},"id":"schema_638"},"schema_639":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["guid","carrierAddress","status","shipmentType","serviceCode","customer","packages"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Shipment GUID"},"orderCode":{"type":["string","null"],"description":"Order code","examples":["2024000008"]},"sender":{"$ref":"#/components/schemas/shipmentSenderRecipientAddress","description":"Sender address."},"recipient":{"$ref":"#/components/schemas/shipmentSenderRecipientAddress","description":"Recipient address."},"carrierAddress":{"$ref":"#/components/schemas/shipmentAddress","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[DEPRECATED] use sender."},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment status, for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/shipment-statuses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment statuses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["requested"]},"shipmentType":{"type":"string","enum":["standard","return"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment type. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a return label (customer sends goods back to the shop)."},"children":[]}]}]}],"examples":["standard"]},"serviceCode":{"type":"string","description":"Service code","examples":["logistics-ppl-parcel-cz-private-home-delivery"]},"cod":{"$ref":"#/components/schemas/shipmentCoDPrice","description":"Cash on delivery"},"value":{"$ref":"#/components/schemas/shipmentPrice","description":"total cost sum of products inside of shipment"},"customer":{"$ref":"#/components/schemas/shipmentCustomer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[DEPRECATED] use recipient."},"children":[]}]}]}]},"packages":{"type":"array","items":{"$ref":"#/components/schemas/shipmentPackageWithHistory"}},"note":{"type":["string","null"],"description":"Shipment note","examples":["This is a note"]}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_639"},"schema_640":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"}},"example":{"data":null,"errors":[{"errorCode":"shipment-not-found","message":"Shipment with guid \"93bc0dbe-7481-11e8-8216-002590dad85e\"\nnot found.","instance":"payload"}]}},"id":"schema_640"},"schema_641":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"}},"example":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unknown error.","instance":"integration-call"}]}},"id":"schema_641"},"schema_642":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["shippingOptions"],"properties":{"shippingOptions":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["shippingId","methodName","maxShipment","carrierAddresses","bankAccounts"],"properties":{"shippingId":{"type":"integer","description":"Shipping ID","examples":[258]},"methodName":{"type":"string","description":"Shipping method name","examples":["PPL (Shoptet Logistics) CZ Smart"]},"carrierCode":{"type":"string","description":"Carrier code","examples":["logistics-ppl"]},"serviceCode":{"type":"string","description":"Service code","examples":["logistics-ppl-parcel-cz-private-home-delivery"]},"maxShipment":{"type":"integer","description":"Maximum number of shipments","examples":[3]},"carrierAddresses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","address"],"properties":{"id":{"type":"integer","description":"shipper address identifier","examples":[1]},"address":{"type":"string","description":"shipper address string","examples":["PPL CZ, a.s., U Pergamenky 1522/2, Praha 7, 170 00"]}}}},"bankAccounts":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","bankAccount"],"properties":{"id":{"type":"integer","description":"shipper bank account identifier","examples":[1]},"bankAccount":{"type":"string","description":"shipper bank account (IBAN)","examples":["CZ6508000000192000145399"]}}}},"branch":{"type":"string","description":"shipping branch","examples":["integration"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_642"},"schema_643":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"}},"example":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2024000008\" not found.","instance":"2024000008"}]}},"id":"schema_643"},"schema_644":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["shipmentCarriers"],"additionalProperties":false,"properties":{"shipmentCarriers":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Shipment carrier ID","examples":[110]},"name":{"type":"string","description":"Shipment carrier name","examples":["PPL"]},"code":{"type":"string","description":"Shipment carrier code","examples":["logistics-ppl"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of carrier, for possible values see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/shipment-carrier-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipment carrier types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["integration"]},"hasHomeDelivery":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if carrier supports home delivery"},"children":[]}]}]}]},"hasPickupPoints":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if carrier supports pickup points"},"children":[]}]}]}]},"hasCollection":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if carrier supports collection (pickup from sender)"},"children":[]}]}]}]},"maxWeight":{"type":"integer","description":"max weight of shipment","examples":[30]},"activationStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"activation status, possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activation_in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]}]}]}],"examples":["active"]},"countries":{"type":"array","items":{"$ref":"#/components/schemas/shipmentCarrierCountry"}}}}}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_644"},"schema_645":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["name","description","services","activationStatus","methods"],"properties":{"name":{"type":"string","description":"Shipment carrier name","examples":["PPL"]},"description":{"type":"string","description":"Shipment carrier description","examples":["Carrier description"]},"services":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["serviceId","name","description","deliveryType","hasCollection","countries"],"properties":{"serviceId":{"type":"integer","description":"carrier service identifier","examples":[171]},"name":{"type":"string","description":"carrier service name","examples":["Parcel CZ Business"]},"description":{"type":"string","description":"Carrier service description","examples":["Carrier service description"]},"deliveryType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery type, possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pickup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pallet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"electronic"},"children":[]}]}]}],"examples":["address"]},"hasCollection":{"type":"boolean","description":"determines whether collection can be ordered","examples":[true]},"countries":{"type":"array","items":{"$ref":"#/components/schemas/shipmentCarrierCountry"}}}}},"activationStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"activation status, possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activation_in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]}]}]}],"examples":["active"]},"methods":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["methodId","serviceName","methodName","groupName","state"],"properties":{"methodId":{"type":"integer","description":"carrier method identifier","examples":[171]},"serviceName":{"type":"string","description":"carrier service name","examples":["Parcel CZ Smart"]},"methodName":{"type":"string","description":"carrier method name","examples":["PPL (Shoptet Logistics) CZ Smart"]},"groupName":{"type":"string","description":"carrier method group name","examples":["Maloobchod"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state of carrier method, possible values are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visible"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]}]}]}],"examples":["visible"]}}}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/shipmentAddress"}},"bankAccounts":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","logisticsBankAccountId","carrierId","countryCode","currencyCode","isDefault","iban"],"properties":{"id":{"type":"integer","description":"carrier bank account identifier","examples":[171]},"logisticsBankAccountId":{"type":"integer","description":"carrier logistics bank account identifier","examples":[10]},"carrierId":{"type":"integer","description":"carrier identifier","examples":[110]},"countryCode":{"type":"string","description":"bank account country code","examples":["CZ"]},"currencyCode":{"type":"string","description":"bank account currency code","examples":["CZK"]},"isDefault":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if carrier bank account is set as default"},"children":[]}]}]}]},"iban":{"type":"string","description":"bank account IBAN","examples":["CZ6508000000000192834123"]},"bban":{"type":["string","null"],"description":"bank account BBAN","examples":["19-2000145399/0800"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_645"},"schema_646":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"}},"example":{"data":null,"errors":[{"errorCode":"shipment-carrier-not-found","message":"Carrier ID \"110\" of type \"integration\" not found.","instance":"payload"}]}},"id":"schema_646"},"schema_647":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"}},"example":{"data":null,"errors":[{"errorCode":"shipment-carrier-type-invalid-type","message":"Invalid type \"invalidType\" given. Valid values are \"core,\nexternal, integration, integration_product_contract,\nbalikobot, system\".","instance":"payload"}]}},"id":"schema_647"},"schema_648":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"}},"example":{"data":null,"errors":[{"errorCode":"shipment-carrier-not-found","message":"Carrier ID \"110\" not found.","instance":"payload"}]}},"id":"schema_648"},"schema_649":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"}},"example":{"data":null,"errors":[{"errorCode":"closing-shipments-failed","message":"Unable to close shipments for carrier ID \"110\".","instance":"payload"}]}},"id":"schema_649"},"schema_650":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["customers","paginator"],"properties":{"customers":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","creationTime","billCompany","billFullName","changeTime","adminUrl"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"Customer GUID"},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"registration date"},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of last change"},"billCompany":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of the company (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Manak Delicacies"]},"billFullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name of the customer (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["George Manak"]},"adminUrl":{"type":"string","description":"link to the customer details in administration","examples":["https://www.domena-eshopu.cz/admin/zakaznici-detail?id=16"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_650"},"schema_651":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["account"],"minProperties":1,"properties":{"remark":{"type":["string","null"],"minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark for the customer (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["remark"]},"priceRatio":{"minLength":1,"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional discount - 4 decimal places accuracy, (from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), 0.7800 = discount 22%; 1.0000 = no discount"},"children":[]}]}]}]},"birthDate":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date of birth. In YYYY-MM-DD format. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["1974-03-14"]},"disabledOrders":{"type":"boolean","description":"Ordering disabled? If so, newly created orders will be cancelled automatically.","examples":[true]},"customerGroupCode":{"type":"string","minLength":1,"description":"customer group code, group must exists if set.","examples":["retail"]},"pricelistId":{"type":"integer","description":"Price list identifier","examples":[1]},"billingAddress":{"$ref":"#/components/schemas/billingAddressCustomer","description":"billing address"},"account":{"type":"object","additionalProperties":false,"required":["email"],"properties":{"fullName":{"type":["string","null"],"minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Jan Novak"]},"email":{"type":"string","minLength":1,"maxLength":128,"description":"email address","examples":["jan.novak@gmail.com"]},"phone":{"type":["string","null"],"minLength":1,"maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["420777888999"]},"authorized":{"type":"boolean","description":"Is the account authorized? Default: true","examples":[true]},"emailVerified":{"type":"boolean","description":"Is the email verified by eshop owner? Needed for pairing orders created in past. Default: false","examples":[true]}}}}}}},"id":"schema_651"},"schema_652":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["customer"],"properties":{"customer":{"$ref":"#/components/schemas/customer"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_652"},"schema_653":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"remark":{"type":["string","null"],"minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remark for the customer (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["remark"]},"priceRatio":{"minLength":1,"$ref":"#/components/schemas/typePriceRatio","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional discount - 4 decimal places accuracy, (from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), 0.7800 = discount 22%; 1.0000 = no discount"},"children":[]}]}]}]},"birthDate":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date of birth. In YYYY-MM-DD format. (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["1974-03-14"]},"disabledOrders":{"type":"boolean","description":"Ordering disabled? If so, newly created orders will be cancelled automatically.","examples":[true]},"customerGroupCode":{"type":"string","minLength":1,"description":"customer group code, group must exists if set.","examples":["retail"]},"pricelistId":{"type":"integer","description":"Price list identifier","examples":[1]},"billingAddress":{"$ref":"#/components/schemas/billingAddressCustomer","description":"billing address"}}}}},"id":"schema_653"},"schema_654":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["changes","paginator"],"properties":{"changes":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","changeTime","changeType"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"customer identifier that can be used to query about the details of the customer."},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time, when the event happened. ISO 8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-12-12T22:08:01+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"changeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of event that happened with the entity. Possible values are following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["edit"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_654"},"schema_655":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["regions"],"properties":{"regions":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","regionName","regionShortcut","countryCode"],"properties":{"id":{"type":"integer","description":"customer region ID","examples":[1]},"regionName":{"type":"string","description":"customer region name","examples":["Minas Gerais"]},"regionShortcut":{"type":["string","null"],"description":"customer region shortcut","examples":["MG"]},"countryCode":{"type":"string","examples":["CZ"],"description":"two letter country code"}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_655"},"schema_656":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["accounts","paginator"],"properties":{"accounts":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","fullName","email","phone","mainAccount","authorized","emailVerified"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"The unique identifier of the account."},"fullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Jan Novak"]},"email":{"type":"string","description":"email address","examples":["jan.novak@gmail.com"]},"phone":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["420777888999"]},"mainAccount":{"type":"boolean","description":"Is this account the main account?","examples":[true]},"authorized":{"type":"boolean","description":"Is the account authorized? Default: true","examples":[true]},"emailVerified":{"type":"boolean","description":"Is the email verified by eshop owner? Needed for pairing orders created in past. Default: false","examples":[true]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_656"},"schema_657":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["email"],"properties":{"fullName":{"type":["string","null"],"minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Jan Novak"]},"email":{"type":"string","minLength":1,"maxLength":128,"description":"email address","examples":["jan.novak@gmail.com"]},"phone":{"type":["string","null"],"minLength":1,"maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["420777888999"]},"mainAccount":{"type":"boolean","description":"Is this account the main account?","examples":[true]},"authorized":{"type":"boolean","description":"Is the account authorized? Default: true","examples":[true]},"emailVerified":{"type":"boolean","description":"Is the email verified by eshop owner? Needed for pairing orders created in past. Default: false","examples":[true]}}}}},"id":"schema_657"},"schema_658":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["account"],"properties":{"account":{"type":"object","additionalProperties":false,"required":["guid","fullName","email","phone","mainAccount","authorized","emailVerified"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"The unique identifier of the account."},"fullName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Jan Novak"]},"email":{"type":"string","description":"email address","examples":["jan.novak@gmail.com"]},"phone":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["420777888999"]},"mainAccount":{"type":"boolean","description":"Is this account the main account?","examples":[true]},"authorized":{"type":"boolean","description":"Is the account authorized? Default: true","examples":[true]},"emailVerified":{"type":"boolean","description":"Is the email verified by eshop owner? Needed for pairing orders created in past. Default: false","examples":[true]}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_658"},"schema_659":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"fullName":{"type":["string","null"],"minLength":1,"maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Jan Novak"]},"email":{"type":"string","minLength":1,"maxLength":128,"description":"email address","examples":["jan.novak@gmail.com"]},"phone":{"type":["string","null"],"minLength":1,"maxLength":30,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["420777888999"]},"mainAccount":{"type":"boolean","description":"Is this account the main account?","examples":[true]},"authorized":{"type":"boolean","description":"Is the account authorized? Default: true","examples":[true]},"emailVerified":{"type":"boolean","description":"Is the email verified by eshop owner? Needed for pairing orders created in past. Default: false","examples":[true]}}}}},"id":"schema_659"},"schema_660":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["deliveryAddresses","paginator"],"properties":{"deliveryAddresses":{"type":"array","items":{"$ref":"#/components/schemas/deliveryAddressCustomer"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_660"},"schema_661":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"required":["countryCode"],"properties":{"fullName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Lard"]},"company":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard Shop"]},"street":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard street"]},"houseNumber":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"house number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["5647"]},"city":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Čelákovice"]},"district":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Prague-East"]},"additional":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional info (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Arcade"]},"zip":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP/postal code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["25088"]},"countryCode":{"type":"string","minLength":1,"description":"customer's country code","examples":["CZ"]},"regionName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Central Bohemia"]},"isDefault":{"type":"boolean","examples":[true]}}}}},"id":"schema_661"},"schema_662":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["deliveryAddress"],"properties":{"deliveryAddress":{"$ref":"#/components/schemas/deliveryAddressCustomer"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_662"},"schema_663":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"fullName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Lard"]},"company":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard Shop"]},"street":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Lard street"]},"houseNumber":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"house number (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["5647"]},"city":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Čelákovice"]},"district":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Prague-East"]},"additional":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional info (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Arcade"]},"zip":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP/postal code (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["25088"]},"countryCode":{"type":"string","minLength":1,"description":"customer's country code","examples":["CZ"]},"regionName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Central Bohemia"]},"isDefault":{"type":"boolean","examples":[true]}}}}},"id":"schema_663"},"schema_664":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["customerGroups"],"properties":{"customerGroups":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","customerGroupCode","description","defaultPricelistId","maxDiscount","priority","emailNotification","authRequired","registrationAllowed","wholesale","tableLayout","fullProfileRequired","defaultDueDays","defaultOrderStatusId"],"properties":{"id":{"type":"integer","description":"Customer group ID","examples":[1]},"name":{"type":"string","description":"Customer group name","examples":["Wholesale customers"]},"customerGroupCode":{"type":["string","null"],"description":"index name of customer group used to identify group while insert/edit customer","examples":["wholesale"]},"description":{"type":["string","null"],"description":"description of customer group.","examples":["Wholesale customers are the best customers"]},"defaultPricelistId":{"type":["integer","null"],"description":"ID of default pricelist for this group","examples":[1]},"maxDiscount":{"oneOf":[{"$ref":"#/components/schemas/typePriceRatio"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ratio of maximal discount (0.5500 -> 55% max discount). Maximum 0.9999. Null when no maximal discount is set."},"children":[]}]}]}],"examples":["0.5500"]},"priority":{"type":["integer","null"],"description":"Priority of customer group","examples":[100]},"emailNotification":{"type":"boolean","description":"whether e-mail will be sent on new customer registration in this group.","examples":[true]},"authRequired":{"type":"boolean","description":"whether authorization of new customer by eshop administrator is be required","examples":[true]},"registrationAllowed":{"type":"boolean","description":"whether customers can register to this group.","examples":[true]},"wholesale":{"type":"boolean","description":"whether customers and their orders in this group are marked as wholesale","examples":[true]},"tableLayout":{"type":"boolean","description":"whether table layout will be shown instead to classical layout. Might not be supported by all templates.","examples":[true]},"fullProfileRequired":{"type":"boolean","description":"whether full profile is needed for customer.","examples":[true]},"defaultDueDays":{"type":["integer","null"],"description":"Default maturity for documents in days","examples":[14]},"defaultOrderStatusId":{"type":["integer","null"],"description":"ID of the default order status for orders placed by customers in this group.","examples":[-2]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_664"},"schema_665":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","description":"Customer group name","minLength":1,"maxLength":255,"examples":["Wholesale customers"]},"description":{"type":["string","null"],"description":"Description of customer group","examples":["Wholesale customers are the best customers"]},"defaultPricelistId":{"type":["integer","null"],"description":"ID of default pricelist for this group","examples":[1]},"emailNotification":{"type":"boolean","description":"Whether e-mail will be sent on new customer registration in this group. Can only be enabled when wholesale module is active.","default":false,"examples":[true]},"authRequired":{"type":"boolean","description":"Whether authorization of new customer by eshop administrator is required. Can only be enabled when wholesale module is active.","default":false,"examples":[true]},"maxDiscount":{"type":["string","null"],"pattern":"[0-9]+\\.[0-9]{4}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ratio of maximal discount (0.5500 -> 55% max discount)"},"children":[]}]}]}],"examples":["0.5500","0.9999"]},"defaultDueDays":{"type":["integer","null"],"description":"Default maturity for documents in days (0-365)","minimum":0,"maximum":365,"examples":[14]},"registrationAllowed":{"type":"boolean","description":"Whether customers can register to this group. Requires wholesale module to be active.","default":true,"examples":[true]},"wholesale":{"type":"boolean","description":"Whether customers and their orders in this group are marked as wholesale. Requires wholesale module to be active.","default":false,"examples":[true]},"tableLayout":{"type":"boolean","description":"Whether table layout will be shown instead to classical layout. Might not be supported by all templates. Requires wholesale module to be active.","default":false,"examples":[true]},"fullProfileRequired":{"type":"boolean","description":"Whether full profile (billing information and address) is needed for customer. Requires wholesale module to be active.","default":false,"examples":[true]},"defaultOrderStatusId":{"type":["integer","null"],"description":"Default order status ID for orders placed by customers in this group.","examples":[-2]}}}}},"id":"schema_665"},"schema_666":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["customerGroups"],"properties":{"customerGroups":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","customerGroupCode","description","defaultPricelistId","maxDiscount","priority","emailNotification","authRequired","registrationAllowed","wholesale","tableLayout","fullProfileRequired","defaultDueDays","defaultOrderStatusId"],"properties":{"id":{"type":"integer","description":"Customer group ID","examples":[1]},"name":{"type":"string","description":"Customer group name","examples":["Wholesale customers"]},"customerGroupCode":{"type":["string","null"],"description":"index name of customer group used to identify group while insert/edit customer","examples":["wholesale"]},"description":{"type":["string","null"],"description":"description of customer group.","examples":["Wholesale customers are the best customers"]},"defaultPricelistId":{"type":["integer","null"],"description":"ID of default pricelist for this group","examples":[1]},"maxDiscount":{"oneOf":[{"$ref":"#/components/schemas/typePriceRatio"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ratio of maximal discount (0.5500 -> 55% max discount). Maximum 0.9999. Null when no maximal discount is set."},"children":[]}]}]}],"examples":["0.5500"]},"priority":{"type":["integer","null"],"description":"Priority of customer group","examples":[100]},"emailNotification":{"type":"boolean","description":"whether e-mail will be sent on new customer registration in this group.","examples":[true]},"authRequired":{"type":"boolean","description":"whether authorization of new customer by eshop administrator is be required","examples":[true]},"registrationAllowed":{"type":"boolean","description":"whether customers can register to this group.","examples":[true]},"wholesale":{"type":"boolean","description":"whether customers and their orders in this group are marked as wholesale","examples":[true]},"tableLayout":{"type":"boolean","description":"whether table layout will be shown instead to classical layout. Might not be supported by all templates.","examples":[true]},"fullProfileRequired":{"type":"boolean","description":"whether full profile is needed for customer.","examples":[true]},"defaultDueDays":{"type":["integer","null"],"description":"Default maturity for documents in days","examples":[14]},"defaultOrderStatusId":{"type":["integer","null"],"description":"ID of the default order status for orders placed by customers in this group.","examples":[-2]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_666"},"schema_667":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":["object","null"],"additionalProperties":false},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_667"},"schema_668":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","description":"Customer group name","minLength":1,"maxLength":255,"examples":["Wholesale customers"]},"description":{"type":["string","null"],"description":"Description of customer group","examples":["Wholesale customers are the best customers"]},"defaultPricelistId":{"type":["integer","null"],"description":"ID of default pricelist for this group","examples":[1]},"emailNotification":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether e-mail will be sent on new customer registration in this group. This option can only be enabled if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module is active or for the default group."},"children":[]}]}]}],"examples":[true]},"authRequired":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether authorization of new customer by eshop administrator is required. This option can only be enabled if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module is active or for the default group."},"children":[]}]}]}],"examples":[true]},"maxDiscount":{"type":["string","null"],"pattern":"[0-9]+\\.[0-9]{4}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ratio of maximal discount (0.5500 -> 55% max discount)"},"children":[]}]}]}],"examples":["0.5500","0.9999"]},"defaultDueDays":{"type":["integer","null"],"description":"Default maturity for documents in days (0-365)","minimum":0,"maximum":365,"examples":[14]},"registrationAllowed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether customers can register to this group. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module to be active and cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the default group."},"children":[]}]}]}],"examples":[true]},"wholesale":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether customers and their orders in this group are marked as wholesale. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module to be active."},"children":[]}]}]}],"examples":[true]},"tableLayout":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether table layout will be shown instead to classical layout. Might not be supported by all templates. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module to be active."},"children":[]}]}]}],"examples":[true]},"fullProfileRequired":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether full profile (billing information and address) is needed for customer. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wholesale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module to be active."},"children":[]}]}]}],"examples":[true]},"defaultOrderStatusId":{"type":["integer","null"],"description":"ID of the default order status for orders placed by customers in this group.","examples":[-2]}}}}},"id":"schema_668"},"schema_669":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["remarks","paginator"],"properties":{"remarks":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","rating","remark"],"properties":{"id":{"type":"integer","description":"uniq identification number","examples":[1]},"rating":{"type":"string","description":"type of rating","examples":["positive"]},"remark":{"type":"string","description":"customer remark","examples":["Order payment delays"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_669"},"schema_670":{"kind":"json-schema","data":{"type":"object","properties":{"schema":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["rating","remark"],"properties":{"rating":{"type":"string","minLength":1,"maxLength":255,"description":"type of rating","examples":["negative"]},"remark":{"type":"string","minLength":1,"description":"Your remark, note, for customer","examples":["Top customer"]}}}}}}},"id":"schema_670"},"schema_671":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["remark"],"properties":{"remark":{"type":"object","additionalProperties":false,"required":["id","rating","remark"],"properties":{"id":{"type":"integer","description":"uniq identification number","examples":[1]},"rating":{"type":"string","description":"type of rating","examples":["positive"]},"remark":{"type":"string","description":"customer remark","examples":["Order payment delays"]}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_671"},"schema_672":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"rating":{"type":"string","minLength":1,"maxLength":255,"description":"type of rating","examples":["negative"]},"remark":{"type":"string","minLength":1,"description":"Your remark, note, for customer","examples":["Top customer"]}}}}},"id":"schema_672"},"schema_673":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["articles","paginator"],"properties":{"articles":{"type":"array","items":{"$ref":"#/components/schemas/articleList"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_673"},"schema_674":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["title","defaultSectionId"],"properties":{"title":{"type":"string","description":"Title of the article","examples":["Test"]},"language":{"type":"string","description":"Language of the article. Available and settable only if module Foreign languages is active and initialized.","examples":["cs"]},"defaultSectionId":{"type":"integer","description":"Id of the section","examples":[682]},"sectionIds":{"type":"array","description":"Id of the section","minItems":1,"items":{"type":"integer","examples":[682]}},"indexName":{"type":"string","description":"ending part of article URL","examples":["test"]},"redirectUrl":{"type":["string","null"],"description":"canonical URL for redirecting","examples":["https://www.someurl.com"]},"content":{"type":["string","null"],"description":"Content of the article","examples":["

Content of the article

"]},"metaTitle":{"type":["string","null"],"description":"Meta title of the article","examples":["Test article"]},"metaKeywords":{"type":["string","null"],"description":"DEPRECATED - Keywords of the article","examples":["test"],"deprecated":true},"metaDescription":{"type":["string","null"],"description":"Meta description of the article","examples":["Test article"]},"publishDate":{"$ref":"#/components/schemas/typeDateTimeRequest","description":"Date of publishing - test. Deprecation of required timezone part of datetime, and will be removed in the future"},"visible":{"type":"boolean","description":"Flag whether the article is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out","admin-only"],"description":"Flag indicating, whether the article can be viewed by everyone (value of the flag is: 'all'), by logged in users only ('logged-in'), by logged out users only ('logged-out'), or by administrators only ('admin-only')","examples":["logged-in"]},"sourceImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]},"sourceOgImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article open-graph image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]}}}}},"id":"schema_674"},"schema_675":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["article"],"additionalProperties":false,"properties":{"article":{"$ref":"#/components/schemas/article"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_675"},"schema_676":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"title":{"type":"string","description":"Title of the article","examples":["Test"]},"language":{"type":"string","description":"Language of the article. Available and settable only if module Foreign languages is active and initialized.","examples":["cs"]},"defaultSectionId":{"type":"integer","description":"Id of the section","examples":[682]},"sectionIds":{"type":"array","description":"Id of the section","minItems":1,"items":{"type":"integer","examples":[682]}},"indexName":{"type":"string","description":"ending part of article URL","examples":["test"]},"redirectUrl":{"type":["string","null"],"description":"canonical URL for redirecting","examples":["https://www.someurl.com"]},"content":{"type":["string","null"],"description":"Content of the article","examples":["

Content of the article

"]},"metaTitle":{"type":["string","null"],"description":"Meta title of the article","examples":["Test article"]},"metaKeywords":{"type":["string","null"],"description":"DEPRECATED - Keywords of the article","examples":["test"],"deprecated":true},"metaDescription":{"type":["string","null"],"description":"Meta description of the article","examples":["Test article"]},"publishDate":{"$ref":"#/components/schemas/typeDateTimeRequest","description":"Date of publishing. Deprecation of required timezone part of datetime, and will be removed in the future"},"visible":{"type":"boolean","description":"Flag whether the article is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out","admin-only"],"description":"Flag indicating, whether the article can be viewed by everyone (value of the flag is: 'all'), by logged in users only ('logged-in'), by logged out users only ('logged-out'), or by administrators only ('admin-only')","examples":["logged-in"]},"sourceImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]},"sourceOgImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article open-graph image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]}}}}},"id":"schema_676"},"schema_677":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["sections"],"properties":{"sections":{"type":"array","items":{"$ref":"#/components/schemas/articleSectionList"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_677"},"schema_678":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"required":["title"],"properties":{"title":{"type":"string","description":"article section title","examples":["Test"]},"language":{"type":"string","description":"Article section language. Available and settable only if module Foreign languages is active and initialized.","examples":["cs"]},"parentId":{"type":["integer","null"],"description":"ID of the parent article section. Maximum nesting depth of article section is 4 nodes.","examples":[1]},"indexName":{"type":["string","null"],"description":"ending part of article section URL","examples":["new-article"]},"description":{"type":["string","null"],"description":"article section content","examples":["

Content of the article section

"]},"secondDescription":{"type":["string","null"],"description":"article section second content","examples":["

Content of the second article section

"]},"limit":{"type":["integer","null"],"description":"Number of articles displayed in the listing","examples":[4]},"homepageLimit":{"type":["integer","null"],"description":"Number of articles displayed on the homepage","examples":[4]},"sorting":{"enum":["alphabetically","newest-first","oldest-first"],"description":"Article sorting in the listing","examples":["alphabetically"]},"perexLimit":{"type":["integer","null"],"description":"Number of character displayed in the article perex","examples":[100]},"hidePublishDate":{"type":"boolean","description":"Hide article publish date in the listing","examples":[false]},"showPrevNext":{"type":"boolean","description":"Show next/previous buttons in the listing","examples":[true]},"showOnHomepage":{"type":"boolean","description":"Show articles on the homepage","examples":[false]},"linkText":{"type":["string","null"],"description":"Link text (in the menu)","examples":["Test articles"]},"metaTitle":{"type":["string","null"],"description":"article meta title","examples":["Test articles"]},"metaDescription":{"type":["string","null"],"description":"article meta description","examples":["Test articles"]},"visible":{"type":"boolean","description":"flag whether the article section is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag indicating, whether the article section can be viewed by everyone (value of the flag is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), by logged in users only ('logged-in'), or by logged out users only ('logged-out')"},"children":[]}]}]}],"examples":["logged-in"]},"sourceImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article section image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]},"sourceOgImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article section open-graph image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]}}}}},"id":"schema_678"},"schema_679":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["articleSection"],"additionalProperties":false,"properties":{"articleSection":{"$ref":"#/components/schemas/articleSection"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_679"},"schema_680":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"title":{"type":"string","description":"article section title","examples":["Test"]},"language":{"type":"string","description":"Article section language. Available and settable only if module Foreign languages is active and initialized.","examples":["cs"]},"indexName":{"type":["string","null"],"description":"ending part of article section URL","examples":["new-article"]},"description":{"type":["string","null"],"description":"article section content","examples":["

Content of the article section

"]},"secondDescription":{"type":["string","null"],"description":"article section second content","examples":["

Content of the second article section

"]},"limit":{"type":["integer","null"],"description":"Number of articles displayed in the listing","examples":[4]},"homepageLimit":{"type":["integer","null"],"description":"Number of articles displayed on the homepage","examples":[4]},"sorting":{"enum":["alphabetically","newest-first","oldest-first"],"description":"Article sorting in the listing","examples":["alphabetically"]},"perexLimit":{"type":["integer","null"],"description":"Number of character displayed in the article perex","examples":[100]},"hidePublishDate":{"type":"boolean","description":"Hide article publish date in the listing","examples":[false]},"showPrevNext":{"type":"boolean","description":"Show next/previous buttons in the listing","examples":[true]},"showOnHomepage":{"type":"boolean","description":"Show articles on the homepage","examples":[false]},"linkText":{"type":["string","null"],"description":"Link text (in the menu)","examples":["Test articles"]},"metaTitle":{"type":["string","null"],"description":"article meta title","examples":["Test articles"]},"metaDescription":{"type":["string","null"],"description":"article meta description","examples":["Test articles"]},"visible":{"type":"boolean","description":"flag whether the article section is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag indicating, whether the article section can be viewed by everyone (value of the flag is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), by logged in users only ('logged-in'), or by logged out users only ('logged-out')"},"children":[]}]}]}],"examples":["logged-in"]},"sourceImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article section image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]},"sourceOgImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article section open-graph image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]}}}}},"id":"schema_680"},"schema_681":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["settings"],"additionalProperties":false,"properties":{"settings":{"type":"array","items":{"$ref":"#/components/schemas/discussionSettings"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_681"},"schema_682":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["discussion","paginator"],"additionalProperties":false,"properties":{"discussion":{"type":"array","items":{"$ref":"#/components/schemas/discussionPost"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_682"},"schema_683":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","maxItems":100,"items":{"type":"object","required":["email","content","authorized"],"additionalProperties":false,"properties":{"parentId":{"type":["integer","null"],"minimum":1,"description":"Discussion post parent identifier.","examples":[1]},"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"Discussion post product identifier."},"articleId":{"type":["integer","null"],"minimum":1,"description":"Discussion post article identifier.","examples":[2]},"pageId":{"type":["integer","null"],"minimum":1,"description":"Discussion post page identifier.","examples":[3]},"customerGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"Discussion post customer identifier."},"name":{"type":["string","null"],"maxLength":128,"description":"Name of the author.","examples":["John Doe"]},"email":{"type":"string","maxLength":100,"format":"email","description":"Email of the author.","examples":["john.doe@example.com"]},"title":{"type":["string","null"],"maxLength":255,"description":"Title of the post.","examples":["Some title"]},"content":{"type":"string","minLength":1,"description":"Content of the post.","examples":["Some content"]},"creationDate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date and time of the post creation. If not provided, current date and time is used."},"authorized":{"type":"boolean","description":"Flag whether the post is authorized (visible on the web).","examples":[true]}}}}}},"id":"schema_683"},"schema_684":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":["object","null"]},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"additionalProperties":false},"id":"schema_684"},"schema_685":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":["string","null"],"minLength":1,"maxLength":128,"description":"Name of the author.","examples":["John Doe"]},"email":{"type":"string","minLength":1,"maxLength":100,"format":"email","description":"Email of the author.","examples":["john.doe@example.com"]},"title":{"type":["string","null"],"maxLength":255,"description":"Title of the post.","examples":["Some title"]},"content":{"type":"string","minLength":1,"description":"Content of the post.","examples":["Some content"]},"creationDate":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date and time of the discussion post creation."},"authorized":{"type":"boolean","description":"Flag whether the post is authorized (visible on the web).","examples":[true]}}}}},"id":"schema_685"},"schema_686":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["discussion"],"additionalProperties":false,"properties":{"discussion":{"$ref":"#/components/schemas/discussionPost"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_686"},"schema_687":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["pages","paginator"],"properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/pageList"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_687"},"schema_688":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"required":["title"],"properties":{"title":{"minLength":1,"maxLength":255,"type":"string","description":"page title","examples":["Test"]},"indexName":{"type":"string","minLength":1,"maxLength":255,"description":"ending part of page URL","examples":["new-page"],"pattern":"^[a-zA-Z0-9\\-]*$"},"description":{"type":["string","null"],"description":"page content","examples":["

Content of the page

"]},"linkText":{"type":["string","null"],"description":"page title in the menu","examples":["Test menu title"]},"metaTitle":{"type":["string","null"],"description":"page meta title","examples":["Test page"]},"metaDescription":{"type":["string","null"],"description":"page meta description","examples":["Test page description"]},"canonicalUrl":{"type":["string","null"],"description":"canonical URL of the page","examples":["https://example.com/canonical-url"]},"visible":{"type":"boolean","description":"flag whether the page is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out","admin-only"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag indicating, whether the page can be viewed by everyone (value of the flag is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), by logged in users only ('logged-in'), by logged out users only ('logged-out'), or by administrators only ('admin-only')"},"children":[]}]}]}],"examples":["logged-in"]},"sourceOgImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article open-graph image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]}}}}},"id":"schema_688"},"schema_689":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["page"],"additionalProperties":false,"properties":{"page":{"$ref":"#/components/schemas/page"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_689"},"schema_690":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"title":{"minLength":1,"maxLength":255,"type":"string","description":"page title","examples":["Test"]},"indexName":{"type":"string","minLength":1,"maxLength":255,"description":"ending part of page URL","examples":["new-page"],"pattern":"^[a-zA-Z0-9\\-]*$"},"description":{"type":["string","null"],"description":"page content","examples":["

Content of the page

"]},"linkText":{"type":["string","null"],"description":"page title in the menu","examples":["Test menu title"]},"metaTitle":{"type":["string","null"],"description":"page meta title","examples":["Test page"]},"metaDescription":{"type":["string","null"],"description":"page meta description","examples":["Test page description"]},"canonicalUrl":{"type":["string","null"],"description":"canonical URL of the page","examples":["https://example.com/canonical-url"]},"visible":{"type":"boolean","description":"flag whether the page is visible on web","examples":[true]},"access":{"enum":["all","logged-in","logged-out","admin-only"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag indicating, whether the page can be viewed by everyone (value of the flag is: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), by logged in users only ('logged-in'), by logged out users only ('logged-out'), or by administrators only ('admin-only')"},"children":[]}]}]}],"examples":["logged-in"]},"sourceOgImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as article open-graph image. When set to null, image will be removed."},"children":[]}]}]}],"examples":["image.png"]}}}}},"id":"schema_690"},"schema_691":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["showDiscussion","authorizationType","onlyRegisteredUsers","commentAndFullNameRequired","sendConfirmationEmail","showVerificationInfo","reviewsPerPage","storeRatingEnabled","storeRatingCommentsRequired","storeRatingShowVerificationInfo","verificationIconAllowed"],"additionalProperties":false,"properties":{"showDiscussion":{"type":"boolean","description":"Whether the advanced product rating with discussion is shown on the product detail.","examples":[true]},"authorizationType":{"enum":["required","not_required","not_required_verified"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approval mode for product reviews: 'required' - every review must be authorized; 'not_required' - reviews are published without authorization; 'not_required_verified' - authorization is not required for verified purchases."},"children":[]}]}]}],"examples":["required"]},"onlyRegisteredUsers":{"type":"boolean","description":"Whether only registered (logged-in) customers may submit a product review. When true, anonymous reviews are not allowed.","examples":[false]},"commentAndFullNameRequired":{"type":"boolean","description":"Whether a comment and full name are required to submit a product review.","examples":[false]},"sendConfirmationEmail":{"type":"boolean","description":"Whether a confirmation email is sent to the author after submitting a product review.","examples":[false]},"showVerificationInfo":{"type":"boolean","description":"Whether information about verification is shown next to product reviews.","examples":[false]},"reviewsPerPage":{"type":"integer","description":"Number of product reviews displayed per page on the storefront.","examples":[20]},"storeRatingEnabled":{"type":"boolean","description":"Whether store (project) rating is enabled.","examples":[true]},"storeRatingCommentsRequired":{"type":"boolean","description":"Whether a comment and name are required to submit a store rating.","examples":[false]},"storeRatingShowVerificationInfo":{"type":"boolean","description":"Whether information about verification is shown next to the store rating.","examples":[false]},"verificationIconAllowed":{"type":"boolean","description":"Feature flag that gates the display of the verification icon/information for reviews.","examples":[false]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_691"},"schema_692":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["reviews","paginator"],"properties":{"reviews":{"type":"array","items":{"type":"object","required":["id","guid","date","orderCode","rating","productName","productGuid","description","fullName","email","customerGuid","authorized","visible","reaction","updated"],"properties":{"id":{"type":"integer","description":"Review id.","examples":[1]},"guid":{"$ref":"#/components/schemas/typeGuid"},"date":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Review creation date."},"orderCode":{"type":["null","string"],"description":"Order code related to review. Can be null.","examples":["2011000002"]},"rating":{"type":"integer","description":"Number from 1 to 5 representing starts of review's rating.","examples":[5]},"productName":{"type":"string","description":"Product name related to review.","examples":["Snack"]},"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"Product guid related to review."},"description":{"type":["null","string"],"examples":["Snack was very good"]},"fullName":{"type":["null","string"],"description":"Fullname of review's author. Can be null.","examples":["John Doe"]},"email":{"type":["null","string"],"description":"Email of the review author. If it's a registered customer and the review email is empty, it's filled with the customer's main account email. Can be null.","examples":["johndoe@email.tld"]},"customerGuid":{"type":["null","string"],"description":"Customer guid related to review. Can be null.","examples":["443cad54-73bc-11e8-8216-002590dad85e"]},"authorized":{"type":"boolean","examples":[true]},"visible":{"type":"boolean","examples":[false]},"reaction":{"type":"object","additionalProperties":false,"required":["reactionCreated","reactionFullName","reactionEmail","reactionText"],"properties":{"reactionCreated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date of creation of reaction. Can be null."},"reactionFullName":{"type":["null","string"],"examples":["John Doe"]},"reactionEmail":{"type":["null","string"],"examples":["johndoe@email.tld"]},"reactionText":{"type":["null","string"],"examples":["Thank you for your review!"]}}},"updated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Timestamp whenever the rating is changed"}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_692"},"schema_693":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["productGuid","rating"],"properties":{"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"Product guid related to review."},"date":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Review creation date."},"fullName":{"type":["string","null"],"minLength":1,"maxLength":64,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Jan Novak"]},"email":{"type":"string","minLength":5,"maxLength":100,"description":"email address","examples":["jan.novak@gmail.com"]},"description":{"type":["null","string"],"examples":["Snack was very good"]},"rating":{"type":"integer","minimum":1,"maximum":5,"description":"Number from 1 to 5 representing starts of review's rating.","examples":[5]},"customerGuid":{"type":["null","string"],"description":"Customer guid related to review. Can be null.","examples":["443cad54-73bc-11e8-8216-002590dad85e"]},"orderCode":{"type":["null","string"],"description":"Order code related to review. Can be null.","examples":["2011000002"]},"ipAddress":{"type":["string","null"],"maxLength":255,"description":"IP address of the client who made the review","examples":["213.46.237.24"]},"reaction":{"type":"object","additionalProperties":false,"properties":{"reactionCreated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date of creation of reaction. Can be null."},"reactionFullName":{"type":["null","string"],"examples":["John Doe"]},"reactionEmail":{"type":["null","string"],"minLength":5,"maxLength":100,"examples":["johndoe@email.tld"]},"reactionText":{"type":["null","string"],"examples":["Thank you for your review!"]}}}}}}},"id":"schema_693"},"schema_694":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["guid","date","orderCode","rating","productName","productGuid","description","fullName","email","customerGuid","authorized","visible","reaction","updated"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid"},"date":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Review creation date."},"orderCode":{"type":["null","string"],"description":"Order code related to review. Can be null.","examples":["2011000002"]},"rating":{"type":"integer","description":"Number from 1 to 5 representing starts of review's rating.","examples":[5]},"productName":{"type":"string","description":"Product name related to review.","examples":["Snack"]},"productGuid":{"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}],"description":"Product guid related to review."},"description":{"type":["null","string"],"examples":["Snack was very good"]},"fullName":{"type":["null","string"],"description":"Fullname of review's author. Can be null.","examples":["John Doe"]},"email":{"type":["null","string"],"description":"Email of the review author. If it's a registered customer and the review email is empty, it's filled with the customer's main account email. Can be null.","examples":["johndoe@email.tld"]},"ipAddress":{"type":["string","null"],"description":"IP address of the client who made the review. Can be null.","examples":["213.46.237.24"]},"customerGuid":{"type":["null","string"],"description":"Customer guid related to review. Can be null.","examples":["443cad54-73bc-11e8-8216-002590dad85e"]},"authorized":{"type":"boolean","examples":[true]},"visible":{"type":"boolean","examples":[false]},"reaction":{"type":"object","additionalProperties":false,"required":["reactionCreated","reactionFullName","reactionEmail","reactionText"],"properties":{"reactionCreated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date of creation of reaction. Can be null."},"reactionFullName":{"type":["null","string"],"examples":["John Doe"]},"reactionEmail":{"type":["null","string"],"examples":["johndoe@email.tld"]},"reactionText":{"type":["null","string"],"examples":["Thank you for your review!"]}}},"updated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Timestamp whenever the rating is changed"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_694"},"schema_695":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"description":{"type":["null","string"],"description":"Text of the review. Can be null only if 'Comment is required' setting is disabled.","examples":["Snack was very good"]},"fullName":{"type":["null","string"],"maxLength":64,"description":"Fullname of review's author. Can be null only if 'Comment is required' setting is disabled.","examples":["John Doe"]},"authorized":{"type":"boolean","examples":[false],"description":"flag whether the review is authorized"},"visible":{"type":"boolean","examples":[false],"description":"flag whether the review is visible on web"},"reaction":{"type":"object","additionalProperties":false,"properties":{"reactionFullName":{"type":["null","string"],"maxLength":255,"description":"Fullname of reaction author. Can be null.","examples":["John Doe"]},"reactionEmail":{"type":["null","string"],"minLength":1,"maxLength":100,"description":"Email of the reaction author.","examples":["johndoe@email.tld"]},"reactionText":{"type":["null","string"],"description":"Text of the reaction.","examples":["Thank you for your review!"]}}}}}}},"id":"schema_695"},"schema_696":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["reviews","paginator"],"properties":{"reviews":{"type":"array","items":{"type":"object","required":["id","date","orderCode","rating","description","fullName","email","customerGuid","visible","reaction"],"properties":{"id":{"type":"integer","description":"Review id.","examples":[1]},"date":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Review creation date."},"orderCode":{"type":["null","string"],"description":"Order code related to review. Can be null.","examples":["2011000002"]},"rating":{"type":"integer","description":"Number from 1 to 5 representing starts of review's rating.","examples":[5]},"description":{"type":["null","string"],"examples":["Snack was very good"]},"fullName":{"type":["null","string"],"description":"Fullname of review's author. Can be null.","examples":["John Doe"]},"email":{"type":["null","string"],"description":"Email of the review author. If it's a registered customer and the review email is empty, it's filled with the customer's main account email. Can be null.","examples":["johndoe@email.tld"]},"customerGuid":{"type":["null","string"],"description":"Customer guid related to review. Can be null.","examples":["443cad54-73bc-11e8-8216-002590dad85e"]},"visible":{"type":"boolean","description":"flag, whether the review is visible","examples":[false]},"reaction":{"type":"object","additionalProperties":false,"required":["reactionCreated","reactionFullName","reactionEmail","reactionText"],"properties":{"reactionCreated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date of creation of reaction. Can be null."},"reactionFullName":{"type":["null","string"],"examples":["John Doe"]},"reactionEmail":{"type":["null","string"],"examples":["johndoe@email.tld"]},"reactionText":{"type":["null","string"],"examples":["Thank you for your review!"]}}}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_696"},"schema_697":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["rating"],"additionalProperties":false,"properties":{"date":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Review creation date. Can be null"},"orderCode":{"type":["null","string"],"description":"Order code related to review. Can be null.","examples":["2011000002"]},"rating":{"type":"integer","description":"Number from 1 to 5 representing stars of review's rating.","examples":[5]},"description":{"minLength":1,"type":["null","string"],"description":"Text of the review. Can be null only if 'Comment is required' setting is disabled.","examples":["Snack was very good"]},"fullName":{"type":["null","string"],"minLength":1,"maxLength":255,"description":"Fullname of review's author. Can be null only if 'Comment is required' setting is disabled.","examples":["John Doe"]},"email":{"type":"string","minLength":1,"maxLength":255,"description":"Email of the review author.","examples":["johndoe@email.tld"]},"customerGuid":{"type":["null","string"],"description":"Customer guid related to review. Can be null.","examples":["443cad54-73bc-11e8-8216-002590dad85e"]},"visible":{"type":"boolean","examples":[false],"description":"Flag whether the review is visible on web."},"ipAddress":{"type":["string","null"],"maxLength":255,"description":"IP address of the client who made the review.","examples":["213.46.237.24"]},"reaction":{"type":"object","additionalProperties":false,"properties":{"reactionCreated":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date of creation of reaction. Can be null."},"reactionFullName":{"type":["null","string"],"maxLength":255,"description":"Fullname of reaction author. Can be null.","examples":["John Doe"]},"reactionEmail":{"type":["null","string"],"minLength":1,"maxLength":100,"description":"Email of the reaction author.","examples":["johndoe@email.tld"]},"reactionText":{"type":["null","string"],"description":"Text of the reaction.","examples":["Thank you for your review!"]}}}}}}},"id":"schema_697"},"schema_698":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["review"],"additionalProperties":false,"properties":{"review":{"$ref":"#/components/schemas/reviewProject"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_698"},"schema_699":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"description":{"type":["null","string"],"description":"Text of the review. Can be null only if 'Comment and name is required' setting is disabled.","examples":["Snack was very good"]},"fullName":{"type":["null","string"],"maxLength":255,"description":"Fullname of review's author. Can be null only if 'Comment and name is required' setting is disabled.","examples":["John Doe"]},"visible":{"type":"boolean","examples":[false],"description":"Flag whether the review is visible on web."},"reaction":{"type":"object","additionalProperties":false,"properties":{"reactionFullName":{"type":["null","string"],"maxLength":255,"description":"Fullname of reaction author. Can be null.","examples":["John Doe"]},"reactionEmail":{"type":["null","string"],"minLength":1,"maxLength":100,"description":"Email of the reaction author.","examples":["johndoe@email.tld"]},"reactionText":{"type":["null","string"],"description":"Text of the reaction.","examples":["Thank you for your review!"]}}}}}}},"id":"schema_699"},"schema_700":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["snippets"],"properties":{"snippets":{"type":"array","items":{"type":"object","required":["location","html"],"additionalProperties":false,"properties":{"location":{"type":"string","enum":["common-header","common-footer","order-confirmed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(location) code identifier. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"common-header"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"common-footer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order-confirmed"},"children":[]}]}]}],"examples":["common-header"]},"html":{"type":"string","description":"HTML content included in the specified location","examples":["

My custom HTML

"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_700"},"schema_701":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","required":["snippets"],"additionalProperties":false,"properties":{"snippets":{"type":"array","items":{"type":"object","required":["location","html"],"additionalProperties":false,"properties":{"location":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(location) code identifier. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"common-header"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"common-footer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order-confirmed"},"children":[]}]}]}],"examples":["common-header"]},"html":{"type":"string","maxLength":8192,"description":"HTML content to be included in the specified location","examples":["

My custom HTML

"]}}}}}}}},"id":"schema_701"},"schema_702":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["coupons","paginator"],"properties":{"coupons":{"type":"array","items":{"$ref":"#/components/schemas/discountCoupon"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_702"},"schema_703":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["coupons"],"properties":{"coupons":{"type":"array","description":"Discount coupons. Minimal 1 item, maximal 999 items.","minItems":1,"maxItems":999,"items":{"type":"object","additionalProperties":false,"required":["discountType","template","shippingPrice","reusable"],"properties":{"code":{"type":["string","null"],"minLength":1,"maxLength":16,"description":"Code of discount coupon.","examples":["DISCOUNT10"]},"discountType":{"type":"string","enum":["percentual","fixed"],"description":"Type of discount. Percentual (percentual) or fixed discount (fixed)","examples":["percentual"]},"amount":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of fixed discount (default eshop VAT rate is used). This items needs to be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]}]}]}],"examples":["100.00"]},"ratio":{"type":["string","null"],"pattern":"[0-1]\\.[0-9]{4}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of percentual discount. This items needs to be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 4 decimal places accuracy, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (0% discount) to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (100% discount)."},"children":[]}]}]}],"examples":["0.1000"]},"minPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"Minimum price of order (default eshop VAT rate is used)","examples":["100.00"]},"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of fixed discount. It can be null only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to null"},"children":[]}]}]}],"examples":["CZK"]},"template":{"$ref":"#/components/schemas/typeGuid","description":"GUID of discount coupon template"},"shippingPrice":{"type":"string","enum":["cart","free","beforeDiscount"],"description":"How the transport prices are calculated: according to the cart before discounts (beforeDiscount), according to the displayed value of the cart (cart), or free (free)","examples":["cart"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"Starting date of coupon validity"},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"Ending date of coupon validity"},"reusable":{"type":"boolean","description":"Is the discount coupon reusable?","examples":[true]},"remark":{"type":["string","null"],"description":"Discount coupon note","examples":["This is a discount coupon for the first purchase."]}}}}}}}},"id":"schema_703"},"schema_704":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["coupons"],"properties":{"coupons":{"type":"array","items":{"$ref":"#/components/schemas/discountCoupon"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_704"},"schema_705":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["coupons"],"properties":{"coupons":{"type":"array","description":"Discount coupons. Minimal 1 item, maximal 999 items.","minItems":1,"maxItems":999,"items":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","minLength":1,"maxLength":16,"description":"Code of the discount coupon to update. Used as the identifier.","examples":["DISCOUNT10"]},"discountType":{"type":"string","enum":["percentual","fixed"],"description":"Type of discount. Percentual (percentual) or fixed discount (fixed)","examples":["percentual"]},"amount":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of fixed discount (default eshop VAT rate is used). This items needs to be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]}]}]}],"examples":["100.00"]},"ratio":{"type":["string","null"],"pattern":"[0-1]\\.[0-9]{4}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of percentual discount. This items needs to be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 4 decimal places accuracy, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (0% discount) to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (100% discount)."},"children":[]}]}]}],"examples":["0.1000"]},"minPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"Minimum price of order (default eshop VAT rate is used)","examples":["100.00"]},"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of fixed discount. It can be null only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to null"},"children":[]}]}]}],"examples":["CZK"]},"template":{"$ref":"#/components/schemas/typeGuid","description":"GUID of discount coupon template"},"shippingPrice":{"type":"string","enum":["cart","free","beforeDiscount"],"description":"How the transport prices are calculated: according to the cart before discounts (beforeDiscount), according to the displayed value of the cart (cart), or free (free)","examples":["cart"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"Starting date of coupon validity"},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"Ending date of coupon validity"},"reusable":{"type":"boolean","description":"Is the discount coupon reusable?","examples":[true]},"remark":{"type":["string","null"],"description":"Discount coupon note","examples":["This is a discount coupon for the first purchase."]}}}}}}}},"id":"schema_705"},"schema_706":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"null"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_706"},"schema_707":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_707"},"schema_708":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["couponCodes"],"properties":{"couponCodes":{"type":"array","description":"Discount coupons. Minimal 1 item, maximal 200 items.","minItems":1,"maxItems":200,"items":{"type":"string","examples":["test-code-123","test-code-456"]}}}}}},"id":"schema_708"},"schema_709":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["coupon"],"properties":{"coupon":{"$ref":"#/components/schemas/discountCoupon"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_709"},"schema_710":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["count","discountType","template","shippingPrice","reusable"],"properties":{"count":{"type":"integer","minimum":2,"maximum":999,"examples":[2]},"discountType":{"type":"string","enum":["percentual","fixed"],"description":"Type of discount. Percentual (percentual) or fixed discount (fixed)","examples":["percentual"]},"amount":{"$ref":"#/components/schemas/typePriceNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of fixed discount (default eshop VAT rate is used). This items needs to be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]}]}]}],"examples":["100.0"]},"ratio":{"type":["string","null"],"pattern":"[0-1]\\.[0-9]{4}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of percentual discount. This items needs to be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". 4 decimal places accuracy, from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (0% discount) to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (100% discount)."},"children":[]}]}]}],"examples":["0.1000"]},"minPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"Minimum price of order (default eshop VAT rate is used)","examples":["100.0"]},"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of fixed discount. It can be null only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minPrice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to null"},"children":[]}]}]}],"examples":["CZK"]},"template":{"$ref":"#/components/schemas/typeGuid","description":"GUID of discount coupon template"},"shippingPrice":{"type":"string","enum":["cart","free","beforeDiscount"],"description":"How the transport prices are calculated: according to the cart before discounts (beforeDiscount), according to the displayed value of the cart (cart), or free (free)","examples":["cart"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"Starting date of coupon validity"},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"Ending date of coupon validity"},"reusable":{"type":"boolean","description":"Is the discount coupon reusable?","examples":[true]},"remark":{"type":["string","null"],"description":"Discount coupon note","examples":["This is a discount coupon for the first purchase."]}}}}},"id":"schema_710"},"schema_711":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["coupons"],"properties":{"coupons":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","creationTime","discountType","amount","ratio","minPrice","currency","template","shippingPrice","validFrom","validTo","reusable","usedCount","remark"],"properties":{"code":{"type":"string","description":"code of discount coupon","examples":["DC14585431"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time, when the discount coupon was created"},"discountType":{"type":"string","enum":["percentual","fixed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of discount. Percentual ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or absolute discount ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["percentual"]},"amount":{"$ref":"#/components/schemas/typePriceNullable","description":"amount of absolute discount (default eshop VAT rate is used)"},"ratio":{"oneOf":[{"$ref":"#/components/schemas/typePriceRatio"},{"type":"null"}],"description":"amount of percentual discount"},"minPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"minimum price of order (default eshop VAT rate is used)"},"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable","description":"currency of fixed discount."},"template":{"$ref":"#/components/schemas/typeGuid","description":"template used for the discount coupon creation."},"shippingPrice":{"type":["string","null"],"enum":["cart","free","beforeDiscount",null],"description":"how the transport prices are calculated: according to the cart before discounts (beforeDiscount), according to the displayed value of the cart (cart), or free (free)","examples":["cart"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"starting date of coupon validity"},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"ending date of coupon validity"},"reusable":{"type":"boolean","description":"Is the discount coupon reusable?","examples":[true]},"usedCount":{"type":"integer","description":"number of times the discount coupon has been used","examples":[0]},"remark":{"type":["string","null"],"description":"remark for the discount coupon.","examples":["Note: This is a test discount coupon"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_711"},"schema_712":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["orderCode"],"properties":{"orderCode":{"type":"string","minLength":1,"maxLength":255,"description":"Order code","examples":["2015000010"]}}}}},"id":"schema_712"},"schema_713":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["couponTemplates"],"properties":{"couponTemplates":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","title","customerGroup","categories","brands","productFlags","productSelectionMode"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"discount coupons template GUID"},"title":{"type":"string","description":"name of discount coupons template","examples":["Luxury goods"]},"customerGroup":{"type":["object","null"],"required":["id","name"],"description":"group of users for whom the discount coupons shall be available.","properties":{"id":{"type":"integer","description":"customer group ID","examples":[1]},"name":{"type":"string","description":"customer group name","examples":["Velkoobchodní odběratel"]}}},"categories":{"type":["array","null"],"description":"list of categories, for which the discount coupons shall be available.","items":{"type":"object","additionalProperties":false,"required":["guid","name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid"},"name":{"type":"string","examples":["Watch"]}}}},"brands":{"type":["array","null"],"description":"brands, for which the discount can be used.","items":{"$ref":"#/components/schemas/brandNamed"}},"productFlags":{"type":["array","null"],"description":"discount parameters.","items":{"type":"object","additionalProperties":false,"required":["code","title","condition"],"properties":{"code":{"type":"string","description":"parameter code","examples":["akademiks"]},"title":{"type":"string","description":"parameter name","examples":["Akademiks"]},"condition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forbidden"},"children":[]}]}]}],"examples":["required"]}}}},"productSelectionMode":{"type":"string","enum":["parameters","specificProducts"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how the coupon is applied. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses categories, brands and product flags. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies only to listed products."},"children":[]}]}]}],"examples":["parameters"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_713"},"schema_714":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuidNullable","description":"Product GUID. Must be unique if set. Generated automatically if not set."},"title":{"type":"string","minLength":1,"maxLength":64,"description":"Product name. MinLength 1 character, MaxLength 64 characters. Mandatory.","examples":["product"]},"customerGroupId":{"type":"integer","description":"Group must exists if set.","examples":[1]},"categoryGuids":{"type":["array","null"],"items":{"$ref":"#/components/schemas/typeGuid"}},"brands":{"type":["array","null"],"items":{"type":"string","examples":["citizen"]}},"productFlags":{"type":["array","null"],"items":{"type":"object","additionalProperties":false,"required":["code","condition"],"properties":{"code":{"type":"string","description":"parameter code","examples":["akademiks"]},"condition":{"type":"string","enum":["required","forbidden"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forbidden"},"children":[]}]}]}],"examples":["required"]}}}},"productSelectionMode":{"type":"string","enum":["parameters","specificProducts"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how the coupon is applied. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses categories, brands and product flags. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies only to products listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productGuids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["specificProducts"]},"productGuids":{"type":["array","null"],"items":{"$ref":"#/components/schemas/typeGuid"}}}}}},"id":"schema_714"},"schema_715":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["guid","title","customerGroup","categories","brands","productFlags","productSelectionMode","products"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"discount coupons template GUID"},"title":{"type":"string","description":"name of discount coupons template","examples":["Luxury goods"]},"customerGroup":{"type":["object","null"],"required":["id","name"],"description":"group of users for whom the discount coupons shall be available.","properties":{"id":{"type":"integer","description":"customer group ID","examples":[1]},"name":{"type":"string","description":"customer group name","examples":["Velkoobchodní odběratel"]}}},"categories":{"type":["array","null"],"description":"list of categories, for which the discount coupons shall be available.","items":{"type":"object","additionalProperties":false,"required":["guid","name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid"},"name":{"type":"string","examples":["Watch"]}}}},"brands":{"type":["array","null"],"description":"brands, for which the discount can be used.","items":{"$ref":"#/components/schemas/brandNamed"}},"productFlags":{"type":["array","null"],"description":"discount parameters.","items":{"type":"object","additionalProperties":false,"required":["code","title","condition"],"properties":{"code":{"type":"string","description":"parameter code","examples":["akademiks"]},"title":{"type":"string","description":"parameter name","examples":["Akademiks"]},"condition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forbidden"},"children":[]}]}]}],"examples":["required"]}}}},"productSelectionMode":{"type":"string","enum":["parameters","specificProducts"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how the coupon is applied. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses categories, brands and product flags. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies only to listed products."},"children":[]}]}]}],"examples":["parameters"]},"products":{"type":["array","null"],"description":"list of products, for which the discount coupons shall be available.","items":{"type":"object","additionalProperties":false,"required":["guid","name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid"},"name":{"type":"string","examples":["Batman mug"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"id":"schema_715"},"schema_716":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["guid","title","customerGroup","categories","brands","productFlags","productSelectionMode","products"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"discount coupons template GUID"},"title":{"type":"string","description":"name of discount coupons template","examples":["Luxury goods"]},"customerGroup":{"type":["object","null"],"required":["id","name"],"description":"group of users for whom the discount coupons shall be available.","properties":{"id":{"type":"integer","description":"customer group ID","examples":[1]},"name":{"type":"string","description":"customer group name","examples":["Velkoobchodní odběratel"]}}},"categories":{"type":["array","null"],"description":"list of categories, for which the discount coupons shall be available.","items":{"type":"object","additionalProperties":false,"required":["guid","name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid"},"name":{"type":"string","examples":["Watch"]}}}},"brands":{"type":["array","null"],"description":"brands, for which the discount can be used.","items":{"$ref":"#/components/schemas/brandNamed"}},"productFlags":{"type":["array","null"],"description":"discount parameters.","items":{"type":"object","additionalProperties":false,"required":["code","title","condition"],"properties":{"code":{"type":"string","description":"parameter code","examples":["akademiks"]},"title":{"type":"string","description":"parameter name","examples":["Akademiks"]},"condition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forbidden"},"children":[]}]}]}],"examples":["required"]}}}},"productSelectionMode":{"type":"string","enum":["parameters","specificProducts"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how the coupon is applied. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses categories, brands and product flags. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specificProducts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies only to listed products."},"children":[]}]}]}],"examples":["parameters"]},"products":{"type":["array","null"],"description":"list of products, for which the discount coupons shall be available.","items":{"type":"object","additionalProperties":false,"required":["guid","name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid"},"name":{"type":"string","examples":["Batman mug"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_716"},"schema_717":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["mailingLists"],"properties":{"mailingLists":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","examples":["newsletter-list"],"description":"Unique code for the mailing list"},"name":{"type":"string","examples":["Newsletter List"],"description":"Name of the mailing list"}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_717"},"schema_718":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"code":{"type":"string","minLength":1,"maxLength":64,"description":"code of distribution list. If not send, code is created from name. Minimum length is 1 characters, maximum length is 64 characters.(optional)","examples":["newsletters-list"]},"name":{"type":"string","minLength":1,"maxLength":64,"description":"name of distribution list. Minimum length is 1 characters, maximum length is 64 characters.","examples":["Newsletters list"]}}}}},"id":"schema_718"},"schema_719":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["mailingList"],"properties":{"mailingList":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","examples":["newsletter-list"],"description":"Unique code for the mailing list"},"name":{"type":"string","examples":["Newsletter List"],"description":"Name of the mailing list"}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_719"},"schema_720":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["emails","paginator"],"properties":{"emails":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["email","added"],"properties":{"email":{"type":"string","description":"Email address","examples":["larry@gmail.com"]},"added":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of creation"}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_720"},"schema_721":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"required":["emails"],"properties":{"emails":{"type":"array","description":"E-mails to add to the list","items":{"type":"string"},"examples":[["john.doe@example.com"]]}}}}},"id":"schema_721"},"schema_722":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["emailsInserted","emailsExisting","emailsInvalid","errorMessages"],"additionalProperties":false,"properties":{"emailsInserted":{"type":"array","description":"E-mails successfully added to the list","items":{"type":"string"},"examples":[["john.doe@example.com"]]},"emailsExisting":{"type":"array","description":"E-mails skipped because they were already inserted before","items":{"type":"string"},"examples":[["john.doe@example.com"]]},"emailsInvalid":{"type":"array","description":"E-mails skipped because of invalid format","items":{"type":"string"},"examples":[["invalid-email"]]},"errorMessages":{"type":"array","description":"Error messages of invalid e-mails","items":{"type":"string"},"examples":[["Email \"bad-email\" is not valid. Please check your entries carefully.","Email \"test@invalid\" has wrong domain or missing MX record."]]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_722"},"schema_723":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["changes","paginator"],"properties":{"changes":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["changeType","changeTime","email"],"properties":{"changeType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type of event that happened with the entity. Possible values are following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", delete`."},"children":[]}]}]}],"examples":["edit"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time, when the event happened. ISO 8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2017-12-12T22:08:01+0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"email":{"type":"string","examples":["test@test.cz"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_723"},"schema_724":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["discounts","paginator"],"properties":{"discounts":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","title","validFrom","validTo","customerGroups","priority","includeUnregisteredCustomers","status","isActive"],"properties":{"id":{"type":"integer","description":"discount ID","examples":[1]},"title":{"type":"string","description":"discount title","examples":["18 + 4 free"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity from","examples":["2014-11-19"]},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity to","examples":["2014-12-19"]},"customerGroups":{"type":["array","null"],"description":"customer groups connected to discount","items":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","description":"customer group code","examples":["retail"]},"name":{"type":"string","description":"customer group name","examples":["Retail customer"]}}}},"includeUnregisteredCustomers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines if discount is valid for unregistered customers, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"examples":[true]},"priority":{"type":["integer","null"],"description":"priority of the discount","examples":[1]},"targetingLevel":{"type":"string","description":"targeting level of the discount","enum":["eshop","product","category","brand"],"examples":["eshop"]},"status":{"type":"string","description":"status of the discount","enum":["available","unavailable","expired","planned"],"examples":["available"]},"isActive":{"type":"boolean","description":"defines if discount is in active or inactive stage","examples":[true]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_724"},"schema_725":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","required":["title","settings","targetingLevel"],"additionalProperties":false,"properties":{"title":{"type":"string","minLength":1,"description":"Discount title.","examples":["25% discount for order of 100 units or more"]},"isActive":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not is the discount active. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"Date of discount validity from.","examples":["2014-11-19"]},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"Date of discount validity to.","examples":["2014-12-19"]},"displayFlag":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not to display flag. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"flagColor":{"$ref":"#/components/schemas/typeColor","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the flag. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D00000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"customerGroupCodes":{"type":["array","null"],"minItems":1,"uniqueItems":true,"description":"Customer groups connected to discount.","items":{"type":"string","examples":["retail"]}},"includeUnregisteredCustomers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines if discount is valid for unregistered customers, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"targetingLevel":{"type":"string","description":"Level of targeting.","enum":["eshop","product","category","brand"],"examples":["eshop"]},"targeting":{"type":["object","null"],"minProperties":1,"description":"Links the discount to the specific target/s. At least one of the parameters needs to be specified.","properties":{"productGuids":{"type":["array","null"],"minItems":1,"uniqueItems":true,"description":"Array of product guids.","items":{"type":"string","examples":["356eb81e-d966-11e0-b04f-57a43310b768"]}},"categoryGuids":{"type":["array","null"],"minItems":1,"uniqueItems":true,"description":"Array of category guids.","items":{"type":"string","examples":["07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed"]}},"brandCodes":{"type":["array","null"],"minItems":1,"uniqueItems":true,"description":"Array of brand codes.","items":{"type":"string","examples":["brand-1"]}}}},"settings":{"type":"array","minItems":1,"description":"Settings of the discount.","items":{"type":"object","required":["amountFrom","discountType","discountValue"],"additionalProperties":false,"properties":{"amountFrom":{"type":"integer","description":"Amount/quantity of items from which the discount is applied.","examples":[2]},"discountType":{"type":"string","description":"Type of the discount.","examples":["percentual"]},"discountValue":{"oneOf":[{"type":"object","additionalProperties":false,"required":["priceRatio"],"properties":{"priceRatio":{"type":"number","minimum":0,"maximum":1,"multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price ratio of the discount. Calculate as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(100 - percentage) / 100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Round to 2 decimal places."},"children":[]}]}]}],"examples":[0.85]}}}]}}}},"sortBefore":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of discount before which you want to move the discount from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"sortAfter":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of discount after which you want to move the discount from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]}}}}},"id":"schema_725"},"schema_726":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["discount"],"properties":{"discount":{"$ref":"#/components/schemas/quantityDiscount"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_726"},"schema_727":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","minProperties":1,"additionalProperties":false,"properties":{"title":{"type":"string","minLength":1,"description":"Discount title.","examples":["25% discount for order of 100 units or more"]},"isActive":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not is the discount active. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"Date of discount validity from.","examples":["2014-11-19"]},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"Date of discount validity to.","examples":["2014-12-19"]},"displayFlag":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether or not to display flag. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"flagColor":{"$ref":"#/components/schemas/typeColor","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of the flag. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D00000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"customerGroupCodes":{"type":["array","null"],"minItems":1,"uniqueItems":true,"description":"Customer groups connected to discount.","items":{"type":"string","examples":["retail"]}},"includeUnregisteredCustomers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines if discount is valid for unregistered customers, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"targetingLevel":{"type":"string","description":"Level of targeting.","enum":["eshop","product","category","brand"],"examples":["eshop"]},"targeting":{"type":["object","null"],"minProperties":1,"description":"Links the discount to the specific target/s. At least one of the parameters needs to be specified.","properties":{"productGuids":{"type":["array","null"],"minItems":1,"uniqueItems":true,"description":"Array of product guids.","items":{"type":"string","examples":["356eb81e-d966-11e0-b04f-57a43310b768"]}},"categoryGuids":{"type":["array","null"],"minItems":1,"uniqueItems":true,"description":"Array of category guids.","items":{"type":"string","examples":["07f7a4c1-d7b1-11e0-9a5c-feab5ed617ed"]}},"brandCodes":{"type":["array","null"],"minItems":1,"uniqueItems":true,"description":"Array of brand codes.","items":{"type":"string","examples":["brand-1"]}}}},"settings":{"type":"array","minItems":1,"description":"Settings of the discount.","items":{"type":"object","required":["amountFrom","discountType","discountValue"],"additionalProperties":false,"properties":{"amountFrom":{"type":"integer","description":"Amount/quantity of items from which the discount is applied.","examples":[2]},"discountType":{"type":"string","description":"Type of the discount.","examples":["percentual"]},"discountValue":{"oneOf":[{"type":"object","additionalProperties":false,"required":["priceRatio"],"properties":{"priceRatio":{"type":"number","minimum":0,"maximum":1,"multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price ratio of the discount. Calculate as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(100 - percentage) / 100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Round to 2 decimal places."},"children":[]}]}]}],"examples":[0.85]}}}]}}}},"sortBefore":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of discount before which you want to move the discount from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"sortAfter":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of discount after which you want to move the discount from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]}}}}},"id":"schema_727"},"schema_728":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["discount"],"properties":{"discount":{"$ref":"#/components/schemas/quantityDiscount"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"id":"schema_728"},"schema_729":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["unsubscribedEmails","paginator"],"properties":{"unsubscribedEmails":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["email","unsubscribedAt"],"properties":{"email":{"type":"string","description":"Email address","examples":["larry@gmail.com"]},"unsubscribedAt":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date and time when the email was unsubscribed"}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_729"},"schema_730":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["email","unsubscribedAt"],"properties":{"email":{"type":"string","minLength":1,"maxLength":100,"description":"Email address","examples":["larry@gmail.com"]},"unsubscribedAt":{"$ref":"#/components/schemas/typeDateTimeRequest","description":"time of unsubscription - Deprecation of required timezone part of datetime, and will be removed in the future"}}}}},"id":"schema_730"},"schema_731":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["unsubscribedEmail"],"properties":{"unsubscribedEmail":{"type":"object","additionalProperties":false,"required":["email","unsubscribedAt"],"properties":{"email":{"type":"string","description":"Email address","examples":["larry@gmail.com"]},"unsubscribedAt":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"Date and time when the email was unsubscribed"}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_731"},"schema_732":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["discounts","paginator"],"properties":{"discounts":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","amount","currency","priceRatio","customerGroups"],"properties":{"id":{"type":"integer","description":"discount ID","examples":[1]},"amount":{"$ref":"#/components/schemas/typeAmount","description":"amount of volume discount"},"priceRatio":{"oneOf":[{"$ref":"#/components/schemas/typePriceRatio"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"discount in the form of coefficient (0.7 = 70 % of the original price, i.e. 30 % discount)"},"children":[]}]}]}]},"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable","description":"currency of volume discount"},"customerGroups":{"type":["array","null"],"description":"customer groups connected to discount","items":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","description":"customer group code","examples":["retail"]},"name":{"type":"string","description":"customer group name","examples":["Retail customer"]}}}}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_732"},"schema_733":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["discounts","paginator"],"properties":{"discounts":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","title","validFrom","validTo","customerGroups","priority","includeUnregisteredCustomers"],"properties":{"id":{"type":"integer","description":"discount ID","examples":[1]},"title":{"type":"string","description":"discount title","examples":["18 + 4 free"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity from","examples":["2014-11-19"]},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity to","examples":["2014-12-19"]},"customerGroups":{"type":["array","null"],"description":"customer groups connected to discount","items":{"type":"object","additionalProperties":false,"required":["code","name"],"properties":{"code":{"type":"string","description":"customer group code","examples":["retail"]},"name":{"type":"string","description":"customer group name","examples":["Retail customer"]}}}},"includeUnregisteredCustomers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines if discount is valid for unregistered customers, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]}]}]}],"examples":[true]},"priority":{"type":["integer","null"],"description":"priority of the discount","examples":[1]},"usageCount":{"type":["integer","null"],"description":"number of how many times can be discount used","examples":[1000]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_733"},"schema_734":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["title","xAmount","yAmount","xTargeting","yTargeting"],"properties":{"title":{"type":"string","minLength":1,"description":"discount title","examples":["18 + 4 free"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity from","examples":["2014-11-19"]},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity to","examples":["2014-12-19"]},"customerGroupCodes":{"type":["array","null"],"minItems":1,"description":"customer groups connected to discount","items":{"type":"string","examples":["retail"]}},"includeUnregisteredCustomers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines if discount is valid for unregistered customers, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"xAmount":{"$ref":"#/components/schemas/typePositiveAmount","description":"discount amount in X axis","examples":["3.000"]},"yAmount":{"$ref":"#/components/schemas/typePositiveAmount","description":"amount of products get by discount","examples":["1.000"]},"description":{"type":["string","null"],"description":"discount description","examples":["Get 1 product for free when you buy 3 products!"]},"termsAndConditionsUrl":{"type":["string","null"],"description":"URL to terms and conditions","examples":["http://www.example.com/terms-and-conditions"]},"displayFlag":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether or not to display flag. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"flagColor":{"$ref":"#/components/schemas/typeColor","description":"color of flag"},"displayBanner":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether or not to display banner. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"bannerColor":{"$ref":"#/components/schemas/typeColor","description":"color of banner"},"usageCount":{"type":["integer","null"],"minimum":1,"description":"number of how many times can be discount used.","examples":[1000]},"sortBefore":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id of xy discount before which you want to move the xy discount from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"sortAfter":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id of xy discount after which you want to move the xy discount from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"xTargeting":{"$ref":"#/components/schemas/xyDiscountTargetingPostRequest","description":"definition of products needed to get discount"},"yTargeting":{"$ref":"#/components/schemas/xyDiscountTargetingPostRequest","description":"definition of products get by discount"}}}}},"id":"schema_734"},"schema_735":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["discount"],"properties":{"discount":{"$ref":"#/components/schemas/xyDiscount"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_735"},"schema_736":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"title":{"type":"string","minLength":1,"description":"discount title","examples":["18 + 4 free"]},"validFrom":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity from","examples":["2014-11-19"]},"validTo":{"$ref":"#/components/schemas/typeDateNullable","description":"date of discount validity to","examples":["2014-12-19"]},"customerGroupCodes":{"type":["array","null"],"description":"customer groups connected to discount","minItems":1,"items":{"type":"string","examples":["retail"]}},"includeUnregisteredCustomers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines if discount is valid for unregistered customers, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"xAmount":{"$ref":"#/components/schemas/typePositiveAmount","description":"discount amount in X axis","examples":["3.000"]},"yAmount":{"$ref":"#/components/schemas/typePositiveAmount","description":"amount of products get by discount","examples":["1.000"]},"description":{"type":["string","null"],"description":"discount description","examples":["Get 1 product for free when you buy 3 products!"]},"termsAndConditionsUrl":{"type":["string","null"],"description":"URL to terms and conditions","examples":["http://www.example.com/terms-and-conditions"]},"displayFlag":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether or not to display flag. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"flagColor":{"$ref":"#/components/schemas/typeColor","description":"color of flag"},"displayBanner":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whether or not to display banner. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"bannerColor":{"$ref":"#/components/schemas/typeColor","description":"color of banner"},"usageCount":{"type":["integer","null"],"minimum":1,"description":"number of how many times can be discount used.","examples":[1000]},"sortBefore":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id of xy discount before which you want to move the xy discount from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"sortAfter":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id of xy discount after which you want to move the xy discount from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"xTargeting":{"$ref":"#/components/schemas/xyDiscountTargetingPostRequest","description":"definition of products needed to get discount"},"yTargeting":{"$ref":"#/components/schemas/xyDiscountTargetingPostRequest","description":"definition of products get by discount"}}}}},"id":"schema_736"},"schema_737":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["discount"],"properties":{"discount":{"$ref":"#/components/schemas/xyDiscount"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"id":"schema_737"},"schema_738":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["combineWithLoyaltyDiscounts","combineWithVolumeDiscounts","combineWithQuantityDiscounts","enableMultipleDiscounts","categoryTargeting"],"additionalProperties":false,"properties":{"combineWithLoyaltyDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with loyalty discount"},"children":[]}]}]}],"examples":[true]},"combineWithVolumeDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with volume discount"},"children":[]}]}]}],"examples":[true]},"combineWithQuantityDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with quantity discount"},"children":[]}]}]}],"examples":[true]},"enableMultipleDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple X+Y discounts can be applied at once"},"children":[]}]}]}],"examples":[true]},"categoryTargeting":{"enum":["all-categories","primary-category"],"description":"Enum, discount category targeting","examples":["all-categories"]},"enableInCashdesk":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable X+Y discounts in cashdesk, please note this option is not present for HU eshops"},"children":[]}]}]}],"examples":[true]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_738"},"schema_739":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"combineWithLoyaltyDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with loyalty discount"},"children":[]}]}]}],"examples":[true]},"combineWithVolumeDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with volume discount"},"children":[]}]}]}],"examples":[true]},"combineWithQuantityDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with quantity discount"},"children":[]}]}]}],"examples":[true]},"enableMultipleDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple X+Y discounts can be applied at once"},"children":[]}]}]}],"examples":[true]},"categoryTargeting":{"enum":["all-categories","primary-category"],"description":"Enum, discount category targeting","examples":["all-categories"]},"enableInCashdesk":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable X+Y discounts in cashdesk, please note this option is not present for HU eshops"},"children":[]}]}]}],"examples":[true]}}}}},"id":"schema_739"},"schema_740":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["combineWithLoyaltyDiscounts","combineWithVolumeDiscounts","combineWithQuantityDiscounts","enableMultipleDiscounts","categoryTargeting"],"additionalProperties":false,"properties":{"combineWithLoyaltyDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with loyalty discount"},"children":[]}]}]}],"examples":[true]},"combineWithVolumeDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with volume discount"},"children":[]}]}]}],"examples":[true]},"combineWithQuantityDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"X+Y Discount can be combined with quantity discount"},"children":[]}]}]}],"examples":[true]},"enableMultipleDiscounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple X+Y discounts can be applied at once"},"children":[]}]}]}],"examples":[true]},"categoryTargeting":{"enum":["all-categories","primary-category"],"description":"Enum, discount category targeting","examples":["all-categories"]},"enableInCashdesk":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable X+Y discounts in cashdesk, please note this option is not present for HU eshops"},"children":[]}]}]}],"examples":[true]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"id":"schema_740"},"schema_741":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["categories","paginator"],"properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/category"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_741"},"schema_742":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Category GUID. Must be unique if set. Optional."},"name":{"type":"string","minLength":1,"maxLength":255,"description":"Category name","examples":["Watches"]},"parentGuid":{"$ref":"#/components/schemas/typeGuidNullable","description":"Parent category GUID. Category must exist if set. Optional."},"description":{"type":["string","null"],"description":"Category description. Max length 65535 bytes. Optional.","examples":["

Top category description

"]},"secondDescription":{"type":["string","null"],"description":"Bottom category description. Max length 65535 bytes. Optional.","examples":["

Bottom category description

"]},"imageName":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category image. File must exist on the server. Optional. (Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceImageName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead)"},"children":[]}]}]}],"examples":["watches-category-image.jpg"],"deprecated":true},"sourceImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as category image."},"children":[]}]}]}],"examples":["image.png"]},"sortBefore":{"$ref":"#/components/schemas/typeGuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guid of category before which you want to move the category from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional."},"children":[]}]}]}]},"sortAfter":{"$ref":"#/components/schemas/typeGuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guid of category after which you want to move the category from the request. Not possible to use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional."},"children":[]}]}]}]},"indexName":{"type":"string","minLength":1,"description":"Last part of url. Optional, generated from name if not set.","examples":["watches"]},"menuTitle":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Label for menu. Optional.","examples":["Watches"]},"title":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Meta tag title. Optional.","examples":["Watches"]},"metaTagDescription":{"type":["string","null"],"description":"Meta tag description. Optional.","examples":["Watches, Apple watch, black, white, garmin"]},"visible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the category is visible. Optional, default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"customerVisibility":{"type":"string","enum":["all","registered","unregistered","admin-only"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defines users of the e-shop who can see the category - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = all (default), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = registered users, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unregistered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = non-registered users. Optional."},"children":[]}]}]}],"examples":["all"]},"productOrdering":{"type":"string","enum":["default","most-selling","cheapest","most-expensive","oldest","newest","alphabetically","alphabetically-desc","product-code","product-code-desc","category-priority","category-priority-desc"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines how products are sorted in a category. See also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/sorting-of-products-in-category"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting of products in category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list."},"children":[]}]}]}],"examples":["alphabetically"]},"similarProductsCategory":{"$ref":"#/components/schemas/typeGuidNullable","description":"Similar category guid. Optional."},"relatedProductsCategory":{"$ref":"#/components/schemas/typeGuidNullable","description":"Related category guid. Optional."}}}}},"id":"schema_742"},"schema_743":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/category"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_743"},"schema_744":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/categoryUpdate"}}},"id":"schema_744"},"schema_745":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["categoryProducts","paginator"],"properties":{"categoryProducts":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["productGuid","priority"],"properties":{"productGuid":{"$ref":"#/components/schemas/typeGuid","description":"Global unique permanent product identifier.","examples":["0198418d-acde-708e-9389-0c5113d9b5f3"]},"priority":{"type":["integer","null"],"description":"Order in the list","examples":[100]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_745"},"schema_746":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"oneOf":[{"required":["productGuid","priority"]},{"required":["productCode","priority"]}],"properties":{"productGuid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"GUID of the product","examples":["0198418d-acde-708e-9389-0c5113d9b5f3"]},"productCode":{"type":"string","maxLength":255,"minLength":1,"description":"Code of the product","examples":["ABC123"]},"priority":{"type":["integer","null"],"minimum":0,"maximum":65535,"description":"Priority of the product","examples":[100]}}}}}},"id":"schema_746"},"schema_747":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["parametricCategories"],"properties":{"parametricCategories":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","name","indexName","url","description","secondDescription","image","title","metaTagDescription","originalCategoryGuid","showInList","showInDetail"],"properties":{"guid":{"type":"string","description":"unique identifier of the category","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"name":{"type":"string","description":"category name","examples":["Watches: Space grey"]},"indexName":{"type":"string","description":"ending part of category URL","examples":["watches-space-grey"]},"url":{"type":"string","description":"category URL in the e-shop","examples":["https://classic.shoptet.cz/watches-space-grey/"]},"description":{"type":["string","null"],"description":"top category description","examples":["

Horní popis kategorie

"]},"secondDescription":{"type":["string","null"],"description":"bottom category description","examples":["

Dolní popis kategorie

"]},"image":{"type":["string","null"],"description":"header image","examples":["https://beta.shoptet.cz/user/categories/thumb/supreme-plush-santa-hat.jpg"]},"title":{"type":["string","null"],"description":"HTML title element in the HTML header of the category page","examples":["Watches space grey nice ones"]},"metaTagDescription":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTML META header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in category page"},"children":[]}]}]}],"examples":["Watches, space grey, nice, watch"]},"originalCategoryGuid":{"type":["string","null"],"description":"unique identifier of the original category (from which was the parametric category created)","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"showInList":{"type":"boolean","description":"flag, whether the category is visible in product list","examples":[true]},"showInDetail":{"type":"boolean","description":"flag, whether the category is visible in product detail","examples":[true]},"parameters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameters of the parametric category (requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include in the request url)"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/parameterValueCombinations"}}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_747"},"schema_748":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name","originalCategoryGuid","parameters"],"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Parametric category name","examples":["Green XL"]},"originalCategoryGuid":{"$ref":"#/components/schemas/typeGuid","description":"Unique identifier of the original category from which the parametric category is created","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"parameters":{"type":"array","description":"Parameters of the parametric category","items":{"$ref":"#/components/schemas/parameterValueCombinationsCodes"},"minItems":1,"maxItems":4},"indexName":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last part of url. Optional, generated from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valueCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not set."},"children":[]}]}]}],"examples":["green-xl"]},"description":{"type":["string","null"],"description":"Top parametric category description. Max length 65535 bytes. Optional.","examples":["

Top parametric category description

"]},"secondDescription":{"type":["string","null"],"description":"Bottom parametric category description. Max length 65535 bytes. Optional.","examples":["

Bottom parametric category description

"]},"sourceImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as parametric category image."},"children":[]}]}]}],"examples":["image.png"]},"title":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Meta tag title. Optional.","examples":["Green XL t-shirt"]},"metaTagDescription":{"type":["string","null"],"description":"Meta tag description. Optional.","examples":["Green t-shirt, t-shirt xl, green, xl"]},"showInList":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flag, whether the parametric category is visible in category list. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional"},"children":[]}]}]}],"examples":[true]},"showInDetail":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flag, whether the parametric category is visible in product detail. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional"},"children":[]}]}]}],"examples":[true]}}}}},"id":"schema_748"},"schema_749":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["parametricCategory"],"properties":{"parametricCategory":{"type":"object","additionalProperties":false,"required":["guid","name","indexName","url","description","secondDescription","image","title","metaTagDescription","originalCategoryGuid","showInList","showInDetail"],"properties":{"guid":{"type":"string","description":"unique identifier of the category","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"name":{"type":"string","description":"category name","examples":["Watches: Space grey"]},"indexName":{"type":"string","description":"ending part of category URL","examples":["watches-space-grey"]},"url":{"type":"string","description":"category URL in the e-shop","examples":["https://classic.shoptet.cz/watches-space-grey/"]},"description":{"type":["string","null"],"description":"top category description","examples":["

Horní popis kategorie

"]},"secondDescription":{"type":["string","null"],"description":"bottom category description","examples":["

Dolní popis kategorie

"]},"image":{"type":["string","null"],"description":"header image","examples":["https://beta.shoptet.cz/user/categories/thumb/supreme-plush-santa-hat.jpg"]},"title":{"type":["string","null"],"description":"HTML title element in the HTML header of the category page","examples":["Watches space grey nice ones"]},"metaTagDescription":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTML META header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in category page"},"children":[]}]}]}],"examples":["Watches, spacegrey, nice, watch"]},"originalCategoryGuid":{"type":["string","null"],"description":"unique identifier of the original category (from which was the parametric category created)","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"showInList":{"type":"boolean","description":"flag, whether the category is visible in product list","examples":[true]},"showInDetail":{"type":"boolean","description":"flag, whether the category is visible in product detail","examples":[true]},"parameters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameters of the parametric category (requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include in the request url)"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/parameterValueCombinations"}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_749"},"schema_750":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Parametric category name","examples":["Green XL"]},"indexName":{"type":"string","minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last part of url. Optional, generated from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valueCodes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not set."},"children":[]}]}]}],"examples":["green-xl"]},"description":{"type":["string","null"],"description":"Top parametric category description. Max length 65535 bytes. Optional.","examples":["

Top parametric category description

"]},"secondDescription":{"type":["string","null"],"description":"Bottom parametric category description. Max length 65535 bytes. Optional.","examples":["

Bottom parametric category description

"]},"sourceImageName":{"$ref":"#/components/schemas/typeFilenameNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of file in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/basic-principles/files-upload"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" storage to be set as parametric category image."},"children":[]}]}]}],"examples":["image.png"]},"title":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Meta tag title. Optional.","examples":["Green XL t-shirt"]},"metaTagDescription":{"type":["string","null"],"description":"Meta tag description. Optional.","examples":["Green t-shirt, t-shirt xl, green, xl"]},"showInList":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flag, whether the parametric category is visible in category list. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional"},"children":[]}]}]}],"examples":[true]},"showInDetail":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flag, whether the parametric category is visible in product detail. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional"},"children":[]}]}]}],"examples":[true]}}}}},"id":"schema_750"},"schema_751":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["categoryGuid","categoryName","parameters"],"properties":{"categoryGuid":{"type":"string","description":"Unique identifier of the parent category","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"categoryName":{"type":"string","description":"Name of the parent category","examples":["T-shirts"]},"parameters":{"type":"array","description":"All parameters available for parent category that can be used when creating parametric categories and their combinations","items":{"type":"object","additionalProperties":false,"required":["parameterCode","parameterName","parameterType"],"properties":{"parameterCode":{"type":"string","description":"Code of the parameter","examples":["barva"]},"parameterName":{"type":"string","description":"Name of the parameter","examples":["Barva"]},"parameterType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the parameter — PV (variant parameter) or PF (filtering parameter)"},"children":[]}]}]}],"enum":["PV","PF"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"}},"required":["data","errors"],"additionalProperties":false},"id":"schema_751"},"schema_752":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["categoryGuid","parameters"],"properties":{"categoryGuid":{"$ref":"#/components/schemas/typeGuid","description":"Unique identifier of the category for which the parametric category parent is being created","examples":["1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"]},"parameters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of parameter codes that define the parametric category parent (1–4 parameters)"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"required":["parameterCode"],"properties":{"parameterCode":{"type":"string","minLength":1,"description":"Code of the parameter","examples":["color"]}}},"minItems":1,"maxItems":4}}}}},"id":"schema_752"},"schema_753":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["consumptionTaxes"],"properties":{"consumptionTaxes":{"type":"array","items":{"$ref":"#/components/schemas/consumptionTax"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_753"},"schema_754":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name","price","currency"],"properties":{"name":{"type":"string","minLength":1,"description":"Consumption tax name.","examples":["ABC"]},"price":{"$ref":"#/components/schemas/typePrice","description":"Consumption tax amount.","examples":["50.00"]},"currency":{"type":"string","description":"Consumption tax currency.","examples":["EUR"]},"isVisible":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flag, whether the consumption tax is visible in documents or not. If not set, default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[false]}}}}},"id":"schema_754"},"schema_755":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/consumptionTax"},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_755"},"schema_756":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"description":"Consumption tax name.","examples":["ABC"]},"price":{"$ref":"#/components/schemas/typePrice","description":"Consumption tax amount.","examples":["50.00"]},"currency":{"type":"string","description":"Consumption tax currency.","examples":["EUR"]},"isVisible":{"type":"boolean","description":"Flag, whether the consumption tax is visible in documents or not.","examples":[false]}}}}},"id":"schema_756"},"schema_757":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["contactInformation","settings","currencies","taxClasses","activeModules","urls"],"properties":{"contactInformation":{"type":"object","additionalProperties":false,"required":["eshopId","eshopName","eshopCategory","url","eshopTitle","eshopSubtitle","contactPerson","email","phone","mobilePhone","skypeAccount","contactPhotoUrl"],"properties":{"eshopId":{"type":"integer","examples":[9993],"description":"e-shop ID"},"eshopName":{"type":"string","examples":["Shoptet"],"description":"name of the e-shop"},"eshopCategory":{"type":["string","null"],"description":"category of the e-shop","examples":["Technology"]},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop domain. Please note that domain can change, so it is recommended to register "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eshop:projectDomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook and update the domain in your system if needed."},"children":[]}]}]}],"examples":["http://www.domena-eshopu.cz"]},"eshopTitle":{"type":"string","description":"name of the store","examples":["Shoptet"]},"eshopSubtitle":{"type":["string","null"],"description":"subtitle of the store","examples":["Shop quickly and easily"]},"contactPerson":{"type":["string","null"],"description":"contact person (e-shop owner)","examples":["John Doe"]},"email":{"type":["string","null"],"description":"contact person email","examples":["info@domena-eshopu.cz"]},"phone":{"type":["string","null"],"description":"contact person phone","examples":["+420777888999"]},"mobilePhone":{"type":["string","null"],"description":"contact person mobile phone","examples":["+420777888999"]},"skypeAccount":{"type":["string","null"],"description":"contact person skype account","examples":["john_doe"]},"contactPhotoUrl":{"type":["string","null"],"description":"contact person photo URL","examples":["http://www.domena-eshopu.cz/picture.jpg"]}}},"billingInformation":{"type":"object","additionalProperties":false,"required":["billingName","address","country","registration","phone","email","billingEmail"],"properties":{"billingName":{"type":["string","null"],"description":"trade company / e-shop owner","examples":["John Doe"]},"company":{"type":"object","additionalProperties":false,"description":"company invoicing informations","required":["companyId","taxId","vatId"],"properties":{"companyId":{"type":["string","null"],"description":"Company registration number.","examples":["12345678"]},"vatId":{"type":["string","null"],"description":"VAT identification number.","examples":["CZ289324675"]},"taxId":{"type":["string","null"],"description":"TAX identification number. For Czech address, taxId is same as vatId.","examples":["CZ289324675"]}}},"address":{"type":"object","additionalProperties":false,"description":"invoicing address","required":["streetAddress","city","zip"],"properties":{"streetAddress":{"type":["string","null"],"description":"street, including house and landmark numbers","examples":["Roháčova 15"]},"city":{"type":["string","null"],"description":"city or town","examples":["Praha"]},"zip":{"type":["string","null"],"description":"ZIP or postal code.","examples":["130 00"]}}},"country":{"type":"object","additionalProperties":false,"description":"country of invoicing address","required":["countryCode","countryName"],"properties":{"countryCode":{"type":"string","description":"international 2-character country code","examples":["CZ"]},"countryName":{"type":"string","description":"country name","examples":["Czech Republic"]}}},"registration":{"type":["string","null"],"description":"reference tag","examples":["C 12345"]},"evNumber":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hungarian sole trader registration number. Only for Hungary with enabled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Online Számla"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module, otherwise, it is null."},"children":[]}]}]}],"examples":["87654321"]},"phone":{"type":["string","null"],"description":"main company telephone","examples":["+420777888999"]},"email":{"type":"string","description":"Main company e-mail. Use this email as a primary one for communication with e-shop.","examples":["novak@domena-eshopu.cz"]},"billingEmail":{"type":["string","null"],"description":"invoicing e-mail","examples":["fakturace@domena-eshopu.cz"]}}},"settings":{"type":"object","additionalProperties":false,"required":["vatPayer","cashDeskOnly","trackStockClaims","maxProductAmount","maxEmailAmount","defaultPricelist","timezone","dateFormat","timeFormat","internals","exchangeRateFlip","negativeStockAmount","oss","stockControlDisabled","wholesaleSplitActive"],"properties":{"vatPayer":{"type":"boolean","description":"flag, whether the e-shop is a VAT payer","examples":[true]},"cashDeskOnly":{"type":"boolean","description":"flag, whether the e-shop is operated exclusively in cash desk mode","examples":[false]},"trackStockClaims":{"type":"boolean","description":"flag, activate stock claim count","examples":[true]},"maxProductAmount":{"type":"integer","description":"maximum number of products allowed","examples":[500]},"maxEmailAmount":{"type":"integer","description":"maximum number of e-mails allowed","examples":[1000]},"defaultPricelist":{"$ref":"#/components/schemas/pricelist","description":"default pricelist"},"eshopLanguage":{"type":"string","description":"Default language code of the e-shop. Unavailable when module foreignLanguages is active and initialized.","examples":["cs"]},"timezone":{"type":"string","description":"e-shop timezone","examples":["Europe/Prague"]},"dateFormat":{"type":"string","description":"eshop date format","examples":["j.n.Y"]},"timeFormat":{"type":"string","description":"eshop time format","examples":["H:i"]},"internals":{"type":"string","description":"e-shop language internals - shows eshop internal language settings, that can change some behavior like EET, vat/tax, ...","examples":["cs"]},"exchangeRateFlip":{"type":"boolean","description":"rate flipping","examples":[false]},"negativeStockAmount":{"type":"string","enum":["allowed","no-show-product","no-hide-navigation","no-hide-product"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"determines if negative stock buying is allowed. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no-show-product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no, but still show product), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no-hide-navigation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no, show product, hide in navigation), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no-hide-product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no, hide product)"},"children":[]}]}]}],"examples":["allowed"]},"oss":{"type":"boolean","description":"Determines if eshop has the OSS (One stop shop) tax mode enabled, this affects behavior of VAT rates in the order.","examples":[false]},"stockControlDisabled":{"type":"boolean","description":"Determines if eshop has stock control disabled, this is also true if stock module is disabled.","examples":[false]},"wholesaleSplitActive":{"type":"boolean","description":"Determines if the wholesale payment/shipping methods split is enabled. True if wholesale payment methods are permitted and split is active, otherwise false","examples":[true]}}},"currencies":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","title","isDefault","isDefaultAdmin","isDefaultDocuments","isVisible","exchangeRate","priority","display","priceDecimalPlaces","documentPriceDecimalPlaces","rounding","minimalOrderValue","bankAccount"],"properties":{"code":{"type":"string","description":"currency (ISO format 3 characters)","examples":["CZK"]},"title":{"type":"string","description":"currency name","examples":["Crown"]},"isDefault":{"type":"boolean","description":"flag, whether this is the default shop currency","examples":[true]},"isDefaultAdmin":{"type":"boolean","description":"flag, whether this is the default administration currency","examples":[true]},"isDefaultDocuments":{"type":"boolean","description":"flag, whether this is the default documents (invoicing) currency","examples":[true]},"isVisible":{"type":"boolean","description":"flag, whether the currency is visible in the e-shop","examples":[true]},"exchangeRate":{"$ref":"#/components/schemas/typeExchangeRate","description":"currency exchange rate. According to the currency administration settings, the exchange rate is updated regularly according to the Czech National Bank rate, or is fixed."},"priority":{"type":"integer","description":"currency priority","examples":[1]},"display":{"type":"object","additionalProperties":false,"required":["text","location","decimalsSeparator","thousandsSeparator"],"properties":{"text":{"type":"string","description":"currency symbol","examples":["CZK"]},"location":{"type":"string","enum":["left","right"],"description":"position of currency symbol, possible values are (left) and (right)","examples":["right"]},"decimalsSeparator":{"type":"string","description":"currency display decimal separator","examples":[","]},"thousandsSeparator":{"type":["string","null"],"description":"currency display thousands separator","examples":[" "]}}},"priceDecimalPlaces":{"type":"integer","description":"number of decimal places","examples":[2]},"documentPriceDecimalPlaces":{"type":"integer","description":"number of decimal places","examples":[2]},"rounding":{"type":"string","enum":["none","up","down","math"],"description":"way of rounding, possible values are (none), (up), (down) and (math)","examples":["up"]},"minimalOrderValue":{"$ref":"#/components/schemas/typePriceNullable","description":"minimal order value","examples":["300.00"]},"bankAccount":{"type":"object","additionalProperties":false,"required":["accountNumber","iban","bic","ownerName"],"properties":{"accountNumber":{"type":["string","null"],"description":"account number","examples":["19-2000145399/0800"]},"iban":{"type":["string","null"],"description":"IBAN","examples":["CZ6508000000000192000145399"]},"bic":{"type":["string","null"],"description":"BIC","examples":["GIBACZPX"]},"ownerName":{"type":["string","null"],"description":"Owner name","examples":["Account Name"]}}}}}},"taxClasses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["title","rates","isDefault"],"properties":{"title":{"type":"string","description":"descriptive name of tax rate","examples":["Reduced VAT rate"]},"rates":{"type":"array","description":"the list of tax rate zones","items":{"type":"object","additionalProperties":false,"required":["zone","vatRate"],"properties":{"zone":{"type":"string","description":"zone name","examples":["Default Zone"]},"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":"VAT rate","examples":["15.00"]}}}},"isDefault":{"type":"boolean","description":"flag, whether the default VAT rate is for e-shop","examples":[true]}}}},"activeModules":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["title","name"],"properties":{"title":{"type":"string","description":"module descriptive name","examples":["Abandoned Cart"]},"name":{"type":"string","description":"module identifier","examples":["abandonedCart"]}}}},"urls":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop significant URLs. Please note that domain can change, so it is recommended to register "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eshop:projectDomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook and update the domain in your system if needed."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"required":["ident","url"],"properties":{"ident":{"type":"string","description":"URL identifier","examples":["admin-orders-list"]},"url":{"type":"string","description":"URL (correct form based on e-shop and administration)","examples":["https://mujobchod.myshoptet.com/admin/prehled-objednavek"]}}}},"socialNetworks":{"type":"object","additionalProperties":false,"required":["facebookUrl","facebookText","twitterAccount","instagramAccount"],"properties":{"facebookUrl":{"type":["string","null"],"description":"Facebook profile URL.","examples":["https://www.facebook.com/eshop"]},"facebookText":{"type":["string","null"],"description":"visible text of the Facebook profile link.","examples":["Follow us on Facebook"]},"twitterAccount":{"type":["string","null"],"description":"Twitter profile name.","examples":["shoptet_sro"]},"instagramAccount":{"type":["string","null"],"description":"Instagram profile name.","examples":["shoptet_sro"]}}},"orderAdditionalFields":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["index","label"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional order fields, must be requested using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=orderAdditionalFields"},"children":[]}]}]}],"properties":{"index":{"type":"integer","description":"field number in the order listed in the e-shop administration. Starts from 1.","examples":[1]},"label":{"type":"string","description":"field label","examples":["1. pole"]}}}},"orderStatuses":{"type":"object","additionalProperties":false,"required":["statuses","defaultStatus"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order statuses, must be requested using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=orderStatuses"},"children":[]}]}]}],"properties":{"statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","order","name","markAsPaid"],"properties":{"id":{"type":"integer","description":"order status identifier. System statuses are negative numbers, user positive.","examples":[-4]},"order":{"type":"integer","description":"status order according to administration numbering.","examples":[6]},"name":{"type":"string","description":"name of the status, as named in the administration.","examples":["Cancelled"]},"markAsPaid":{"type":"boolean","description":"flag, whether the order payment flag is set with this status.","examples":[false]}}}},"defaultStatus":{"type":"integer","description":"default status of new orders.","examples":[-1]}}},"paymentMethods":{"type":"object","additionalProperties":false,"required":["retail","wholesale","wholesaleActive"],"properties":{"retail":{"type":"object","additionalProperties":false,"required":["methods","defaultPayment"],"properties":{"methods":{"type":"array","description":"list of available retail payment methods.","items":{"type":"object","additionalProperties":false,"required":["guid","order","name","visible"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"payment method identifier"},"order":{"type":"integer","description":"order of method as set in e-shop administration.","examples":[1]},"name":{"type":"string","description":"payment method caption (customizable in administration)","examples":["Cash on delivery"]},"visible":{"type":"boolean","description":"flag, whether the payment method is offered to customers.","examples":[true]}}}},"defaultPayment":{"type":["string","null"],"description":"default payment method","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]}}},"wholesale":{"type":"object","additionalProperties":false,"required":["methods","defaultPayment"],"description":"available payment methods for wholesale","properties":{"methods":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","order","name","visible"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"payment method identifier"},"order":{"type":"integer","description":"order of method as set in e-shop administration.","examples":[1]},"name":{"type":"string","description":"payment method caption (customizable in administration)","examples":["Cash on delivery"]},"visible":{"type":"boolean","description":"flag, whether the payment method is offered to customers.","examples":[true]}}}},"defaultPayment":{"type":["string","null"],"description":"default payment method","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]}}},"wholesaleActive":{"type":"boolean","description":"flag, whether wholesale payment methods are activated in administration","examples":[true]}}},"shippingMethods":{"type":"object","additionalProperties":false,"required":["retail","wholesale","wholesaleActive"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available transport options, must be requested using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=shippingMethods"},"children":[]}]}]}],"properties":{"retail":{"type":"object","additionalProperties":false,"required":["methods","defaultShipping"],"properties":{"methods":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","order","name","visible"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"shipping method identifier"},"order":{"type":"integer","description":"order of method as set in e-shop administration.","examples":[1]},"name":{"type":"string","description":"shipping method caption (customizable in administration)","examples":["Czech Post - in the post office"]},"visible":{"type":"boolean","description":"flag, whether the shipping method is offered to customers.","examples":[true]}}}},"defaultShipping":{"type":["string","null"],"description":"default shipping method","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]}}},"wholesale":{"type":"object","additionalProperties":false,"required":["methods","defaultShipping"],"properties":{"methods":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","order","name","visible"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"shipping method identifier"},"order":{"type":"integer","description":"order of method as set in e-shop administration.","examples":[1]},"name":{"type":"string","description":"shipping method caption (customizable in administration)","examples":["Czech Post - in the post office"]},"visible":{"type":"boolean","description":"flag, whether the shipping method is offered to customers.","examples":[true]}}}},"defaultShipping":{"type":["string","null"],"description":"default shipping method","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]}}},"wholesaleActive":{"type":"boolean","description":"flag, whether wholesale shipping methods are activated in administration","examples":[true]}}},"imageCuts":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the information on image cuts must be requested using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=imageCuts"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"required":["name","width","height","urlPath","cdnPath"],"properties":{"name":{"type":"string","description":"cut name","examples":["big"]},"width":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image width in given cut ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for original image - cuts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[1024]},"height":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image height in given cut ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for original image - cuts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":[768]},"urlPath":{"type":"string","description":"URL path to images in given cut, including end slash","examples":["https://classic.shoptet.cz/user/shop/big/"]},"cdnPath":{"type":"string","description":"Cdn URL path to images in given cut, including end slash","examples":["https://cdn-api.myshoptet.com/usr/classic.shoptet.cz/user/shop/big/"]}}}},"languages":{"type":"array","description":"Supported languages in eshop. Available only if module Foreign languages is active and initialized.","items":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string","description":"language code","examples":["cs"]},"currencyCode":{"type":["string","null"],"description":"default currency of language","examples":["CZK"]},"dateFormat":{"type":"string","description":"date format for this language","examples":["j.n.Y"]},"timeFormat":{"type":"string","description":"time format for this language","examples":["H:i"]},"isVisible":{"type":"boolean","description":"whether language is selectable in e-shop","examples":[true]},"isDefault":{"type":"boolean","description":"whether language is default","examples":[true]},"priority":{"type":["integer","null"],"description":"ordering property","examples":[1]}}}},"trial":{"type":"boolean","description":"flag, whether the e-shop is in trial mode","examples":[false]},"countries":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the information on countries must be requested using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=countries"},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"required":["countryCode","countryName","companyIdPattern","companyIdExample","zipCodePattern"],"properties":{"countryCode":{"type":"string","description":"international 2-character country code","examples":["CZ"]},"countryName":{"type":"string","description":"country name","examples":["Czech Republic"]},"companyIdPattern":{"type":["string","null"],"description":"Validation pattern for company id","examples":["^\\d{8}$"]},"companyIdExample":{"type":["string","null"],"description":"Example of company id","examples":["28935675"]},"zipCodePattern":{"type":["string","null"],"description":"Validation pattern for zip code","examples":["^[1-7]\\d{2}\\s*\\d{2}$"]}}}},"cashDesk":{"type":"object","additionalProperties":false,"required":["defaultOrderStatusId"],"description":"eshop cash desk configuration","properties":{"defaultOrderStatusId":{"type":["integer","null"],"description":"default status of order after cash desk payment","examples":[-1]}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_757"},"schema_758":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["template","layout","colorScheme","fonts","header","background"],"properties":{"template":{"type":"object","additionalProperties":false,"description":"e-shop template","required":["name","colorVariant"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"template name, enum value [swing, jazz, funk, pop, rock, soul, techno, echo, tango, waltz, classic, step, custom]"},"children":[]}]}]}],"examples":["Tango"]},"colorVariant":{"type":"string","description":"code for a specific color variant of a template","examples":["09-one"]}}},"layout":{"type":"object","additionalProperties":false,"required":["homepage","subPage","productDetail"],"description":"page layout","properties":{"homepage":{"type":"string","enum":["list","listImage","catalog2","catalog3","catalog4"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product detail, enum value [list, listImage, catalog2, catalog3, catalog4]"},"children":[]}]}]}],"examples":["list"]},"subPage":{"type":"string","enum":["list","listImage","catalog2","catalog3","catalog4"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subpage, enum value [list, listImage, catalog2, catalog3, catalog4]"},"children":[]}]}]}],"examples":["list"]},"productDetail":{"type":"string","enum":["list","listImage","catalog2","catalog3","catalog4"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product detail, enum value [list, listImage, catalog2, catalog3, catalog4]"},"children":[]}]}]}],"examples":["list"]}}},"colorScheme":{"type":"object","additionalProperties":false,"required":["conversionColor","conversionColorHover","color1","color2","color3","color4"],"properties":{"conversionColor":{"type":"string","description":"conversion color","examples":["#ff0000"]},"conversionColorHover":{"type":"string","description":"conversion color upon cursor hovering","examples":["#000000"]},"color1":{"type":"string","description":"primary color of e-shop","examples":["#ff0000"]},"color2":{"type":"string","description":"primary color upon cursor hovering","examples":["#000000"]},"color3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secondary e-shop color (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - not for all templates)"},"children":[]}]}]}],"examples":["#ff0000"]},"color4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secondary e-shop color upon cursor hovering (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - not for all templates)"},"children":[]}]}]}],"examples":["#000000"]}}},"fonts":{"type":"object","additionalProperties":false,"required":["heading","text"],"properties":{"heading":{"type":"string","examples":["Open Sans"]},"text":{"type":"string","examples":["Open Sans"]}}},"header":{"type":"object","additionalProperties":false,"required":["backgroundImage","image","logo","color"],"properties":{"backgroundImage":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"background image (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")'"},"children":[]}]}]}],"examples":["https://dummy.myshoptet.com/cms/img/blank.gif"]},"image":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header image (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["https://dummy.myshoptet.com/user/front_images/front.jpg"]},"logo":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-shop logo in header (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["https://dummy.myshoptet.com/user/logos/shoptet-logo.png"]},"color":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header background color for templates Techno, Tango, Classic, Step and Disco (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["#000000"]}}},"background":{"type":"object","additionalProperties":false,"required":["enabled","color","image"],"properties":{"enabled":{"type":"boolean","description":"flag, whether background is enabled","examples":[true]},"color":{"type":["object","null"],"additionalProperties":false,"required":["enabled","color"],"properties":{"enabled":{"type":"boolean","description":"flag, whether the background color is on","examples":[false]},"color":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"background color (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["#000000"]}}},"image":{"type":["object","null"],"additionalProperties":false,"required":["url","attachment","position"],"properties":{"url":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"background image URL (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["https://dummy.myshoptet.com/user/bg-image.jpg"]},"attachment":{"type":"string","enum":["scroll","fixed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mounting, enum value [scroll, fixed]"},"children":[]}]}]}],"examples":["scroll"]},"position":{"type":"string","enum":["center","tile"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location, enum value [center, tile]"},"children":[]}]}]}],"examples":["center"]}}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_758"},"schema_759":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["order","defaultSettings","logoUrl","companyStamp"],"properties":{"order":{"additionalProperties":false,"type":"object","required":["codePrefix","codeLength","isCodeRandom","numberSeriesStartFrom","fullVatBreakdownExport"],"properties":{"codePrefix":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of order "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically the current year is used as a prefix."},"children":[]}]}]}],"examples":["2025"]},"codeLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total length of order "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including prefix."},"children":[]}]}]}],"examples":[10]},"isCodeRandom":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", order code is generated randomly - can be used to keep your count of orders unknown."},"children":[]}]}]}],"examples":[true]},"numberSeriesStartFrom":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isCodeRandom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g., if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", first order "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"syncDocuments":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g., if the order will be canceled, all related documents will be canceled as well. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nav"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not active."},"children":[]}]}]}],"examples":[true]},"printItemRemark":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", parameters from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.itemRemarkParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be displayed on the order. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]},"displayProductStockLocation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the product's warehouse position will be displayed in the order printout. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]},"itemRemarkParameters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item remark parameters. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[["parameter"],["first parameter","second parameter"]],"items":{"type":"string"}},"fullVatBreakdownExport":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", full VAT breakdown is enabled in document exports."},"children":[]}]}]}],"examples":[true]}}},"proformaInvoice":{"additionalProperties":false,"type":["object"],"required":["codePrefix","codeLength","numberSeriesStartFrom","useVariableSymbolFromOrder","printItemRemark","addNotesFromOrder","percentageValueForPartialPayment"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"properties":{"codePrefix":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of proforma invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically the current year is used as a prefix."},"children":[]}]}]}],"examples":["2025"]},"codeLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total length of proforma invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including prefix."},"children":[]}]}]}],"examples":[10]},"numberSeriesStartFrom":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g., if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", first proforma invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"unifyCodeWithOrder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proforma invoice will have the identical number as the order. VS will be the same in the order and invoice. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nav"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not active."},"children":[]}]}]}],"examples":[true]},"useVariableSymbolFromOrder":{"type":"boolean","description":"The variable symbol from the order will be used in the proforma invoice.","examples":[true]},"printItemRemark":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", parameters from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.itemRemarkParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be displayed on the proforma invoice."},"children":[]}]}]}],"examples":[true]},"addNotesFromOrder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.syncDocuments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled, note from order will be added to proforma invoice."},"children":[]}]}]}],"examples":[true]},"percentageValueForPartialPayment":{"$ref":"#/components/schemas/typePrice","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified percentage value for partial payment must not be less than the order value or 1 %, and must not exceed the order value or 100 %."},"children":[]}]}]}]}}},"invoice":{"additionalProperties":false,"type":["object"],"required":["codePrefix","codeLength","numberSeriesStartFrom","useVariableSymbolFromOrder","useSpecialNumberSerieForCashdesk","displayWarranty","printItemRemark","addEanToItemRemark","addNotesFromOrder"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"properties":{"codePrefix":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically the current year is used as a prefix."},"children":[]}]}]}],"examples":["2025"]},"codeLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total length of invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including prefix."},"children":[]}]}]}],"examples":[10]},"numberSeriesStartFrom":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g., if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", first invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"unifyCodeWithOrder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice will have the identical number as the order. VS will be the same in the order and invoice. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nav"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not active."},"children":[]}]}]}],"examples":[true]},"useVariableSymbolFromOrder":{"type":"boolean","description":"The variable symbol from the order will be used in the invoice.","examples":[true]},"useSpecialNumberSerieForCashdesk":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", special number serie will be used for invoices created via cashdesk using fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashdeskCodePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashdeskCodeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashdeskNumberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"cashdeskCodePrefix":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" generated via cashdesk. Typically the current year is used as a prefix."},"children":[]}]}]}],"examples":["C-2025"]},"cashdeskCodeLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total length of invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" generated via cashdesk, including prefix."},"children":[]}]}]}],"examples":[10]},"cashdeskNumberSeriesStartFrom":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g., if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", first invoice "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" generated via cashdesk will look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C-20250001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"displayWarranty":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", warranty will be displayed on invoice."},"children":[]}]}]}],"examples":[true]},"printItemRemark":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", parameters from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.itemRemarkParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be displayed on the proforma invoice."},"children":[]}]}]}]},"addEanToItemRemark":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoice.printItemRemark"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled, the EAN of the product will be displayed in the note next to the item."},"children":[]}]}]}],"examples":[true]},"addNotesFromOrder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.syncDocuments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled, note from order will be added to invoice."},"children":[]}]}]}],"examples":[true]},"displayDoNotPay":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", display do not pay on paid invoice."},"children":[]}]}]}],"examples":[true]},"displayPriceWithoutDiscount":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", price before applying discount will be displayed on invoice."},"children":[]}]}]}],"examples":[true]},"displayTaxableSupplyDate":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the tax date (DUZP – Date of taxable supply) will be displayed on the invoice."},"children":[]}]}]}],"examples":[true]}}},"creditNote":{"additionalProperties":false,"type":["object"],"required":["codePrefix","codeLength","numberSeriesStartFrom","displayCorrectedAndOriginalDocumentDiff","printItemRemark","defaultReasonRemark","restock","checkComplianceWithInvoice","forbiddenItemTypes"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"properties":{"codePrefix":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of credit note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically the current year is used as a prefix."},"children":[]}]}]}],"examples":["2025"]},"codeLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total length of credit note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including prefix."},"children":[]}]}]}],"examples":[10]},"numberSeriesStartFrom":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g., if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", first credit note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"unifyCodeWithOrder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit note will have the identical number as the order. VS will be the same in the order and invoice. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nav"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not active."},"children":[]}]}]}],"examples":[true]},"displayCorrectedAndOriginalDocumentDiff":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the difference between the corrected and original tax base, tax and original amount will be shown on the credit note."},"children":[]}]}]}],"examples":[true]},"printItemRemark":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", parameters from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.itemRemarkParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be displayed on the credit note."},"children":[]}]}]}],"examples":[true]},"defaultReasonRemark":{"type":["string","null"],"description":"This reason will be displayed on credit notes by default. For individual credit notes you can change it via the credit note detail.","examples":["Order cancellation"]},"restock":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the items from the order will be automatically restocked."},"children":[]}]}]}],"examples":[true]},"addNotesFromOrder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.syncDocuments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled, note from order will be added to invoice."},"children":[]}]}]}],"examples":[true]},"checkComplianceWithInvoice":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system validates that the credit note items comply with the original invoice."},"children":[]}]}]}],"examples":[true]},"forbiddenItemTypes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items that will not be automatically added into the credit note. You can add them additionally. Available types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shipping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gift"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[["shipping"],["shipping","billing","gift"]],"items":{"type":"string"}}}},"deliveryNote":{"additionalProperties":false,"type":["object"],"required":["codePrefix","codeLength","numberSeriesStartFrom","printItemRemark"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"properties":{"codePrefix":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of delivery note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically the current year is used as a prefix."},"children":[]}]}]}],"examples":["2025"]},"codeLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total length of delivery note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including prefix."},"children":[]}]}]}],"examples":[10]},"numberSeriesStartFrom":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g., if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", first delivery note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"unifyCodeWithOrder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery note will have the identical number as the order. VS will be the same in the order and invoice. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nav"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not active."},"children":[]}]}]}],"examples":[true]},"printItemRemark":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", parameters from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.itemRemarkParameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be displayed on the delivery note."},"children":[]}]}]}],"examples":[true]}}},"proofPayment":{"additionalProperties":false,"type":["object"],"required":["useSequentionalNumberSerie","createByIncomingPayment"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"properties":{"useSequentionalNumberSerie":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sequentional number serie will be used, accepting fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise number serie is generated by linked document with prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefixOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefixProformaInvoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[true]},"codePrefix":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of proof payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically the current year is used as a prefix. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useSequentionalNumberSerie"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["2025"]},"codeLength":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total length of proof payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including prefix. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useSequentionalNumberSerie"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[10]},"numberSeriesStartFrom":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E.g., if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codePrefix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeLength"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"numberSeriesStartFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", first proof payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will look like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useSequentionalNumberSerie"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":[1]},"codePrefixOrder":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of proof payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if created from order. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useSequentionalNumberSerie"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", i.e. number serie is generated by linked document."},"children":[]}]}]}],"examples":["O-"]},"codePrefixProformaInvoice":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of proof payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if created from proforma invoice. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useSequentionalNumberSerie"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", i.e. number serie is generated by linked document."},"children":[]}]}]}],"examples":["P-"]},"createByIncomingPayment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a receipt will automatically be issued when payment is received. Note, if enabled, issuance of receipts upon order status change is deactivated, as it is not possible to use both methods simultaneously."},"children":[]}]}]}],"examples":[true]}}},"export":{"additionalProperties":false,"type":["object"],"required":["useIsdocModule","erpMoneyS3PreAccounting","erpMoneyS3Account"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"properties":{"useIsdocModule":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isdoc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module is active."},"children":[]}]}]}],"examples":[true]},"erpMoneyS3PreAccounting":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of proof payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Typically the current year is used as a prefix. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useSequentionalNumberSerie"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":["2025"]},"erpMoneyS3Account":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix of proof payment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if created from order. Available only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"useSequentionalNumberSerie"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", i.e. number serie is generated by linked document."},"children":[]}]}]}],"examples":["123456789/1234"]}}},"defaultSettings":{"additionalProperties":false,"type":["object"],"required":["billingMethodId"],"description":"Will be applied to all documents if in document detail won't be set otherwise.","properties":{"billingMethodId":{"type":["integer","null"],"description":"Default billing method identifier.","examples":[1]},"constSymbol":{"$ref":"#/components/schemas/typeConstSymbolNullable","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default constant symbol. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}]},"specSymbol":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default specific symbol. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":["2025042200001"]},"maturity":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default maturity. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[14]},"invoiceRemark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom note displayed on each invoice. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":["Custom invoice note"]},"proformaInvoiceRemark":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom note displayed on each proforma invoice. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":["Custom proforma invoice note"]},"showQrCode":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will display QR code to pay by bank transfer. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]},"sortItems":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how items are sorted in documents, printout, and inventory. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":["byProductName"]},"showBarcode":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will display barcode on all documents. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]},"showBillFullName":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the name of the supplier's contact person will be shown on the issued documents. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]},"showBillFullNameOfRecipient":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the name of the recipient's contact person will be shown on the issued documents. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]},"showRecipientEmail":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the recipient's email address will be shown on the issued documents. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]},"showRecipientPhone":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the recipient's phone number will be shown on the issued documents. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]},"showRecipientDeliveryAddress":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the recipient's delivery address will be shown on the issued documents. Available only if module "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invoicing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is active."},"children":[]}]}]}],"examples":[true]}}},"logoUrl":{"type":["string","null"],"description":"Logo URL.","example":"https://example.com/logo.png"},"companyStamp":{"additionalProperties":false,"type":["object"],"required":["stampUrl","xAxisCorrection","yAxisCorrection"],"description":"Company stamp of documents.","properties":{"xAxisCorrection":{"type":"integer","description":"How many pixel should be logo shifted to the right on X axis.","examples":[0]},"yAxisCorrection":{"type":"integer","description":"How many pixel should be logo shifted to the right on Y axis.","examples":[0]},"stampUrl":{"type":["string","null"],"description":"Company stamp URL.","example":"https://example.com/stamp.png"}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_759"},"schema_760":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["billingAddress","deliveryAddress","billingInfo","contactInfo"],"properties":{"billingAddress":{"type":"object","additionalProperties":false,"description":"invoicing address","required":["company","fullName","street","houseNumber","city","district","zip","countryCode"],"properties":{"company":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company name, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"fullName":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"street":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"houseNumber":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"house number, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"city":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"district":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"county, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"zip":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zip code, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"countryCode":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]}}},"deliveryAddress":{"type":"object","additionalProperties":false,"description":"delivery address","required":["company","fullName","street","houseNumber","city","district","zip","countryCode"],"properties":{"company":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company name, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"fullName":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full name, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"street":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"houseNumber":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"house number, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"city":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"district":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"county, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"zip":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"zip code, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"countryCode":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"country, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]}}},"billingInfo":{"type":"object","additionalProperties":false,"description":"company data","required":["companyId","taxId"],"properties":{"companyId":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company registration number, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"taxId":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT number, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]}}},"contactInfo":{"type":"object","additionalProperties":false,"description":"contact information","required":["phone","email","birthday"],"properties":{"phone":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone number, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"email":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email address, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]},"birthday":{"$ref":"#/components/schemas/typeCustomerFieldValue","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"birth date, enum ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_760"},"schema_761":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["filteringParameters","paginator"],"properties":{"filteringParameters":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","code","name","displayName","description","priority","googleMapping","values"],"properties":{"id":{"type":"integer","description":"Parameter id","examples":[1]},"code":{"type":"string","description":"Parameter code","examples":["material"]},"name":{"type":"string","description":"Parameter name","examples":["Material"]},"displayName":{"type":["string","null"],"description":"Parameter display name","examples":["Material of product"]},"description":{"type":["string","null"],"description":"Parameter description","examples":["Material of product"]},"priority":{"type":["integer","null"],"description":"Parameter priority","examples":[1]},"googleMapping":{"$ref":"#/components/schemas/googleMappingType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/productFilteringParameterValue"}}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_761"},"schema_762":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name","values"],"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Parameter name","examples":["Materiál"]},"code":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter. When changed, in next API call you must use the new parameter code.","examples":["material"]},"displayName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Parameter display name","examples":["Materiál"]},"description":{"type":["string","null"],"minLength":1,"description":"Parameter description","examples":["Popisek"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Parameter priority","examples":[1]},"googleMapping":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Mapping for google.","examples":["google:color"]},"values":{"minItems":1,"$ref":"#/components/schemas/productFilteringParameterValues"}}}}},"id":"schema_762"},"schema_763":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["id","code","name","displayName","description","priority","googleMapping"],"properties":{"id":{"type":"integer","description":"Parameter id","examples":[1]},"code":{"type":"string","description":"Parameter code","examples":["material"]},"name":{"type":"string","description":"Parameter name","examples":["Material"]},"displayName":{"type":["string","null"],"description":"Parameter display name","examples":["Material of product"]},"description":{"type":["string","null"],"description":"Parameter description","examples":["Material of product"]},"priority":{"type":["integer","null"],"description":"Parameter priority","examples":[1]},"googleMapping":{"$ref":"#/components/schemas/googleMappingType"},"values":{"type":"array","items":{"$ref":"#/components/schemas/productFilteringParameterValue"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_763"},"schema_764":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Parameter name","examples":["Materiál"]},"code":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter. When changed, in next API call you must use the new parameter code.","examples":["material"]},"displayName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Parameter display name","examples":["Materiál"]},"description":{"type":["string","null"],"minLength":1,"description":"Parameter description","examples":["Popisek"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Parameter priority","examples":[1]},"googleMapping":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Mapping for google.","examples":["google:color"]}}}}},"id":"schema_764"},"schema_765":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["paramValues"],"properties":{"paramValues":{"minItems":1,"$ref":"#/components/schemas/productFilteringParameterValues"}}}}},"id":"schema_765"},"schema_766":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"Name of parameter value.","examples":["Bavlna"]},"valueIndex":{"type":["string","null"],"minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter value.","examples":["bavlna"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Parameter value priority.","examples":[1]},"color":{"$ref":"#/components/schemas/typeColor","description":"Color hex code."},"image":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Image name. Image needs to exist in your file folder.","examples":["car-001.jpg"]}}}}},"id":"schema_766"},"schema_767":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["flags"],"properties":{"flags":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","title","system","color","showInDetail","showInCategory"],"properties":{"code":{"type":"string","description":"Unique code of the flag","examples":["action"]},"title":{"type":"string","description":"flag name. This text is displayed to customers in the e-shop.","examples":["Action"]},"system":{"type":"boolean","description":"Is it a system flag common for all e-shops?","examples":[true]},"color":{"type":["string","null"],"description":"color of the product flag displayed in the e-shop.","examples":["#ffc702"]},"showInDetail":{"type":"boolean","description":"Should the flag be displayed in the product detail?","examples":[true]},"showInCategory":{"type":"boolean","description":"Should the flag be displayed in the category product list?","examples":[true]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_767"},"schema_768":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","minLength":1,"maxLength":255,"description":"Name of flag.","examples":["Sale"]},"color":{"$ref":"#/components/schemas/typeColor","description":"Color of the parameter in hex format. NULL forces default color."}}}}},"id":"schema_768"},"schema_769":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"title":{"type":"string","minLength":1,"maxLength":255,"description":"Name of flag.","examples":["Sale"]},"color":{"$ref":"#/components/schemas/typeColor","description":"Color of the parameter in hex format. NULL forces default color."}}}}},"id":"schema_769"},"schema_770":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["stockDependent","wholesaleGiftsEnabled","productGifts"],"additionalProperties":false,"properties":{"stockDependent":{"type":"boolean","description":"define if gifts are dependent on each product or whole order, stock dependent/independent","examples":[false]},"wholesaleGiftsEnabled":{"type":"boolean","description":"define if customer with wholesale module have gifts offer available","examples":[true]},"productGifts":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set if gifts are dependent on each product or whole order, possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per-amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `per-order"},"children":[]}]}]}],"examples":["per-amount"]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_770"},"schema_771":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"properties":{"stockDependent":{"type":"boolean","description":"define if gifts are dependent on each product or whole order, stock dependent/independent","examples":[false]},"wholesaleGiftsEnabled":{"type":"boolean","description":"define if customer with wholesale module have gifts offer available","examples":[true]},"productGifts":{"type":"string","enum":["per-amount","per-order"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"set if gifts are dependent on each product or whole order, possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per-amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and `per-order"},"children":[]}]}]}],"examples":["per-amount"]}}}}},"id":"schema_771"},"schema_772":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["paymentMethods","wholesaleActive","wholesaleSplitActive","defaultRetailMethod","defaultWholesaleMethod"],"properties":{"paymentMethods":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","name","description","submethod","paymentType","visible","wholesale","logoUrl"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"payment method GUID"},"name":{"type":"string","description":"name of payment gateway, as can be seen in e-shop","examples":["Cash on delivery"]},"description":{"type":["string","null"],"description":"additional information about the gateway","examples":["This is the test description"]},"submethod":{"type":["string","null"],"description":"additional identification of payment method","examples":["apple-pay"]},"paymentType":{"type":"object","required":["id","code","name"],"description":"payment method","additionalProperties":false,"properties":{"id":{"type":"integer","description":"payment method ID","examples":[2]},"code":{"type":"string","description":"identifier of the payment type (payment method operator).","examples":["paysec"]},"name":{"type":"string","description":"name of the payment type (payment method operator).","examples":["PaySec"]}}},"visible":{"type":"boolean","description":"Is the payment method visible?","examples":[true]},"priority":{"type":["integer","null"],"description":"sequence within the list","examples":[1]},"wholesale":{"type":"boolean","description":"Is the payment method available for wholesale?","examples":[true]},"logoUrl":{"type":["string","null"],"description":"URL of payment method logo","examples":["https://www.example.com/logo.png"]}}}},"wholesaleActive":{"type":"boolean","description":"flag, whether the wholesale payment methods are permitted","examples":[true]},"wholesaleSplitActive":{"type":"boolean","description":"flag, whether the wholesale payment methods split is enabled. True if wholesale payment methods are permitted and split is active, otherwise false","examples":[true]},"defaultRetailMethod":{"type":["string","null"],"description":"default payment method for the retail sale","examples":["6df78fa2-05b0-11e9-925b-0800273dc42e"]},"defaultWholesaleMethod":{"type":["string","null"],"description":"default payment method for wholesale","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_772"},"schema_773":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["name","paymentType"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"name of the payment method","examples":["Gateway name"]},"description":{"type":["string","null"],"description":"description of payment method","examples":["Description of payment method"]},"submethod":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Additional identification of payment method","examples":["apple-pay"]},"paymentType":{"type":"string","minLength":1,"description":"type of payment (operator) - identifier assigned by Shoptet","examples":["gopay"]},"visibility":{"type":"boolean","description":"whether the payment method will be visible","examples":[true]},"wholesale":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, whether the payment method is available for wholesale customers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = for retail)"},"children":[]}]}]}],"examples":[true]},"logo":{"type":"object","required":["filename","content"],"additionalProperties":false,"properties":{"filename":{"type":"string","pattern":"^[A-Za-z0-9-_.]*\\.[a-z]{3,4}$","description":"file name","examples":["logo_metody.png"]},"content":{"type":"string","description":"base64 encoded package","examples":["VBORw0KGgoAAAANSUhEUgAAAHIAAAAiAQMAAAC5nR/JAAAABGdBT==="]}}}}}}},"id":"schema_773"},"schema_774":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["guid","name","submethod","description","visibility","wholesale","logoUrl","paymentType"],"additionalProperties":false,"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"payment method GUID"},"name":{"type":"string","description":"name of payment gateway, as can be seen in e-shop","examples":["Cash on delivery"]},"description":{"type":["string","null"],"description":"additional information about the gateway","examples":["This is the test description"]},"submethod":{"type":["string","null"],"description":"additional identification of payment method","examples":["apple-pay"]},"visibility":{"type":"boolean","description":"Is the payment method visible?","examples":[true]},"wholesale":{"type":"boolean","description":"Is the payment method available for wholesale?","examples":[true]},"logoUrl":{"type":["string","null"],"description":"URL of payment method logo","examples":["https://www.example.com/logo.png"]},"paymentType":{"type":"object","required":["id","code","name"],"description":"payment method","additionalProperties":false,"properties":{"id":{"type":"integer","description":"payment method ID","examples":[2]},"code":{"type":"string","description":"identifier of the payment type (payment method operator).","examples":["paysec"]},"name":{"type":"string","description":"name of the payment type (payment method operator).","examples":["PaySec"]}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_774"},"schema_775":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["recyclingFeeCategories"],"properties":{"recyclingFeeCategories":{"type":"array","items":{"$ref":"#/components/schemas/recyclingFeeCategory"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_775"},"schema_776":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["shippingMethods","wholesaleActive","wholesaleSplitActive","defaultRetailMethod","defaultWholesaleMethod"],"properties":{"shippingMethods":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["guid","name","description","shippingCompany","trackingUrl","visible","priority","wholesale","logoUrl"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Unique identifier of the shipping method"},"name":{"type":"string","description":"name of shipping method, as can be seen in e-shop.","examples":["Shipping company"]},"description":{"type":["string","null"],"description":"additional information about the shipping method. (can be null)","examples":["Delivery within 48 hours"]},"shippingCompany":{"type":["object","null"],"required":["id","code","name"],"description":"Shipping company","additionalProperties":false,"properties":{"id":{"type":"integer","description":"shipping method ID.","examples":[21]},"code":{"type":"string","description":"shipping company identifier.","examples":["intime"]},"name":{"type":"string","description":"shipping company name.","examples":["IN TIME"]}}},"trackingUrl":{"type":["string","null"],"description":"package trace link pattern","examples":["http://www.ppl.cz/main2.aspx?cls=Package&idSearch=#PACKAGE_NUMBER#"]},"visible":{"type":"boolean","description":"Is the shipping method visible?","examples":[true]},"priority":{"type":["integer","null"],"description":"sequence within the list","examples":[16]},"wholesale":{"type":"boolean","description":"Is the shipping method available for wholesale customers?","examples":[true]},"logoUrl":{"type":["string","null"],"description":"URL of the shipping company logo","examples":["https://www.example.com/logo.png"]}}}},"wholesaleActive":{"type":"boolean","description":"flag, whether the wholesale shipping methods are permitted","examples":[true]},"wholesaleSplitActive":{"type":"boolean","description":"flag, whether the wholesale payment methods split is enabled. True if wholesale payment methods are permitted and split is active, otherwise false","examples":[true]},"defaultRetailMethod":{"type":["string","null"],"description":"Default shipping method for retail sale","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]},"defaultWholesaleMethod":{"type":["string","null"],"description":"Default shipping method for wholesale","examples":["b57f91bb-e920-11e0-baa3-7dc668b75ca8"]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_776"},"schema_777":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["name","shippingMethodCode"],"additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of the shipping method","examples":["Shipping name"]},"description":{"type":["string","null"],"description":"additional information about the shipping method.","examples":["Shipping description"]},"shippingMethodCode":{"type":"string","minLength":1,"description":"type of shipping method (operator) - identifier assigned by Shoptet","examples":["intime-colli-small"]},"visibility":{"type":"boolean","description":"whether the shipping method will be visible","examples":[true]},"wholesale":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flag, whether the shipping method is available for wholesale customers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = for retail)"},"children":[]}]}]}],"examples":[true]},"logo":{"type":"object","required":["filename","content"],"additionalProperties":false,"properties":{"filename":{"type":"string","pattern":"^[A-Za-z0-9-_.]*\\.[a-z]{3,4}$","description":"Name of the file","examples":["logo_shipping.png"]},"content":{"type":"string","description":"Base64 encoded image","examples":["iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABaElEQVR42mNk==="]}}},"minimalShippingPrice":{"$ref":"#/components/schemas/typePriceNullable","description":"number indicating minimum price of shipping in the default currency"}}}}},"id":"schema_777"},"schema_778":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["guid","name","description","visibility","wholesale","logoUrl","shippingCompany"],"additionalProperties":false,"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Unique identifier of the shipping method"},"name":{"type":"string","description":"name of shipping method, as can be seen in e-shop.","examples":["Shipping company"]},"description":{"type":["string","null"],"description":"additional information about the shipping method. (can be null)","examples":["Delivery within 48 hours"]},"visibility":{"type":"boolean","description":"Is the shipping method visible?","examples":[true]},"wholesale":{"type":"boolean","description":"Is the shipping method available for wholesale customers?","examples":[true]},"logoUrl":{"type":["string","null"],"description":"URL of the shipping company logo","examples":["https://www.example.com/logo.png"]},"shippingCompany":{"type":"object","required":["id","code","name"],"additionalProperties":false,"properties":{"id":{"type":"integer","description":"shipping method ID.","examples":[21]},"code":{"type":"string","description":"shipping company identifier.","examples":["intime"]},"name":{"type":"string","description":"shipping company name.","examples":["IN TIME"]}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_778"},"schema_779":{"kind":"json-schema","data":{"type":"string","enum":["priceList"]},"id":"schema_779"},"schema_780":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["guid","name","description","shippingCompany","trackingUrl","visible","priority","wholesale","logoUrl"],"properties":{"guid":{"$ref":"#/components/schemas/typeGuid","description":"Unique identifier of the shipping method"},"name":{"type":"string","description":"name of shipping method, as can be seen in e-shop.","examples":["Shipping company"]},"description":{"type":["string","null"],"description":"additional information about the shipping method. (can be null)","examples":["Delivery within 48 hours"]},"shippingCompany":{"type":["object","null"],"required":["id","code","name"],"description":"Shipping company","additionalProperties":false,"properties":{"id":{"type":"integer","description":"shipping method ID.","examples":[21]},"code":{"type":"string","description":"shipping company identifier.","examples":["intime"]},"name":{"type":"string","description":"shipping company name.","examples":["IN TIME"]}}},"trackingUrl":{"type":["string","null"],"description":"package trace link pattern","examples":["http://www.ppl.cz/main2.aspx?cls=Package&idSearch=#PACKAGE_NUMBER#"]},"visible":{"type":"boolean","description":"Is the shipping method visible?","examples":[true]},"priority":{"type":["integer","null"],"description":"sequence within the list","examples":[16]},"wholesale":{"type":"boolean","description":"Is the shipping method available for wholesale customers?","examples":[true]},"logoUrl":{"type":["string","null"],"description":"URL of the shipping company logo","examples":["https://www.example.com/logo.png"]},"priceList":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing and pricelist settings of the shipping method as configured in the administration. Present only when requested via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=priceList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter. Values reflect the stored configuration, not the final price charged to the customer (which the storefront derives from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includingVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the e-shop VAT-display mode)."},"children":[]}]}]}],"additionalProperties":false,"required":["allowFreeShipping","priceTiers","pairedPaymentMethodGuids"],"properties":{"allowFreeShipping":{"type":"boolean","description":"Whether this method's price is zeroed when an external free-shipping condition applies (e.g. a free-delivery discount coupon, or a product flagged for free shipping).","examples":[true]},"priceTiers":{"type":"array","description":"Price tiers by weight and/or order price, per country/region and currency.","items":{"type":"object","additionalProperties":false,"required":["countryCode","regionId","regionName","currencyCode","priceFrom","priceUntil","weightFrom","weightUntil","price","includingVat","taxClassId","vatRate"],"properties":{"countryCode":{"type":"string","description":"Country code the tier applies to.","examples":["cz"]},"regionId":{"type":["integer","null"],"description":"Region identifier the tier applies to. (can be null)","examples":[5]},"regionName":{"type":["string","null"],"description":"Region name the tier applies to. (can be null)","examples":["Praha"]},"currencyCode":{"type":"string","description":"Currency code the tier price is defined in.","examples":["CZK"]},"priceFrom":{"$ref":"#/components/schemas/typePriceNullable","description":"Lower bound of the order price range the tier applies to. (can be null)"},"priceUntil":{"$ref":"#/components/schemas/typePriceNullable","description":"Upper bound of the order price range the tier applies to. (can be null)"},"weightFrom":{"$ref":"#/components/schemas/typeWeightUnlimited","description":"Lower bound of the weight range (kg) the tier applies to. Applied only when the e-shop uses weight-dependent shipping pricing. (can be null)"},"weightUntil":{"$ref":"#/components/schemas/typeWeightUnlimited","description":"Upper bound of the weight range (kg) the tier applies to. Applied only when the e-shop uses weight-dependent shipping pricing. (can be null)"},"price":{"$ref":"#/components/schemas/typePrice","description":"Shipping price for the tier. Value 0.00 means free shipping."},"includingVat":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the configured "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes VAT."},"children":[]}]}]}],"examples":[true]},"taxClassId":{"type":["integer","null"],"description":"Tax class identifier applied to the tier price. (can be null)","examples":[1]},"vatRate":{"$ref":"#/components/schemas/typeVatRateNullable","description":"VAT rate (percentage) of the tier's tax class in the e-shop default tax zone. (can be null)"}}}},"pairedPaymentMethodGuids":{"type":"array","description":"GUIDs of payment methods paired with this shipping method.","items":{"$ref":"#/components/schemas/typeGuid"}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_780"},"schema_781":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["stocks","defaultStockId"],"properties":{"stocks":{"type":"array","items":{"$ref":"#/components/schemas/stockList"}},"defaultStockId":{"type":"integer"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_781"},"schema_782":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["stock"],"properties":{"stock":{"$ref":"#/components/schemas/stock"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_782"},"schema_783":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["movements","paginator"],"properties":{"movements":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","productCode","actualAmount","amountChange","changedBy","changeTime"],"properties":{"id":{"type":"integer","description":"Synthetic unique incremental ID of log with changes in stock","examples":[126222]},"productCode":{"type":"string","description":"unique identification of the product variant.","examples":["26/BIL"]},"actualAmount":{"$ref":"#/components/schemas/typeAmountNullable","description":"Current quantity in stock after carrying out the change, as a decimal with three decimal places.","examples":["21.505"]},"amountChange":{"$ref":"#/components/schemas/typeAmountNullable","description":"Change in stock quantity, as a decimal with three decimal places.","examples":["0.505"]},"changedBy":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have the following values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the change was invoked by the e-shop administrator"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the change was invoked by the e-shop customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e-mail or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all other cases."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon a change invoked by a REST API request, the form of the e-mail is generated as per template `api.service-{service-id}@{e-shop-domain}."},"children":[]}]}]}]}],"examples":["novak@shoptet.cz"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"DateTime of product stock movement."},"orderCode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of order which initiated stock movement, present only with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include flag"},"children":[]}]}]}],"examples":["2017000049"]},"productGuid":{"description":"Product GUID, can be null for specific reasons, please see endpoint description for more information.","oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}]},"historicalProductGuid":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product GUID at the time of the stock movement, can be null for specific reasons and has no current relation to returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", please see endpoint description for more information."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/typeGuidUnlimited"},{"type":"null"}]},"sumAmount":{"$ref":"#/components/schemas/typeAmountNullable","description":"Sum of all stocks for the product in time after amount change was executed.","examples":["30.505"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_783"},"schema_784":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","oneOf":[{"required":["productCode","amountChange"],"additionalProperties":false,"properties":{"productCode":{"type":"string","examples":["43/BIL"]},"amountChange":{"type":"number","examples":[10]}}},{"required":["productCode","quantity"],"additionalProperties":false,"properties":{"productCode":{"type":"string","examples":["106/BIL"]},"quantity":{"type":"number","examples":[10]}}},{"required":["productCode","realStock"],"additionalProperties":false,"properties":{"productCode":{"type":"string","examples":["106/BIL"]},"realStock":{"type":"number","examples":[10]}}}]}}}},"id":"schema_784"},"schema_785":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["lastId","lastChangeTime"],"properties":{"lastId":{"type":"integer","description":"Synthetic unique incremental ID of log with changes in stock","examples":[736]},"lastChangeTime":{"$ref":"#/components/schemas/typeDateTime","description":"DateTime stock movement."}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_785"},"schema_786":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["supplies","paginator"],"properties":{"supplies":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["productGuid","code","amount","claim"],"properties":{"productGuid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"global unique permanent product identifier"},"code":{"type":"string","description":"unique identification of the product variant.","examples":["26/BIL"]},"amount":{"$ref":"#/components/schemas/typeAmountNullable","description":"current quantity in stock.","examples":["50"]},"claim":{"$ref":"#/components/schemas/typeAmountNullable","description":"requirements on stock quantity.","examples":["5"]},"location":{"type":["string","null"],"description":"stock position.","examples":["A1"]},"changeTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"date and time of last change of stock quantity (ISO 8601 format)."}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_786"},"schema_787":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["suppliers","paginator"],"properties":{"suppliers":{"type":"array","items":{"$ref":"#/components/schemas/supplier"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_787"},"schema_788":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["surchargeParameters","paginator"],"properties":{"surchargeParameters":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","code","name","displayName","description","priority","required","currency","includingVat","values","googleMapping"],"properties":{"id":{"type":"integer","description":"Id of surcharge parameter. This identifier is used on eshop frontend.","examples":[123]},"code":{"type":"string","description":"Parameter code (identifier).","examples":["potisk"]},"name":{"type":"string","description":"Name of surcharge parameter.","examples":["S potiskem"]},"displayName":{"type":["string","null"],"description":"Parameter display name.","examples":["Příplatek za potisk"]},"description":{"type":["string","null"],"description":"Description of surcharge parameter.","examples":["Ozdobný potisk"]},"priority":{"type":["integer","null"],"description":"Priority of surcharge parameter.","examples":[1]},"required":{"type":"boolean","description":"If surcharge parameter is required.","examples":[true]},"currency":{"type":"string","description":"Currency of surcharge parameter.","examples":["CZK"]},"includingVat":{"type":"boolean","description":"Is price of parameter's values including VAT.","examples":[true]},"subscription":{"type":["boolean","null"],"description":"Indicates whether this surcharge parameter is a subscription (recurring payment)","examples":[true,false]},"googleMapping":{"$ref":"#/components/schemas/googleMappingType","description":"Possible parameter mapping with google."},"values":{"type":"array","description":"Possible parameter's values.","items":{"$ref":"#/components/schemas/surchargeParameterValue"}}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_788"},"schema_789":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["name","values"],"properties":{"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable","description":"set currency value, if is not present, default currency is chosen.","examples":["CZK"]},"displayName":{"type":["string","null"],"minLength":1,"description":"Name of surcharge parameter.","examples":["Povinny"]},"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of surcharge parameter.","examples":["Povinný"]},"code":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter. If is not set, code is generated from name. When changed, you must use the new code in the next API calls.","examples":["povinny"]},"description":{"type":["string","null"],"minLength":1,"description":"Description of surcharge parameter.","examples":["Popisek"]},"required":{"type":"boolean","description":"default value is false.","examples":[true]},"includingVat":{"type":"boolean","description":"default value is true.","examples":[true]},"priority":{"type":["integer","null"],"minimum":1,"description":"Parameter priority","examples":[1]},"googleMapping":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Mapping for google.","examples":["google:gender"]},"values":{"minItems":1,"type":"array","description":"Values of parameter.","items":{"type":"object","additionalProperties":false,"required":["name","price"],"properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"Name of parameter value","examples":["Modrý"]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"Additional price of surcharge parameter."},"valueIndex":{"type":["string","null"],"minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter value. Maximal length of 255 characters. If is not set, code is generated from name.","examples":["modry"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Priority of parameter value.","examples":[1]}}}}}}}},"id":"schema_789"},"schema_790":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["surchargeParameter"],"properties":{"surchargeParameter":{"type":"object","additionalProperties":false,"required":["id","code","name","displayName","description","priority","required","currency","includingVat","values","googleMapping"],"properties":{"id":{"type":"integer","description":"Id of surcharge parameter. This identifier is used on eshop frontend.","examples":[123]},"code":{"type":"string","description":"Parameter code (identifier).","examples":["potisk"]},"name":{"type":"string","description":"Name of surcharge parameter.","examples":["S potiskem"]},"displayName":{"type":["string","null"],"description":"Parameter display name.","examples":["Příplatek za potisk"]},"description":{"type":["string","null"],"description":"Description of surcharge parameter.","examples":["Ozdobný potisk"]},"priority":{"type":["integer","null"],"description":"Priority of surcharge parameter.","examples":[1]},"required":{"type":"boolean","description":"If surcharge parameter is required.","examples":[true]},"currency":{"type":"string","description":"Currency of surcharge parameter.","examples":["CZK"]},"includingVat":{"type":"boolean","description":"Is price of parameter's values including VAT.","examples":[true]},"subscription":{"type":["boolean","null"],"description":"Indicates whether this surcharge parameter is a subscription (recurring payment)","examples":[true,false]},"googleMapping":{"$ref":"#/components/schemas/googleMappingType","description":"Possible parameter mapping with google."},"values":{"type":"array","description":"Possible parameter's values.","items":{"$ref":"#/components/schemas/surchargeParameterValue"}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_790"},"schema_791":{"kind":"json-schema","data":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of surcharge parameter.","examples":["Povinný"]},"code":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter. If is not set, code is generated from name. When changed, you must use the new code in the next API calls.","examples":["povinny"]},"displayName":{"type":["string","null"],"minLength":1,"description":"Name of surcharge parameter.","examples":["Povinny"]},"description":{"type":["string","null"],"minLength":1,"description":"Description of surcharge parameter.","examples":["Popisek"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Parameter priority","examples":[1]},"googleMapping":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Mapping for google.","examples":["google:gender"]},"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable","description":"set currency value, if is not present, default currency is chosen.","examples":["CZK"]},"required":{"type":"boolean","description":"default value is false.","examples":[true]},"includingVat":{"type":"boolean","description":"default value is true.","examples":[true]}}}}},"id":"schema_791"},"schema_792":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["surchargeParameter"],"properties":{"surchargeParameter":{"type":"object","additionalProperties":false,"required":["id","code","name","displayName","description","priority","required","currency","includingVat","googleMapping"],"properties":{"id":{"type":"integer","description":"Id of surcharge parameter. This identifier is used on eshop frontend.","examples":[123]},"code":{"type":"string","description":"Parameter code (identifier).","examples":["potisk"]},"name":{"type":"string","description":"Name of surcharge parameter.","examples":["S potiskem"]},"displayName":{"type":["string","null"],"description":"Parameter display name.","examples":["Příplatek za potisk"]},"description":{"type":["string","null"],"description":"Description of surcharge parameter.","examples":["Ozdobný potisk"]},"priority":{"type":["integer","null"],"description":"Priority of surcharge parameter.","examples":[1]},"required":{"type":"boolean","description":"If surcharge parameter is required.","examples":[true]},"currency":{"type":"string","description":"Currency of surcharge parameter.","examples":["CZK"]},"includingVat":{"type":"boolean","description":"Is price of parameter's values including VAT.","examples":[true]},"googleMapping":{"$ref":"#/components/schemas/googleMappingType","description":"Possible parameter mapping with google."}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_792"},"schema_793":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["paramValues"],"properties":{"paramValues":{"minItems":1,"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","price"],"properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"Name of parameter value.","examples":["Modrý"]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"Additional price of surcharge parameter."},"valueIndex":{"type":["string","null"],"minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter value. Maximal length of 255 characters. If is not set, code is generated from name.","examples":["modry"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Parameter value priority","examples":[1]}}}}}}}},"id":"schema_793"},"schema_794":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":128,"description":"Name of the parameter value","examples":["Modrý"]},"valueIndex":{"type":["string","null"],"minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter value. If is not set, code is generated from name. When changed, you must use the new valueIndex in the next API calls.","examples":["modry"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Parameter value priority.","examples":[1]},"price":{"$ref":"#/components/schemas/typePriceNullable","description":"Additional price of surcharge parameter."}}}}},"id":"schema_794"},"schema_795":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["units"],"properties":{"units":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","name","system"],"properties":{"id":{"type":"integer","description":"Unit id. Negative number indicates system units. Positive numbers are defined by customer.","examples":[-1]},"name":{"type":"string","description":"Unit name","examples":["kg"]},"system":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - system units, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - custom units."},"children":[]}]}]}],"examples":[true]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_795"},"schema_796":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["parameters","paginator"],"properties":{"parameters":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","paramName","paramIndex","priority"],"properties":{"id":{"type":"integer","description":"ID of the parameter","examples":[1]},"paramName":{"type":["string","null"],"description":"name of the parameter","examples":["Color"]},"paramIndex":{"type":"string","description":"index of the parameter (identifier)","examples":["color"]},"displayName":{"type":["string","null"],"description":"Parameter display name","examples":["Barva"]},"priority":{"type":["integer","null"],"description":"priority of the parameter","examples":[1]},"values":{"type":"array","description":"Possible parameter values","items":{"$ref":"#/components/schemas/productVariantParameterValue"}}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_796"},"schema_797":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["paramName"],"properties":{"paramName":{"type":"string","minLength":1,"maxLength":255,"description":"Name of parameter. Maximal length of 255 characters","examples":["Barevné spektrum"]},"paramIndex":{"type":["string","null"],"minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter. Maximal length of 255 characters.","examples":["barevne-spektrum"]},"displayName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Parameter display name","examples":["Barva"]},"priority":{"type":["integer","null"],"minimum":1,"description":"Priority of parameter","examples":[20]},"values":{"$ref":"#/components/schemas/productVariantParameterValues"}}}}},"id":"schema_797"},"schema_798":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["id","paramName","paramIndex","priority"],"properties":{"id":{"type":"integer","description":"ID of the parameter","examples":[1]},"paramName":{"type":["string","null"],"description":"name of the parameter","examples":["Color"]},"paramIndex":{"type":"string","description":"index of the parameter (identifier)","examples":["color"]},"displayName":{"type":["string","null"],"description":"Parameter display name","examples":["Barva"]},"priority":{"type":["integer","null"],"description":"priority of the parameter","examples":[1]},"values":{"type":"array","description":"Possible parameter values","items":{"$ref":"#/components/schemas/productVariantParameterValue"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_798"},"schema_799":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"paramName":{"type":"string","minLength":1,"maxLength":255,"description":"Name of parameter value. Maximal length of 255 characters.","examples":["Color"]},"displayName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Parameter display name","examples":["Barva"]},"paramIndex":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter value. Maximal length of 255 characters. When changed, you must use the new paramIndex in the next API calls.","examples":["color"]},"priority":{"type":"integer","minimum":1,"description":"Parameter value priority.","examples":[1]}}}}},"id":"schema_799"},"schema_800":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["paramValues"],"properties":{"paramValues":{"minItems":1,"$ref":"#/components/schemas/productVariantParameterValues"}}}}},"id":"schema_800"},"schema_801":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"paramValue":{"type":"string","minLength":1,"maxLength":128,"description":"Name of parameter value. Maximal length of 255 characters.","examples":["Červená"]},"rawValue":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9\\-]*$","description":"Url friendly name of parameter value. Maximal length of 255 characters. When changed, you must use the new rawValue in the next API calls.","examples":["cervena"]},"color":{"$ref":"#/components/schemas/typeColor","description":"Color hex code. Minimal length of 1 character. Maximal length of 8 characters."},"image":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Image name. Image needs to exist in your file folder.","examples":["car-001.jpg"]},"valuePriority":{"type":"integer","minimum":1,"description":"Parameter value priority.","examples":[1]}}}}},"id":"schema_801"},"schema_802":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["warranties"],"properties":{"warranties":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","inMonths","description","system"],"properties":{"id":{"type":"integer","description":"Warranty id. Negative number indicates system warranties. Positive numbers are defined by customer.","examples":[-1]},"inMonths":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warranty length in months (can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Negative number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") means infinite (lifetime) warranty."},"children":[]}]}]}],"examples":[12]},"description":{"type":"string","description":"Warranty description.","examples":["One year warranty"]},"system":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"- system warranties,"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false` - custom warranties."},"children":[]}]}]}],"examples":[true]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_802"},"schema_803":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["salesChannels"],"properties":{"salesChannels":{"type":"array","items":{"type":"object","required":["id","guid","name","type","abilities","currencies","languages","createdAt","updatedAt"],"properties":{"id":{"type":"integer","description":"Sales channel ID.","examples":[1]},"guid":{"$ref":"#/components/schemas/typeGuid","description":"Sales channel GUID."},"name":{"type":"string","description":"Sales channel name.","examples":["My sales channel"]},"type":{"enum":["in_store","online_store","marketplace","system"],"description":"Type of sales channel.","examples":["in_store"]},"abilities":{"type":"array","items":{"type":"string","enum":["delivery_method_linkable","disable_order_status_email_notification","disable_shipment_status_email_notification","enable_update_in_detail_pages","payment_method_linkable"]},"description":"List of abilities of the sales channel."},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/typeCurrency"},"description":"Currencies collection."},"languages":{"type":"array","items":{"$ref":"#/components/schemas/typeLanguage"},"description":"Languages collection."},"createdAt":{"$ref":"#/components/schemas/typeDateTime"},"updatedAt":{"$ref":"#/components/schemas/typeDateTimeNullable"}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_803"},"schema_804":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["salesChannel","onlineStore","inStore","marketplace"],"properties":{"salesChannel":{"type":"object","additionalProperties":false,"required":["id","guid","name","type","abilities","currencies","languages","createdAt","updatedAt"],"properties":{"id":{"type":"integer","description":"Sales channel ID.","examples":[1]},"guid":{"$ref":"#/components/schemas/typeGuid","description":"Sales channel GUID."},"name":{"type":"string","description":"Sales channel name.","examples":["My sales channel"]},"type":{"enum":["in_store","online_store","marketplace","system"],"description":"Type of sales channel.","examples":["in_store"]},"abilities":{"type":"array","items":{"type":"string","enum":["delivery_method_linkable","disable_order_status_email_notification","disable_shipment_status_email_notification","enable_update_in_detail_pages","payment_method_linkable"]},"description":"List of abilities of the sales channel."},"defaultCurrency":{"type":["string","null"],"description":"Sales channel default currency.","examples":["CZK"]},"currencies":{"type":"array","items":{"$ref":"#/components/schemas/typeCurrency"},"description":"Currencies collection."},"defaultLanguage":{"type":["string","null"],"description":"Sales channel default language.","examples":["cs"]},"languages":{"type":"array","items":{"$ref":"#/components/schemas/typeLanguage"},"description":"Languages collection."},"createdAt":{"$ref":"#/components/schemas/typeDateTime"},"updatedAt":{"$ref":"#/components/schemas/typeDateTimeNullable"}}},"onlineStore":{"type":["object","null"],"additionalProperties":false,"required":["id","status","isPasswordProtected","isPrimary"],"properties":{"id":{"type":"integer","description":"Online store identifier.","examples":[1]},"name":{"type":"string","description":"Name of online store.","examples":["Czech republic"]},"status":{"type":"string","description":"Online store status","enum":["active","pending"],"examples":["active"]},"domain":{"type":["string"],"description":"Online store domain.","examples":["store.example.com"]},"domainSetupMethod":{"type":["string","null"],"description":"Online store domain setup method.","examples":["unresolved"]},"addressFormat":{"type":"string","description":"Address format of online store.","examples":["INTERNAL_PROJECT_CZ"]},"timezone":{"type":"string","description":"Timezone of online store.","examples":["Europe/Prague"]},"defaultCountry":{"$ref":"#/components/schemas/onlineStoreCountry","description":"Default country of online store."},"countries":{"type":"array","description":"Countries of online store.","items":{"$ref":"#/components/schemas/onlineStoreCountry"}},"isPasswordProtected":{"type":"boolean","description":"Whether the online store is protected by password.","examples":[false]},"isPrimary":{"type":"boolean","description":"Whether the online store is primary.","examples":[true]},"design":{"$ref":"#/components/schemas/onlineStoreDesign","description":"Online store design."}}},"inStore":{"type":["object","null"],"required":["id","guid","address","contact","categoryId"],"properties":{"id":{"type":"integer","description":"In-store identifier.","examples":[1]},"guid":{"type":"string","description":"In-store GUID.","examples":["550e8400-e29b-41d4-a716-446655440000"]},"address":{"oneOf":[{"$ref":"#/components/schemas/inStoreAddress"},{"type":"null"}],"description":"In-store address (can be null)."},"contact":{"$ref":"#/components/schemas/inStoreContact","description":"In store contact information."},"categoryId":{"type":"integer","description":"Project category identifier.","examples":[2]}}},"marketplace":{"type":["object","null"]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_804"},"schema_805":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["endpoints"],"properties":{"endpoints":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["endpoint","description","group","access","action"],"properties":{"endpoint":{"type":"string","description":"endpoint identifier","examples":["orders"]},"description":{"type":"string","description":"localized endpoint name","examples":["List of orders"]},"group":{"type":"object","additionalProperties":false,"required":["id","description"],"properties":{"id":{"type":"integer","description":"endpoint group ID","examples":[2]},"description":{"type":"string","description":"localized group name","examples":["Orders"]}}},"access":{"type":"string","enum":["read","write","both"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read/write rights. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"write"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"both"},"children":[]}]}]}],"examples":["read"]},"action":{"type":["string","null"],"enum":["add","edit","delete",null],"examples":["add"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action for approval of endpoints. Possible values ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"], or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for endpoints already approved."},"children":[]}]}]}]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_805"},"schema_806":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["images"],"properties":{"images":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"filename of uploaded file","examples":["image.jpg"]},"created":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"datetime when file was uploaded"}}}},"files":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"filename of uploaded file","examples":["image.jpg"]},"created":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"datetime when file was uploaded"}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_806"},"schema_807":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","additionalProperties":false,"required":["sourceUrl"],"properties":{"sourceUrl":{"type":"string","description":"source URL of the image you want to upload.","examples":["https://example.com/file.png"]},"name":{"$ref":"#/components/schemas/typeFilename","description":"desired filename for the file to be saved as. May be suffixed with number in case of duplication. Generated when not set.","examples":["amazing-filename.png"]}}}}}},"id":"schema_807"},"schema_808":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["sourceUrl"],"properties":{"sourceUrl":{"type":"string","description":"source URL of the image you want to upload.","examples":["https://example.com/file.png"]},"name":{"$ref":"#/components/schemas/typeFilename","description":"desired filename for the file to be saved as. May be suffixed with number in case of duplication. Generated when not set.","examples":["amazing-filename.png"]}}}}},"id":"schema_808"},"schema_809":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"properties":{"image":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filename of saved file, used for assign file in 'source*' parameters."},"children":[]}]}]}],"examples":["file.png"]},"created":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"datetime when file was uploaded"}}},"file":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filename of saved file, used for assign file in 'source*' parameters."},"children":[]}]}]}],"examples":["file.pdf"]},"created":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"datetime when file was uploaded"}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_809"},"schema_810":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["jobs","paginator"],"properties":{"jobs":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["jobId","endpoint","creationTime","completionTime","status","validUntil"],"properties":{"jobId":{"type":"string","description":"job unique code.","examples":["3ax1844"]},"endpoint":{"type":"string","description":"called endpoint by service","examples":["/api/products/images"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"time of job creation"},"completionTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"time of job completion"},"status":{"type":"string","description":"job status","examples":["completed"]},"validUntil":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"validity of job result"},"language":{"type":["string","null"],"description":"Available only if module Foreign languages is active and initialized.","examples":["cs"]}}}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_810"},"schema_811":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["job"],"properties":{"job":{"type":"object","additionalProperties":false,"required":["jobId","endpoint","creationTime","completionTime","duration","status","resultUrl","log","validUntil"],"properties":{"jobId":{"type":"string","description":"job unique code.","examples":["3ax1844"]},"endpoint":{"type":"string","description":"called endpoint by service","examples":["/api/products/images"]},"creationTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"time of job creation"},"completionTime":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"time of job completion"},"duration":{"type":["string","null"],"description":"duration of job in seconds with ms","examples":["20.123"]},"status":{"type":"string","description":"job status","examples":["completed"]},"resultUrl":{"type":["string","null"],"description":"URL to the result of the job","examples":["https://eshop.domain.com/api-results/3ax1844-lrmsrf0.json"]},"validUntil":{"$ref":"#/components/schemas/typeDateTimeNullable","description":"validity of job result"},"log":{"type":["string","null"],"description":"content of log produced by job processing","examples":["Some really long text"]},"language":{"type":["string","null"],"description":"Available only if module Foreign languages is active and initialized.","examples":["cs"]}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_811"},"schema_812":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["measureUnits"],"properties":{"measureUnits":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id","unitName","priority","ratios"],"properties":{"id":{"type":"integer","description":"Measure unit ID","examples":[-16]},"unitName":{"type":"string","description":"Measure unit name","examples":["kg"]},"priority":{"type":["integer","null"],"description":"Unit priority specifies the order of measure units.","examples":[11]},"ratios":{"type":"array","description":"List of other units which are convertible to this one.","items":{"type":"object","additionalProperties":false,"required":["unitId","ratio"],"properties":{"unitId":{"type":"integer","description":"Unit ID","examples":[5]},"ratio":{"$ref":"#/components/schemas/typeUnitRatio"}}}}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_812"},"schema_813":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["orderCode","returnUrl"],"properties":{"orderCode":{"type":"string","description":"order number. Caution! This does not have to be number only, it can contain also letters, dash, etc.","examples":["2018000016"]},"returnUrl":{"type":"string","description":"URL, where the payment gateway should be redirected to, after the payment is completed","examples":["https://www.domena-eshopu.cz/api/pay/apigate/return?paymentCode=os8FtURz7PpO46Z87euEAoBAn9RClB2d"]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_813"},"schema_814":{"kind":"json-schema","data":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"required":["status"],"type":"object","additionalProperties":false,"properties":{"status":{"type":"string","enum":["FAILED","OK","PENDING"],"description":"transaction status","examples":["OK"]},"message":{"type":["string","null"],"maxLength":255,"description":"Explanation of the status","examples":["Not enough finances on the card"]}}}}},"id":"schema_814"},"schema_815":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["eshop","items"],"properties":{"eshop":{"type":"object","additionalProperties":false,"required":["eshopId","eshopUrl","vatPayer"],"properties":{"eshopId":{"type":"integer","description":"Eshop ID.","examples":[222651]},"eshopUrl":{"type":"string","description":"Eshop URL.","examples":["https://www.example.com"]},"vatPayer":{"type":"boolean","description":"identify if e-shop is VAT payer or not.","examples":[true]}}},"cart":{"type":"object","additionalProperties":false,"required":["price","currency"],"description":"Cart information","properties":{"price":{"$ref":"#/components/schemas/cartPrice","description":"Information about total price in cart"},"currency":{"$ref":"#/components/schemas/typeCurrencyCode","description":"Currency code of cart"},"freeShipping":{"type":"boolean","description":" Whether cart currently has freeShipping (because of coupon or amount)","examples":[false]}}},"items":{"type":"array","description":"List of items in cart (without price)","items":{"type":"object","required":["productGuid","code","itemType","name","variantName","brand","weight","amount","amountUnit"],"additionalProperties":false,"properties":{"productGuid":{"$ref":"#/components/schemas/typeGuidUnlimited","description":"unique product indicator"},"code":{"type":"string","description":"Product code","examples":["40"]},"itemType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/product-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["product"]},"name":{"type":"string","description":"Product name","examples":["Komplet"]},"variantName":{"type":"string","description":"Product variant name","examples":["Komplet - bílý"]},"brand":{"oneOf":[{"$ref":"#/components/schemas/brandNamed"},{"type":"null"}],"description":"Product brand"},"weight":{"$ref":"#/components/schemas/typeWeight"},"amount":{"$ref":"#/components/schemas/typePositiveAmountNullable","description":"amount of ordered product.","examples":[1]},"amountUnit":{"type":["string","null"],"description":"unit of order product","examples":["pcs"]}}}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_815"},"schema_816":{"kind":"json-schema","data":{"type":"object","required":["data"],"additionalProperties":false,"properties":{"data":{"type":"object","additionalProperties":false,"required":["expires","trackingNumber"],"properties":{"description":{"type":"string","minLength":1,"description":"description of the shipping request.","examples":["Express delivery"]},"additionalText":{"type":["string","null"],"minLength":1,"description":"additional information about the shipping request. (can be null)","examples":["Delivery within 48 hours`"]},"price":{"type":["object","null"],"anyOf":[{"required":["priceWithVat","vatRate"]},{"required":["priceWithoutVat","vatRate"]}],"additionalProperties":false,"properties":{"priceWithVat":{"$ref":"#/components/schemas/typePrice","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of delivery with VAT (this or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithoutVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be filled)."},"children":[]}]}]}],"examples":["121.00"]},"priceWithoutVat":{"$ref":"#/components/schemas/typePrice","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price of delivery without VAT (this or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priceWithVat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be filled)."},"children":[]}]}]}],"examples":["100.00"]},"vatRate":{"$ref":"#/components/schemas/typeVatRate","description":"VAT rate of delivery.","examples":["21.00"]}}},"currency":{"$ref":"#/components/schemas/typeCurrencyCodeNullable"},"expires":{"$ref":"#/components/schemas/typeDateTimeRequest","description":"Time indicates availability of chosen delivery. Deprecation of required timezone part of datetime, and will be removed in the future"},"deliveryAddress":{"type":"object","additionalProperties":false,"properties":{"fullName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of purchaser (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["John Doe"]},"company":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name of purchaser''s company (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Shoptet s.r.o."]},"street":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street of purchaser (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["French"]},"houseNumber":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"street number (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["123"]},"city":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"city/town (village) (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Praha 2"]},"district":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"county (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Praha 2"]},"additional":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"additional address information (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["4. floor"]},"zip":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP or postal code (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["120 00"]},"countryCode":{"type":["string","null"],"description":"tree-character ISO country code (ISO 4217)","examples":["CZ"]},"regionName":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region name (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["Capital city"]},"regionShortcut":{"type":["string","null"],"minLength":1,"maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"region abbreviation (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"examples":["CC"]}}},"trackingNumber":{"type":"string","maxLength":255,"description":"Tracking number for see status of delivery.","examples":["U134666"]},"branchId":{"type":["string","null"],"maxLength":255,"description":"Identification of selected pickup point.","examples":["314012"]},"branchName":{"type":["string","null"],"maxLength":255,"description":"Name of selected pickup point.","examples":["Čáslav, Jeníkovská 362/66 [Irma Rajmová - Trafika]"]}}}}},"id":"schema_816"},"schema_817":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["verificationCode"],"properties":{"verificationCode":{"type":"string","description":"VerificationCode of shipping to be used in JS","examples":["abcdefghij"]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_817"},"schema_818":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","required":["status","orderCode"],"additionalProperties":false,"properties":{"status":{"type":"string","description":"Status of the order","examples":["open"]},"orderCode":{"type":["string","null"],"description":"Order code","examples":["20200010"]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_818"},"schema_819":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["webhooks","paginator"],"properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/webhook"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_819"},"schema_820":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["event","url"],"properties":{"event":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list"},"children":[]}]}]}],"examples":["order:create","order:update","order:delete"]},"url":{"type":"string","maxLength":2000,"description":"Webhook URL","examples":["https://myapplication.tld/orders.php"]},"sendPayload":{"type":["string","null"],"enum":["full",null],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the webhook notification body will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with the full entity data. Only supported for events marked as payload-supported in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. For other events, this field has no effect."},"children":[]}]}]}]}}}}}},"id":"schema_820"},"schema_821":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["webhooks"],"properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/webhook"}}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_821"},"schema_822":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["webhook"],"properties":{"webhook":{"$ref":"#/components/schemas/webhook"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_822"},"schema_823":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"url":{"type":"string","examples":["https://myapplication.tld/orders-new.php"],"maxLength":2000},"sendPayload":{"type":["string","null"],"enum":["full",null],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the webhook notification body will include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field with the full entity data. Only supported for events marked as payload-supported in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/code-lists/webhook-event-types"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook event types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code list. For other events, this field has no effect."},"children":[]}]}]}]}}}}},"id":"schema_823"},"schema_824":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["signatureKey"],"properties":{"signatureKey":{"type":"string","examples":["8a5e881b19ad6cc0bc986587b22e30be"]}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_824"},"schema_825":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","additionalProperties":false,"required":["notifications","paginator"],"properties":{"notifications":{"type":"array","items":{"$ref":"#/components/schemas/webhookNotification"}},"paginator":{"$ref":"#/components/schemas/paginator"}}},"errors":{"$ref":"#/components/schemas/Errors"},"metadata":{"$ref":"#/components/schemas/Metadata"}},"required":["data","errors","metadata"],"additionalProperties":false},"id":"schema_825"}},"exampleStore":{"paths/~1api~1orders/get/responses/400/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-parameter","message":"Invalid \"orderCodes\" parameter. Expected max. 50 elements, but 55 given.","instance":"orderCodes"},{"errorCode":"missing-parameter","message":"Missing value for parameter \"orderCodes\".","instance":"orderCodes"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders/get/responses/400/content/application~1json/example"},"paths/~1api~1orders/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"It requires active consumptionTax module in eshop when \"consumptionTax\" is present in order items data.","instance":"consumptionTax"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders/post/responses/403/content/application~1json/example"},"paths/~1api~1orders/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Consumption tax with id \"4\" not found.","instance":"payload"},{"errorCode":"invalid-request-data","message":"Consumption tax with id \"2\" is not visible.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders/post/responses/422/content/application~1json/example"},"paths/~1api~1orders~1snapshot/get/responses/400/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-parameter","message":"Invalid \"orderCodes\" parameter. Expected max. 50 elements, but 55 given.","instance":"orderCodes"},{"errorCode":"missing-parameter","message":"Missing value for parameter \"orderCodes\".","instance":"orderCodes"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1snapshot/get/responses/400/content/application~1json/example"},"paths/~1api~1orders~1status-change/patch/responses/400/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Orders with codes 2017000040, 2017000041, 2017000042, 2017000043, 2017000044, 2017000045 do not exist. Skipped.","instance":"data.orderCodes"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1status-change/patch/responses/400/content/application~1json/example"},"paths/~1api~1orders~1status-change/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Invalid statusId \"2026\".","instance":"data.statusId"},{"errorCode":"invalid-request-data","message":"There must be a maximum of 100 items in the array","instance":"data.orderCodes"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1status-change/patch/responses/422/content/application~1json/example"},"paths/~1api~1orders~1{code}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order with code \"0000000001\" not found.","instance":"0000000001"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}/delete/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-withdrawal-present","message":"Order with code \"0000000001\" cannot be deleted as a withdrawal from the purchase contract has been requested for it.","instance":"0000000001"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}/delete/responses/409/content/application~1json/example"},"paths/~1api~1orders~1{code}~1head/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"record-already-changed","message":"Order has been changed before update.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1head/patch/responses/409/content/application~1json/example"},"paths/~1api~1orders~1{code}~1pdf/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2018000004\" not found.","instance":"2018000004"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1pdf/get/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1pdf/get/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"document-not-generated","message":"Error while getting document type \"order\" with code\n\"2018000004\".","instance":"2018000004"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1pdf/get/responses/500/content/application~1json/example"},"paths/~1api~1orders~1{code}~1notes/patch/requestBody/content/application~1json/example":{"value":{"data":{"customerRemark":"Deliver to mailing addres","trackingNumber":"DR1234567890E","additionalFields":[{"index":1,"text":"Text of additional field no. 1"},{"index":2,"text":"Text of additional field no. 2"},{"index":3,"text":"Text of additional field no. 3"},{"index":4,"text":"Text of additional field no. 4"},{"index":5,"text":"Text of additional field no. 5"},{"index":6,"text":"Text of additional field no. 6"}],"eshopRemark":"In stock from 20.1. 2019"}},"id":"paths/~1api~1orders~1{code}~1notes/patch/requestBody/content/application~1json/example"},"paths/~1api~1orders~1{code}~1notes/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2018000012\" not found.","instance":"2018000012"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1notes/patch/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1status/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2018000012\" not found.","instance":"2018000012"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1status/patch/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1status/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"record-already-changed","message":"Order has been changed before update.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1status/patch/responses/409/content/application~1json/example"},"paths/~1api~1orders~1{code}~1copy/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2018000012\" not found.","instance":"2018000012"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1copy/post/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1copy/post/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"unknown-error","message":"Unknown error occurred during order duplication.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1copy/post/responses/500/content/application~1json/example"},"paths/~1api~1orders~1batch/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File \"https://jsonlines.org/orders.jsonl\" not found.","instance":"batchFileUrlPath"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1batch/post/responses/404/content/application~1json/example"},"paths/~1api~1orders~1batch/post/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"batch-job-already-running","message":"Concurrent job already running!","instance":"orders-batch-insert"},{"errorCode":"another-import-is-running","message":"Another import is running. Please try again later.","instance":"orders-batch-insert"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1batch/post/responses/409/content/application~1json/example"},"paths/~1api~1orders~1gifts~1{id}/delete/responses/200/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"example-error-code","message":"Example error message","instance":"instance"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1gifts~1{id}/delete/responses/200/content/application~1json/example"},"paths/~1api~1orders~1{code}~1history/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-history-item-exceeded-limit","message":"Order history item count limit exceeded (100) for order \"2018000012\".","instance":"2018000012"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1history/post/responses/403/content/application~1json/example"},"paths/~1api~1orders~1{code}~1history/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2018000012\" not found.","instance":"2018000012"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1history/post/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1history/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Does not have a value in the enumeration [\"comment\",\"system\"]","instance":"data.type"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1history/post/responses/422/content/application~1json/example"},"paths/~1api~1orders~1{code}~1history~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-history-deletion-failed","message":"Cannot delete order history item \"2073\".","instance":"2073"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1history~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1item/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"It requires active consumptionTax module in eshop when \"consumptionTax\" is present in order items data.","instance":"consumptionTax"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1item/post/responses/403/content/application~1json/example"},"paths/~1api~1orders~1{code}~1item/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Consumption tax with id \"4\" not found.","instance":"payload"},{"errorCode":"invalid-request-data","message":"Consumption tax with id \"2\" is not visible.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1item/post/responses/422/content/application~1json/example"},"paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"It requires active consumptionTax module in eshop when \"consumptionTax\" is present in order items data.","instance":"consumptionTax"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/403/content/application~1json/example"},"paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"currency-not-found","message":"Currency code \"BHJ\" not found.","instance":"data.currency"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"record-already-changed","message":"Order has been changed before update.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/409/content/application~1json/example"},"paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"You can send consumptionTaxId or consumptionTax, but not both!","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"Consumption tax with id \"4\" not found.","instance":"payload"},{"errorCode":"invalid-request-data","message":"Consumption tax with id \"2\" is not visible.","instance":"payload"},{"errorCode":"invalid-order-item-type-change","message":"The item type cannot be changed. Changing the type from \"product\" to \"discount-coupon\" is not allowed.","instance":"data.itemType"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"},"paths/~1api~1orders~1{code}~1item~1{id}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-item-withdrawal-present","message":"Order item 198 cannot be deleted because a withdrawal from the purchase contract has been requested for it.","instance":"request"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1item~1{id}/delete/responses/409/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"credit-note-not-found","message":"Credit note with code \"000000000633\" not found.","instance":"000000000633"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"record-already-changed","message":"Credit note has been changed before update.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}/patch/responses/409/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Field cannot be empty string.","instance":"data.reasonRemark"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}/patch/responses/422/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"credit-note-not-found","message":"Credit note with code \"99\" not found.","instance":"99"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}/delete/responses/404/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}~1restock/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"credit-note-not-found","message":"Credit note with code \"0000000002\" not found.","instance":"000000000633"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}~1restock/post/responses/404/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}~1restock/post/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"credit-note-already-restocked","message":"Credit note with code \"0000000002\" already restocked.","instance":"0000000002"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}~1restock/post/responses/409/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-1":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Field cannot be empty string.","instance":"data.reasonRemark"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"invalid-request-data-1","summary":"invalid-request-data-1","id":"paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-1"},"paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-2":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Provided item amount for id \\\"123\\\" is greater than current document item amount.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"invalid-request-data-2","summary":"invalid-request-data-2","id":"paths/~1api~1invoices~1{code}~1credit-note/post/responses/422/content/application~1json/examples/invalid-request-data-2"},"paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-of-payment-not-found","message":"Proof payment with code \"P-2014000004-01\" does not exist.","instance":"P-2014000004-01"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-already-linked-to-invoice","message":"Credit note cannot be created from proof payment with invoice code \"2017000045\".","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"Field cannot be empty string.","instance":"data.reasonRemark"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/409/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unable to create credit note. Proof payment \"P-2017000024-01\" is in invalid state.","instance":"data.reasonRemark"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}~1credit-note/post/responses/422/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"credit-note-item-price-lower-than-zero","message":"Price must be greater or equal than zero.","instance":"data.price"},{"errorCode":"credit-note-item-greater-than-invoice","message":"Price must be equal or lower than connected invoice price.","instance":"data.price"},{"errorCode":"credit-note-item-amount-lower-than-invoice","message":"Amount must be equal or greater than connected invoice price.","instance":"data.amount"},{"errorCode":"credit-note-item-amount-greater-than-zero","message":"Amount must be lower than zero.","instance":"data.amount"},{"errorCode":"credit-note-item-invalid-vat-rate","message":"Unsupported \"tax\" value \"99.00\" given. Supported values are \"12.00, 21.00\".","instance":"data.vatRate"},{"errorCode":"credit-note-item-mismatch","message":"Credit note item with ID 1 doesn\\'t belong to the credit note with code \"001\".","instance":"data.vatRate"}]},"id":"paths/~1api~1credit-notes~1{code}~1item~1{id}/patch/responses/422/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Credit note item with ID \"956\" was not found.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}~1item~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}~1pdf/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"credit-note-not-found","message":"Credit note with code \"0000000002\" not found.","instance":"0000000002"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}~1pdf/get/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"document-not-generated","message":"Error while getting document type \"creditNote\" with code\n\"0000000002\".","instance":"0000000002"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"credit-note-not-found","message":"Credit note with code \"0000000002\" not found.","instance":"0000000002"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/404/content/application~1json/example"},"paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"document-not-generated","message":"Error while getting document type \"creditNote\" with code\n\"0000000002\".","instance":"0000000002"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1credit-notes~1{code}~1isdoc/get/responses/500/content/application~1json/example"},"paths/~1api~1orders~1{code}~1delivery-notes/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2018000012\" not found.","instance":"2018000012"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1delivery-notes/post/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1delivery-notes/post/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"delivery-note-already-exist","message":"Delivery note code must be unique.","instance":"2018000012"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1delivery-notes/post/responses/409/content/application~1json/example"},"paths/~1api~1orders~1{code}~1delivery-notes/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unable to create a delivery note. The order 2015000205 is in the Cancel status.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1delivery-notes/post/responses/422/content/application~1json/example"},"paths/~1api~1delivery-notes~1snapshot/get/responses/202/content/application~1json/example":{"value":{"data":{"jobId":"ad24xod"},"errors":[{"errorCode":"example-error-code","message":"Example error message","instance":"instance"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1delivery-notes~1snapshot/get/responses/202/content/application~1json/example"},"paths/~1api~1delivery-notes~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"delivery-note-not-found","message":"Delivery note with code \"000000000633\" not found.","instance":"000000000633"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1delivery-notes~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"delivery-note-not-found","message":"Delivery note with code \"0000000001\" not found.","instance":"0000000001"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/404/content/application~1json/example"},"paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"document-not-generated","message":"Error while getting document type \"deliveryNote\" with code\n\"0000000001\".","instance":"0000000001"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1delivery-notes~1{code}~1pdf/get/responses/500/content/application~1json/example"},"paths/~1api~1invoices~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invoice-not-found","message":"Invoice with code \"000000000633\" not found.","instance":"000000000633"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1orders~1{code}~1invoice/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unable to create invoice. Order 2017000045 is in the cancelled state.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1orders~1{code}~1invoice/post/responses/422/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invoice-not-found","message":"Invoice with code \"201500006\" does not exists.","instance":"invoiceCode"},{"errorCode":"proforma-invoice-not-found","message":"Proforma invoice with code \"2017100035\" does not exists.","instance":"2017100035"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/404/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proforma-invoice-already-linked-to-invoice","message":"Proforma invoice with code \"2024269999\" is already linked to the invoice \"2015000138\".","instance":"2024269999"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/409/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proforma-invoice-not-related-to-order","message":"Proforma invoice with code \"2024269999\" is not related to the order with code \"2015000138\".","instance":"2024269999"},{"errorCode":"proforma-invoice-and-invoice-has-different-currency","message":"Proforma invoice with code \"O-2017000017-01\" is not in the same currency as the invoice \"2017100013\".","instance":"O-2017000017-01"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1link-proforma-invoice/patch/responses/422/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-found","message":"Proof payment with code \"O-2017000017-01\" not found.","instance":"O-2017000017-01"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/404/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-already-linked-to-invoice","message":"Proof payment with code \"O-2017000017-01\" is already linked\nto the invoice \"%s\".","instance":"data.proofPaymentCodes"},{"errorCode":"proof-payments-closed","message":"Proof payment with code \"O-2017000044-01\" is closed. Unlock\nproof payment first.","instance":"O-2017000044-01"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/409/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-related-to-order","message":"Proof payment with code \"O-2017000017-01\" is not related to\nthe order with code \"2017000044\".","instance":"data.proofPaymentCodes"},{"errorCode":"proof-payments-and-invoice-has-different-currency","message":"Proof payment with code \"O-2017000017-01\" is not in the same\ncurrency as the invoice \"2017100013\".","instance":"data.proofPaymentCodes"},{"errorCode":"proof-payments-invalid","message":"Proof payment with code \"O-2017000017-01\" is not valid.","instance":"data.proofPaymentCodes"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1link-proof-payment/patch/responses/422/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1pdf/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invoice-not-found","message":"Invoice with code \"2018000004\" not found.","instance":"2018000004"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1pdf/get/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"document-not-generated","message":"Error while getting document type \"invoice\" with code\n\"2018000004\".","instance":"2018000004"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1isdoc/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invoice-not-found","message":"Invoice with code \"2018000004\" not found.","instance":"2018000004"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1isdoc/get/responses/404/content/application~1json/example"},"paths/~1api~1invoices~1{code}~1isdoc/get/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"document-not-generated","message":"Error while getting document type \"invoice\" with code\n\"2018000004\".","instance":"2018000004"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1invoices~1{code}~1isdoc/get/responses/500/content/application~1json/example"},"paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2018000012\" not found.","instance":"2018000012"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/404/content/application~1json/example"},"paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proforma-invoice-already-exists","message":"Proforma invoice code must be unique. Code 2018000046 already exist.","instance":"2018000046"},{"errorCode":"proforma-invoice-already-exists-for-order","message":"Proforma invoice already exists for order \"2018000065\" (proforma invoice code \"2018000039\"). Use \"suppressExistenceCheck\" parameter to create multiple proforma invoices for order.","instance":"2018000039"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/409/content/application~1json/example"},"paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unable to create proformaInvoice. Order 2018000083 is in the cancelled state.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api_orders_{code}_proforma-invoice.yaml/post/responses/422/content/application~1json/example"},"paths/~1api~1proforma-invoices~1snapshot/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"currency-not-found","message":"Currency code \\\"EUR\\\" not found.","instance":"currencyCode"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proforma-invoices~1snapshot/get/responses/404/content/application~1json/example"},"paths/~1api~1proforma-invoices~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proforma-invoice-not-found","message":"Proforma invoice with code \"000000000633\" not found.","instance":"000000000633"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proforma-invoices~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proforma-invoice-not-found","message":"Proforma invoice with code \"2018000035\" not found.","instance":"2018000035"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/404/content/application~1json/example"},"paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"document-not-generated","message":"Error while getting document type \"proformaInvoice\" with\ncode \"2018000035\".","instance":"2018000035"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proforma-invoices~1{code}~1pdf/get/responses/500/content/application~1json/example"},"paths/~1api~1proforma-invoices~1changes/get/responses/200/content/application~1json/example":{"value":{"data":{"changes":[{"changeType":"edit","changeTime":"2018-05-29T09:02:27+0200","code":"201800014"}],"paginator":{"totalCount":55,"page":1,"pageCount":3,"itemsOnPage":20,"itemsPerPage":20}},"errors":[{"errorCode":"example-error-code","message":"Example error message","instance":"instance"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proforma-invoices~1changes/get/responses/200/content/application~1json/example"},"paths/~1api~1proof-payments/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2015000001\" not found.","instance":"2015000001"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments/post/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unable to create proof payment with parent document \\\"order\\\" and code \\\"2018000081\\\". Parent document has 0 or negative price.","instance":"2018000081"},{"errorCode":"invalid-request-data","message":"Unable to create proof payment. Document with code \"2017000024\" is in invalid state.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments/post/responses/422/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-found","message":"Proof payment with code \"P--0000000000-1\" not found.","instance":"P--0000000000-1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-found","message":"Proof payment with code \"P--0000000000-1\" not found.","instance":"P--0000000000-1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}/patch/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Document closed":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-closed","message":"Proof payment with code \"P--0000000000-1\" is closed. Unlock\nproof payment first.","instance":"P--0000000000-1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"Document closed","summary":"Document closed","id":"paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Document closed"},"paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Record already changed":{"value":{"data":null,"errors":[{"errorCode":"record-already-changed","message":"Proof of payment has been changed before update.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"Record already changed","summary":"Record already changed","id":"paths/~1api~1proof-payments~1{code}/patch/responses/409/content/application~1json/examples/Record already changed"},"paths/~1api~1proof-payments~1{code}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-found","message":"Proof payment with code \"P--0000000000-1\" not found.","instance":"P--0000000000-1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}/delete/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-closed","message":"Proof payment with code \"P--0000000000-1\" is closed. Unlock\nproof payment first.","instance":"P--0000000000-1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}/delete/responses/409/content/application~1json/example"},"paths/~1api~1proof-payments~1order~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-found","message":"Proof payment with order code \"2015000001\" not found.","instance":"2015000001"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1order~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1order~1{code}/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2015000001\" not found.","instance":"2015000001"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1order~1{code}/post/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1order~1{code}/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unable to create proof payment with parent document \\\"order\\\" and code \\\"2018000081\\\". Parent document has 0 or negative price.","instance":"2018000081"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1order~1{code}/post/responses/422/content/application~1json/example"},"paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-found","message":"Proof payment with proforma invoice code \"2015000170\" not\nfound.","instance":"2015000170"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1proforma-invoice~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proforma-invoice-not-found","message":"Proforma invoice with code \"2015000170\" not found.","instance":"2015000001"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unable to create proof payment with parent document \\\"proformaInvoice\\\" and code \\\"2018000081\\\". Parent document has 0 or negative price.","instance":"2018000081"},{"errorCode":"invalid-request-data","message":"Unable to create proof payment. Document with code \"2017000024\" is in invalid state.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1proforma-invoice~1{code}/post/responses/422/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-found","message":"Proof payment with code \"P--0000000000-1\" not found.","instance":"P--0000000000-1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-unable-to-open","message":"Unable to open proof payment with code \"P--0000000000-1\".\nDocument is linked to invoice.","instance":"P--0000000000-1"},{"errorCode":"proof-payments-unable-to-close","message":"Unable to close proof payment with code \"P--0000000000-1\".\nDocument is not valid.","instance":"P--0000000000-1"},{"errorCode":"proof-payments-unable-to-close","message":"Unable to close proof payment with code \"P--0000000000-1\".\nDocument is linked to invoice.","instance":"P--0000000000-1"},{"errorCode":"proof-payments-unable-to-unlink","message":"Unable to unlink proof payment with code \"P--0000000000-1\".\nDocument is not linked to invoice.","instance":"P--0000000000-1"},{"errorCode":"invalid-request-data","message":"Unable to update proof payment with code \"P--0000000000-1\".\nAn exception occurred.","instance":"P--0000000000-1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}~1document-settings/post/responses/409/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}~1pdf/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-of-payment-not-found","message":"Proof payment with code \"P-2014000004-01\" does not exist.","instance":"P-2014000004-01"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}~1pdf/get/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"proof-payments-not-found","message":"Proof payment with code \"P-2015000248-01\" not found.","instance":"P-2015000248-01"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/404/content/application~1json/example"},"paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/500/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"document-not-generated","message":"Error while getting document type \"proofPayment\" with code\n\"P-2015000248-01\".","instance":"P-2015000248-01"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1{code}~1isdoc/get/responses/500/content/application~1json/example"},"paths/~1api~1proof-payments~1changes/get/responses/200/content/application~1json/example":{"value":{"data":{"changes":[{"changeType":"edit","changeTime":"2018-05-29T09:02:27+0200","code":"201800014"}],"paginator":{"totalCount":55,"page":1,"pageCount":3,"itemsOnPage":20,"itemsPerPage":20}},"errors":[{"errorCode":"example-error-code","message":"Example error message","instance":"instance"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1proof-payments~1changes/get/responses/200/content/application~1json/example"},"paths/~1api~1brands~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"brand-not-found","message":"Brand \"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005\" not found.","instance":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1brands~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1brands~1{code}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"brand-not-found","message":"Brand \"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005\" not found.","instance":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1brands~1{code}/patch/responses/404/content/application~1json/example"},"paths/~1api~1brands~1{code}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"brand-not-found","message":"Brand \"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005\" not found.","instance":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1brands~1{code}/delete/responses/404/content/application~1json/example"},"paths/~1api~1brands~1{code}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"brand-used-by-products","message":"Brand \"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005\" cannot be\ndeleted, because some products are assigned to it.","instance":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1brands~1{code}/delete/responses/409/content/application~1json/example"},"paths/~1api~1brands~1batch/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File \"https://jsonlines.org/brands.jsonl\" not found.","instance":"batchFileUrlPath"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1brands~1batch/post/responses/404/content/application~1json/example"},"paths/~1api~1brands~1batch/post/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"batch-job-already-running","message":"Concurrent job already running!","instance":"brands-batch-create"},{"errorCode":"another-import-is-running","message":"Another import is running. Please try again later.","instance":"brands-batch-create"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1brands~1batch/post/responses/409/content/application~1json/example"},"paths/~1api~1pricelists~1{id}/patch/responses/200/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"pricelist-code-not-found","message":"Price list code '43/BILL' doesn't exist. Code skipped.","instance":"43/BILL"},{"errorCode":"invalid-request-data","message":"Input data for code '43/BIL' doesn't correct. Code\nskipped.","instance":"43/BIL"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pricelists~1{id}/patch/responses/200/content/application~1json/example"},"paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/buy-price-and-purchase-price":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Input data for code \"0001\" is not correct. Cannot set \"price.buyPrice\" and \"prices.purchasePrice\" at the same time. Please use \"prices.purchasePrice\" only as buy price is deprecated. Code skipped.","instance":"0001"}]},"key":"buy-price-and-purchase-price","summary":"buy-price-and-purchase-price","id":"paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/buy-price-and-purchase-price"},"paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Input data for code \"0001\" is not correct. Invalid \"vatRate\" value. Code skipped.","instance":"0001"}]},"key":"invalid-vat-rate","summary":"invalid-vat-rate","id":"paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate"},"paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate-purchase-price":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Input data for code \"0001\" is not correct. Invalid \"purchasePriceVatRate\" value. Code skipped.","instance":"0001"}]},"key":"invalid-vat-rate-purchase-price","summary":"invalid-vat-rate-purchase-price","id":"paths/~1api~1pricelists~1{id}/patch/responses/400/content/application~1json/examples/invalid-vat-rate-purchase-price"},"paths/~1api~1pricelists~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"pricelist-not-found","message":"Pricelist with id \"11\" not found.","instance":"11"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pricelists~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1pricelists~1{id}/delete/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"It is not possible to delete default pricelist.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pricelists~1{id}/delete/responses/422/content/application~1json/example"},"paths/~1api~1pricelists~1{id}/delete/responses/423/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"pricelist-blocked","message":"Product import is running now. Removing pricelists has\nbeen temporarily prohibited.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pricelists~1{id}/delete/responses/423/content/application~1json/example"},"paths/~1api~1pricelists~1{id}~1batch/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File \"https://jsonlines.org/pricelists.jsonl\" not found.","instance":"batchFileUrlPath"}]},"id":"paths/~1api~1pricelists~1{id}~1batch/patch/responses/404/content/application~1json/example"},"paths/~1api~1pricelists~1{id}~1batch/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"batch-job-already-running","message":"Concurrent job already running!","instance":"pricelist-batch-update"},{"errorCode":"another-import-is-running","message":"Another import is running. Please try again later.","instance":"pricelist-batch-update"}]},"id":"paths/~1api~1pricelists~1{id}~1batch/patch/responses/409/content/application~1json/example"},"paths/~1api~1products/get/responses/400/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-parameter","message":"Invalid \"productCodes\" parameter. Expected max. 50 elements, but 55 given.","instance":"productCodes"},{"errorCode":"invalid-parameter","message":"Invalid \"productGuids\" parameter. Expected max. 50 elements, but 55 given.","instance":"productGuids"},{"errorCode":"invalid-parameter","message":"Invalid \"productCodes\" parameter. You can use \"productCodes\" or \"productGuids\", but not both.","instance":"productCodes"},{"errorCode":"missing-parameter","message":"Missing value for parameter \"productCodes\".","instance":"productCodes"},{"errorCode":"missing-parameter","message":"Missing value for parameter \"productGuids\".","instance":"productGuids"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products/get/responses/400/content/application~1json/example"},"paths/~1api~1products/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process request with consumptionTax include as \"consumptionTax\" module is not active.","instance":"consumptionTax"},{"errorCode":"missing-module","message":"Method requires active shoptetPay module in eshop when preauthorizationRequired field is present in product data.","instance":"shoptetPay"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products/post/responses/403/content/application~1json/example"},"paths/~1api~1products/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Maximum number of variants per product is 512.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products/post/responses/422/content/application~1json/example"},"paths/~1api~1products~1{guid}~1copy/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process request with perStockAmounts as \"stock\" module is not active.","instance":"stock"},{"errorCode":"missing-module","message":"Unable to process request with consumptionTax include as \"consumptionTax\" module is not active.","instance":"consumptionTax"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1copy/post/responses/403/content/application~1json/example"},"paths/~1api~1products~1{guid}~1copy/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-not-found","message":"Product with identificator \"93bc0dbe-7481-11e8-8216-002590dad85e\" not found.","instance":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1copy/post/responses/404/content/application~1json/example"},"paths/~1api~1products~1{guid}~1copy/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Stocks cannot be copied without pricelist. Property `pricelist` must be set to `true`.","instance":"stocks"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1copy/post/responses/422/content/application~1json/example"},"paths/~1api~1products~1snapshot/get/responses/400/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-parameter","message":"Invalid \"productCodes\" parameter. Expected max. 50 elements, but 55 given.","instance":"productCodes"},{"errorCode":"invalid-parameter","message":"Invalid \"productGuids\" parameter. Expected max. 50 elements, but 55 given.","instance":"productGuids"},{"errorCode":"invalid-parameter","message":"Invalid \"productCodes\" parameter. You can use \"productCodes\" or \"productGuids\", but not both.","instance":"productCodes"},{"errorCode":"missing-parameter","message":"Missing value for parameter \"productCodes\".","instance":"productCodes"},{"errorCode":"missing-parameter","message":"Missing value for parameter \"productGuids\".","instance":"productGuids"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1snapshot/get/responses/400/content/application~1json/example"},"paths/~1api~1products~1snapshot/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process request with consumptionTax include as \"consumptionTax\" module is not active.","instance":"consumptionTax"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1snapshot/get/responses/403/content/application~1json/example"},"paths/~1api~1products~1{guid}/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process request with consumptionTax include as \"consumptionTax\" module is not active.","instance":"consumptionTax"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}/get/responses/403/content/application~1json/example"},"paths/~1api~1products~1{guid}/patch/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process request with consumptionTax include as \"consumptionTax\" module is not active.","instance":"consumptionTax"},{"errorCode":"missing-module","message":"Method requires active shoptetPay module in eshop when preauthorizationRequired field is present in product data.","instance":"shoptetPay"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}/patch/responses/403/content/application~1json/example"},"paths/~1api~1products~1{guid}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Maximum number of variants per product is 512.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}/patch/responses/422/content/application~1json/example"},"paths/~1api~1products~1{guid}/patch/responses/423/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"concurrent-categories-update","message":"Categories of product \"4030\" are being updated concurrently\nby another request. Please retry this request.","instance":"4030"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}/patch/responses/423/content/application~1json/example"},"paths/~1api~1products~1{guid}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-not-found","message":"Product with identificator\n\"93bc0dbe-7481-11e8-8216-002590dad85e\" not found.","instance":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}/delete/responses/404/content/application~1json/example"},"paths/~1api~1products~1{guid}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-used-in-set","message":"Product with identificator\n\"93bc0dbe-7481-11e8-8216-002590dad85e\" cannot be deleted\nbecause is used in product set.","instance":"93bc0dbe-7481-11e8-8216-002590dad85e"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}/delete/responses/409/content/application~1json/example"},"paths/~1api~1products~1batch/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File \"https://jsonlines.org/products.jsonl\" not found.","instance":"batchFileUrlPath"}]},"id":"paths/~1api~1products~1batch/delete/responses/404/content/application~1json/example"},"paths/~1api~1products~1batch/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"batch-job-already-running","message":"Concurrent job already running!","instance":"products-batch-delete"},{"errorCode":"another-import-is-running","message":"Another import is running. Please try again later.","instance":"products-batch-delete"}]},"id":"paths/~1api~1products~1batch/delete/responses/409/content/application~1json/example"},"paths/~1api~1products~1batch/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File \"https://jsonlines.org/products.jsonl\" not found.","instance":"batchFileUrlPath"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1batch/patch/responses/404/content/application~1json/example"},"paths/~1api~1products~1batch/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"batch-job-already-running","message":"Concurrent job already running!","instance":"products-batch-update"},{"errorCode":"another-import-is-running","message":"Another import is running. Please try again later.","instance":"products-batch-update"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1batch/patch/responses/409/content/application~1json/example"},"paths/~1api~1products~1images~1batch/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File \"https://jsonlines.org/product-images.jsonl\" not found.","instance":"batchFileUrlPath"}]},"id":"paths/~1api~1products~1images~1batch/delete/responses/404/content/application~1json/example"},"paths/~1api~1products~1images~1batch/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"batch-job-already-running","message":"Concurrent job already running!","instance":"product-images-batch-delete"},{"errorCode":"another-import-is-running","message":"Another import is running. Please try again later.","instance":"product-images-batch-delete"}]},"id":"paths/~1api~1products~1images~1batch/delete/responses/409/content/application~1json/example"},"paths/~1api~1products~1code~1{code}/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process request with consumptionTax include as \"consumptionTax\" module is not active.","instance":"consumptionTax"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1code~1{code}/get/responses/403/content/application~1json/example"},"paths/~1api~1products~1code~1{code}/patch/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process request with consumptionTax include as \"consumptionTax\" module is not active.","instance":"consumptionTax"},{"errorCode":"missing-module","message":"Method requires active shoptetPay module in eshop when preauthorizationRequired field is present in product data.","instance":"shoptetPay"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1code~1{code}/patch/responses/403/content/application~1json/example"},"paths/~1api~1products~1code~1{code}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"The property consumptionTaxId is not allowed. Module \"consumptionTax\" required.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1code~1{code}/patch/responses/422/content/application~1json/example"},"paths/~1api~1products~1code~1{code}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-not-found","message":"Product with identificator \"133\" not found.","instance":"133"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1code~1{code}/delete/responses/404/content/application~1json/example"},"paths/~1api~1products~1code~1{code}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-used-in-set","message":"Product with identificator \"133\" cannot be deleted because\nis used in product set.","instance":"133"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1code~1{code}/delete/responses/409/content/application~1json/example"},"paths/~1api~1products~1{guid}~1related-files/delete/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process this request as \"relatedFiles\" module is not active.","instance":"relatedFiles"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1related-files/delete/responses/403/content/application~1json/example"},"paths/~1api~1products~1{guid}~1related-files/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-not-found","message":"Product \\\"fc8e4a2a-4c41-11e7-819d-002590dc5efc\\\" does not exist.","instance":"fc8e4a2a-4c41-11e7-819d-002590dc5efc"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1related-files/delete/responses/404/content/application~1json/example"},"paths/~1api~1products~1availabilities/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Google availability id \\\"2\\\" is not supported.","instance":"data.googleAvailabilityId"},{"errorCode":"invalid-request-data","message":"Product availability name \\\"In stock\\\" already exists.","instance":"data.name"},{"errorCode":"invalid-request-data","message":"Product availability index name \\\"in-stock\\\" already exists.","instance":"data.indexName"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1availabilities/post/responses/422/content/application~1json/example"},"paths/~1api~1products~1availabilities~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-availability-not-found","message":"Product availability with id \\\"100\\\" not found.","instance":"100"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1availabilities~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1products~1availabilities~1{id}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Google availability id \\\"2\\\" is not supported.","instance":"data.googleAvailabilityId"},{"errorCode":"invalid-request-data","message":"Product availability name \\\"In stock\\\" already exists.","instance":"data.name"},{"errorCode":"invalid-request-data","message":"Product availability index name \\\"in-stock\\\" already exists.","instance":"data.indexName"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1availabilities~1{id}/patch/responses/422/content/application~1json/example"},"paths/~1api~1products~1availabilities~1{id}/delete/responses/200/content/application~1json/example":{"value":{"data":null,"errors":null,"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1availabilities~1{id}/delete/responses/200/content/application~1json/example"},"paths/~1api~1products~1availabilities~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-availability-not-found","message":"Product availability with id \\\"100\\\" not found.","instance":"100"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1availabilities~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1products~1availabilities~1{id}/delete/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Unable to delete product availability with id \\\"1\\\". Availability is in use.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"Unable to delete product availability with id \\\"-1\\\". System availability is not deletable.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1availabilities~1{id}/delete/responses/422/content/application~1json/example"},"paths/~1api~1products~1{guid}~1images~1{gallery}/delete/responses/200/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"example-error-code","message":"Example error message","instance":"instance"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1images~1{gallery}/delete/responses/200/content/application~1json/example"},"paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process request as \"relatedFiles\" module is not active.","instance":"relatedFiles"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/403/content/application~1json/example"},"paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File with ID \"243\" not found.","instance":"id"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1related-files~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1products~1{guid}~1set/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-is-set-type","message":"Type of aggregate product is set. It is not possible to add another set into it.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1{guid}~1set/post/responses/422/content/application~1json/example"},"paths/~1api~1shipments/post/responses/422/content/application~1json; charset=utf-8/examples/example1":{"value":{"data":null,"errors":[{"errorCode":"shipment-validation-failed","message":"Bank account ID is required.","instance":"data.bankAccountId"},{"errorCode":"shipment-validation-failed","message":"Max value of COD is 100000.00.","instance":"data.cod"},{"errorCode":"shipment-validation-failed","message":"Invalid currency of order, allowed currencies: CZK.","instance":"data.orderCode"},{"errorCode":"shipment-validation-failed","message":"Invalid country of order, allowed countries: CZ.","instance":"data.orderCode"},{"errorCode":"shipment-validation-failed","message":"Invalid recipient of order, missing fields: phone, email,\nfullName, street, city, zip, country.","instance":"data.orderCode"},{"errorCode":"shipment-validation-failed","message":"Missing delivery point of order.","instance":"data.orderCode"},{"errorCode":"shipment-validation-failed","message":"Missing delivery country of order.","instance":"data.orderCode"},{"errorCode":"shipment-order-without-shipping","message":"Order does not include shipping.","instance":"payload"},{"errorCode":"shipment-address-not-exist","message":"Default address does not exist.","instance":"payload"},{"errorCode":"shipment-shipping-service-not-supported","message":"The selected shipping service does not support shipments.","instance":"payload"}]},"key":"example1","summary":"example1","id":"paths/~1api~1shipments/post/responses/422/content/application~1json; charset=utf-8/examples/example1"},"paths/~1api~1shipments~1{guid}/get/responses/404/content/application~1json; charset=utf-8/examples/example1":{"value":{"data":null,"errors":[{"errorCode":"shipment-not-found","message":"Shipment with guid \"93bc0dbe-7481-11e8-8216-002590dad85e\"\nnot found.","instance":"payload"}]},"key":"example1","summary":"example1","id":"paths/~1api~1shipments~1{guid}/get/responses/404/content/application~1json; charset=utf-8/examples/example1"},"paths/~1api~1shipments~1order~1{code}/post/responses/201/content/application~1json/example":{"value":{"data":{"guid":"1e3f3f32-3f3f-6766-3f3f-02423f1f0004"},"errors":[]},"id":"paths/~1api~1shipments~1order~1{code}/post/responses/201/content/application~1json/example"},"paths/~1api~1shipments~1order~1{code}/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2024000008\" not found.","instance":"2024000008"}]},"id":"paths/~1api~1shipments~1order~1{code}/post/responses/404/content/application~1json/example"},"paths/~1api~1shipments~1order~1{code}/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"shipment-order-without-shipping","message":"Order does not include shipping.","instance":"payload"},{"errorCode":"shipment-cannot-be-saved","message":"Shipment cannot be saved.","instance":"payload"},{"errorCode":"shipment-invalid-shipping","message":"Order contains invalid shipping.","instance":"payload"},{"errorCode":"shipment-bank-account-not-exist","message":"Shipper bank account not exist.","instance":"payload"},{"errorCode":"shipment-bank-account-not-exist","message":"Default shipper bank account does not exist.","instance":"payload"},{"errorCode":"shipment-address-not-exist","message":"Default address does not exist.","instance":"payload"},{"errorCode":"shipment-already-exists","message":"Shipment already exists.","instance":"payload"},{"errorCode":"shipment-validation-failed","message":"Invalid country of order, allowed countries: CZ.","instance":"data.orderCode"},{"errorCode":"shipment-validation-failed","message":"Missing delivery country of order.","instance":"data.orderCode"}]},"id":"paths/~1api~1shipments~1order~1{code}/post/responses/422/content/application~1json/example"},"paths/~1api~1customers~1{guid}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"customer-not-found","message":"Customer with guid \"157e7215-9035-11e4-a769-ac162d8a2454\"\nnot found.","instance":"157e7215-9035-11e4-a769-ac162d8a2454"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1customers~1{guid}/get/responses/404/content/application~1json/example"},"paths/~1api~1customers~1{guid}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"customer-address-limit-exceeded","message":"Maximum number of addresses for the customer has been exceeded.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1customers~1{guid}/patch/responses/422/content/application~1json/example"},"paths/~1api~1customers~1{guid}~1delivery-addresses/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"customer-address-limit-exceeded","message":"Maximum number of addresses for the customer has been exceeded.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1customers~1{guid}~1delivery-addresses/post/responses/422/content/application~1json/example"},"paths/~1api~1customers~1groups/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Wholesale features require active wholesale module in eshop.","instance":"wholesale"}]},"id":"paths/~1api~1customers~1groups/post/responses/403/content/application~1json/example"},"paths/~1api~1customers~1groups/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Customer group with name \"VIP\" already exists.","instance":"data.name"},{"errorCode":"invalid-request-data","message":"Pricelist with ID 999 does not exist.","instance":"data.defaultPricelistId"},{"errorCode":"invalid-request-data","message":"Authorization requirement can only be set when wholesale module is active.","instance":"data.authRequired"},{"errorCode":"invalid-request-data","message":"Email notification can only be enabled when wholesale module is active.","instance":"data.emailNotification"},{"errorCode":"invalid-request-data","message":"Invalid statusId \"999\".","instance":"data.defaultOrderStatusId"}]},"id":"paths/~1api~1customers~1groups/post/responses/422/content/application~1json/example"},"paths/~1api~1customers~1groups~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"customer-group-not-found","message":"Customer group with id \"999\" not found.","instance":"999"}]},"id":"paths/~1api~1customers~1groups~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1customers~1groups~1{id}/delete/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"customer-group-delete-blocked","message":"Cannot delete default customer group. Please mark other group as default before deleting.","instance":"payload"}]},"id":"paths/~1api~1customers~1groups~1{id}/delete/responses/422/content/application~1json/example"},"paths/~1api~1customers~1groups~1{id}/patch/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Wholesale features require active wholesale module in eshop.","instance":"wholesale"}]},"id":"paths/~1api~1customers~1groups~1{id}/patch/responses/403/content/application~1json/example"},"paths/~1api~1customers~1groups~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"customer-group-not-found","message":"Customer group with ID \"999\" not found.","instance":"999"}]},"id":"paths/~1api~1customers~1groups~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1customers~1groups~1{id}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Pricelist with ID 999 does not exist.","instance":"data.defaultPricelistId"},{"errorCode":"invalid-request-data","message":"Authorization requirement can only be set when wholesale module is active or for the default group.","instance":"data.authRequired"},{"errorCode":"invalid-request-data","message":"Email notification can only be enabled when wholesale module is active or for the default group.","instance":"data.emailNotification"},{"errorCode":"invalid-request-data","message":"Default customer group must be allowed for registration.","instance":"data.registrationAllowed"},{"errorCode":"invalid-request-data","message":"Invalid statusId \"999\".","instance":"data.defaultOrderStatusId"}]},"id":"paths/~1api~1customers~1groups~1{id}/patch/responses/422/content/application~1json/example"},"paths/~1api~1articles/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Invalid \"defaultSectionId\" value \"123456789\". Use articles/sections endpoint to get a list of possible values.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"The property defaultSectionId is required","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"File image123.jpg does not exist in temp upload storage.","instance":"data.sourceImageName"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1articles/post/responses/422/content/application~1json/example"},"paths/~1api~1articles~1{articleId}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Invalid \"defaultSectionId\" value \"123456789\". Use articles/sections endpoint to get a list of possible values.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"The property defaultSectionId is required","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"File image123.jpg does not exist in temp upload storage.","instance":"data.sourceImageName"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1articles~1{articleId}/patch/responses/422/content/application~1json/example"},"paths/~1api~1articles~1sections/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Parent section does not exist.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"The property title is required","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"The maximum nesting depth of article section exceeded","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1articles~1sections/post/responses/422/content/application~1json/example"},"paths/~1api~1articles~1sections~1{articleSectionId}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"article-section-not-found","message":"Article section with ID \"123\" not found.","instance":"123"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1articles~1sections~1{articleSectionId}/get/responses/404/content/application~1json/example"},"paths/~1api~1articles~1sections~1{articleSectionId}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"article-section-not-found","message":"Article section with ID \"123\" not found.","instance":"123"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1articles~1sections~1{articleSectionId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"article-section-not-found","message":"Article section with ID \"123\" not found.","instance":"123"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"article-section-contains-articles","message":"Article section \"683\" cannot be deleted, because it contains 4 article(s) that would be deleted.","instance":"683"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1articles~1sections~1{articleSectionId}/delete/responses/409/content/application~1json/example"},"paths/~1api~1discussions~1settings/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \"Discussion\" is not active.","instance":"discussion"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions~1settings/get/responses/403/content/application~1json/example"},"paths/~1api~1discussions-posts/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \"Discussion\" is not active.","instance":"discussion"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions-posts/get/responses/403/content/application~1json/example"},"paths/~1api~1discussions-posts/post/responses/400/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"One of productGuid, articleId, and pageId is required. Skipped.","instance":"data[0]"},{"errorCode":"invalid-request-data","message":"Only one of productGuid, articleId, and pageId is allowed. Skipped.","instance":"data[1]"},{"errorCode":"invalid-request-data","message":"Product \\\"c5112055-d7c0-11e0-9a5c-feab5ed617ed\\\" does not exist. Skipped.","instance":"data[0].productGuid"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions-posts/post/responses/400/content/application~1json/example"},"paths/~1api~1discussions-posts/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \"Discussion\" is not active.","instance":"discussion"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions-posts/post/responses/403/content/application~1json/example"},"paths/~1api~1discussions-posts/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"There must be a maximum of 100 items in the array","instance":"data"},{"errorCode":"invalid-request-data","message":"Must be at most 128 characters long.","instance":"data[0].name"},{"errorCode":"invalid-request-data","message":"Invalid email","instance":"data[0].email"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions-posts/post/responses/422/content/application~1json/example"},"paths/~1api~1discussions-posts~1{id}/patch/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \\\"Discussion\\\" is not active.","instance":"discussion"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions-posts~1{id}/patch/responses/403/content/application~1json/example"},"paths/~1api~1discussions-posts~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"discussion-post-not-found","message":"Discussion post with id \"999\" was not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions-posts~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1discussions-posts~1{id}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Must be at least 1 characters long","instance":"data.name"},{"errorCode":"invalid-request-data","message":"Must be at least 1 characters long","instance":"data.email"},{"errorCode":"invalid-request-data","message":"Invalid email","instance":"data.email"},{"errorCode":"invalid-request-data","message":"Must be no more than 100 characters long","instance":"data.email"},{"errorCode":"invalid-request-data","message":"Must be no more than 255 characters long","instance":"data.title"},{"errorCode":"invalid-request-data","message":"Must be at least 1 characters long","instance":"data.content"},{"errorCode":"invalid-request-data","message":"Does not match the regex pattern ^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0-5][0-9]:[0-5][0-9]\\+[0-9]{4}$","instance":"data.creationDate"},{"errorCode":"invalid-request-data","message":"String value found, but a boolean is required","instance":"data.authorized"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions-posts~1{id}/patch/responses/422/content/application~1json/example"},"paths/~1api~1discussions-posts~1{id}/delete/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \"Discussion\" is not active.","instance":"discussion"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discussions-posts~1{id}/delete/responses/403/content/application~1json/example"},"paths/~1api~1pages/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"The property title is required","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pages/post/responses/422/content/application~1json/example"},"paths/~1api~1pages~1{pageId}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"article-page-not-found","message":"Page with ID \"1\" not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pages~1{pageId}/get/responses/404/content/application~1json/example"},"paths/~1api~1pages~1{pageId}/delete/responses/200/content/application~1json/example":{"value":{"data":null,"errors":null,"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pages~1{pageId}/delete/responses/200/content/application~1json/example"},"paths/~1api~1pages~1{pageId}/delete/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"cannot-delete-page","message":"Page with ID \"404\" cannot be deleted!","instance":"404"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pages~1{pageId}/delete/responses/403/content/application~1json/example"},"paths/~1api~1pages~1{pageId}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"article-page-not-found","message":"Page with ID \"1\" not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1pages~1{pageId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1reviews~1settings/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Method requires active rating module in project.","instance":"rating"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1settings/get/responses/403/content/application~1json/example"},"paths/~1api~1reviews~1products/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Method requires active rating module in eshop.","instance":"rating"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1products/post/responses/403/content/application~1json/example"},"paths/~1api~1reviews~1products/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-not-found","message":"Product with guid \"92a9d61e-7481-11e8-8216-002590dad85e\" not found","instance":"1009d61e-7481-11e8-8216-002590dad5TG"},{"errorCode":"customer-not-found","message":"Customer with guid \"92a9d61e-7481-11e8-8216-002590dad85e\" not found","instance":"92a9d61e-7481-11e8-8216-002590dad85e"},{"errorCode":"order-not-found","message":"Order \"20202020\" not found.","instance":"20202020"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1products/post/responses/404/content/application~1json/example"},"paths/~1api~1reviews~1products/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"The property productGuid is required","instance":"data.productGuid"},{"errorCode":"invalid-request-data","message":"The property rate is required","instance":"data.rating"},{"errorCode":"invalid-request-data","message":"Invalid value number \"6\". Value must be from 1 to 5.","instance":"data.rating"},{"errorCode":"rating-already-voted","message":"You have already submitted a review from this IP address.","instance":"ipAddress"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1products/post/responses/422/content/application~1json/example"},"paths/~1api~1reviews~1products~1{reviewId}/patch/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Method requires active rating module in eshop.","instance":"rating"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1products~1{reviewId}/patch/responses/403/content/application~1json/example"},"paths/~1api~1reviews~1products~1{reviewId}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"product-review-not-found","message":"Product review with ID \"1\" not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1products~1{reviewId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1reviews~1project/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Method requires active rating module in project.","instance":"rating"},{"errorCode":"rating-not-enabled","message":"The project must have store ratings enabled. They are currently disabled.","instance":"settings"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1project/get/responses/403/content/application~1json/example"},"paths/~1api~1reviews~1project/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Method requires active rating module in project.","instance":"rating"},{"errorCode":"rating-not-enabled","message":"The project must have store ratings enabled. They are currently disabled.","instance":"settings"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1project/post/responses/403/content/application~1json/example"},"paths/~1api~1reviews~1project/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"customer-not-found","message":"Customer with guid \"92a9d61e-7481-11e8-8216-002590dad85e\" not found","instance":"92a9d61e-7481-11e8-8216-002590dad85e"},{"errorCode":"order-not-found","message":"Order \"20202020\" not found.","instance":"20202020"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1project/post/responses/404/content/application~1json/example"},"paths/~1api~1reviews~1project/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"The property rate is required","instance":"data.rating"},{"errorCode":"invalid-request-data","message":"Invalid value number \"6\". Value must be from 1 to 5.","instance":"data.rating"},{"errorCode":"rating-already-voted","message":"You have already submitted a review from this IP address.","instance":"ipAddress"},{"errorCode":"rating-advanced-fullname-comment-required","message":"The store rating must include fullName and description when option \"Comments required\" is enabled.","instance":"settings"},{"errorCode":"order-customer-mismatch","message":"Order with code \"2018000073\" is not related to the customer with guid \"747fb32d-73bc-11e8-8216-002590dad85e\"","instance":"orderCode, customerGuid"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1project/post/responses/422/content/application~1json/example"},"paths/~1api~1reviews~1project~1{reviewId}/patch/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Method requires active rating module in project.","instance":"rating"},{"errorCode":"rating-not-enabled","message":"The project must have store ratings enabled. They are currently disabled.","instance":"settings"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1project~1{reviewId}/patch/responses/403/content/application~1json/example"},"paths/~1api~1reviews~1project~1{reviewId}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"project-review-not-found","message":"Project review with ID \"1\" not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1reviews~1project~1{reviewId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1template-include/post/responses/400/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"template-include-location-invalid","message":"Invalid location code: does-not-exist. Possible values:\ncommon-header, common-footer, order-confirmed","instance":"location"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1template-include/post/responses/400/content/application~1json/example"},"paths/~1api~1discount-coupons/patch/responses/200/content/application~1json/examples/duplicateCode":{"value":{"data":{"coupons":[{"code":"DISCOUNT10","amount":"100.00","minPrice":null,"creationTime":"2024-01-15T10:00:00+0100","validFrom":null,"validTo":null,"ratio":null,"template":"01b39ad8-8686-11e9-968c-08002774f818","currency":"CZK","reusable":true,"usedCount":0,"remark":null,"discountType":"fixed","shippingPrice":"cart"}]},"errors":[{"errorCode":"discount-coupon-code-duplicated","message":"Discount coupon code \"DISCOUNT10\" is duplicated.","instance":"data.coupons[1].code"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"duplicateCode","summary":"duplicateCode","id":"paths/~1api~1discount-coupons/patch/responses/200/content/application~1json/examples/duplicateCode"},"paths/~1api~1discount-coupons/patch/responses/403/content/application~1json/examples/missingModule":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Method requires active discountCoupons module in eshop.","instance":"discountCoupons"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"missingModule","summary":"missingModule","id":"paths/~1api~1discount-coupons/patch/responses/403/content/application~1json/examples/missingModule"},"paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/couponNotFound":{"value":{"data":{"coupons":[]},"errors":[{"errorCode":"discount-coupon-not-found","message":"Discount coupon with code \"UNKNOWN\" was not found.","instance":"data.coupons[0].code"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"couponNotFound","summary":"couponNotFound","id":"paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/couponNotFound"},"paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/validationErrors":{"value":{"data":{"coupons":[]},"errors":[{"errorCode":"invalid-request-data","message":"For \"percentual\" discount type you cannot provide \"amount\" property","instance":"data.coupons[0].amount"},{"errorCode":"invalid-request-data","message":"For \"fixed\" discount type you cannot provide \"ratio\" property","instance":"data.coupons[1].ratio"},{"errorCode":"invalid-request-data","message":"Field \"ratio\" is required when \"discountType\" is \"percentual\".","instance":"data.coupons[2].ratio"},{"errorCode":"invalid-request-data","message":"Field \"amount\" is required when \"discountType\" is \"fixed\".","instance":"data.coupons[3].amount"},{"errorCode":"invalid-request-data","message":"Missing \"currency\" field. It is required when price is specified in body.","instance":"data.coupons[4].currency"},{"errorCode":"invalid-request-data","message":"Field \"discountType\" is required when \"currency\" is provided without \"minPrice\".","instance":"data.coupons[5].discountType"},{"errorCode":"invalid-request-data","message":"Invalid value number \"0.00\" for property \"amount\". Value must be higher than zero.","instance":"data.coupons[6].amount"},{"errorCode":"invalid-request-data","message":"No fields to update were provided.","instance":"data.coupons[7]"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"validationErrors","summary":"validationErrors","id":"paths/~1api~1discount-coupons/patch/responses/422/content/application~1json/examples/validationErrors"},"paths/~1api~1discount-coupons/delete/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"discount-coupon-not-found","message":"Unable to delete discount coupon.","instance":"some-coupon-code"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discount-coupons/delete/responses/422/content/application~1json/example"},"paths/~1api~1discount-coupons~1{code}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"discount-coupon-not-found","message":"Discount coupon with code \"AB12345\" was not found.","instance":"AB12345"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discount-coupons~1{code}/get/responses/404/content/application~1json/example"},"paths/~1api~1discount-coupons~1{code}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"discount-coupon-not-found","message":"Discount coupon with code \"AB12345\" was not found.","instance":"AB12345"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discount-coupons~1{code}/delete/responses/404/content/application~1json/example"},"paths/~1api~1discount-coupons~1use~1{code}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"order-not-found","message":"Order \"2015000010\" was not found.","instance":"2015000010"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discount-coupons~1use~1{code}/patch/responses/404/content/application~1json/example"},"paths/~1api~1discount-coupons~1use~1{code}/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"discount-coupon-already-used","message":"Discount coupon with code \"ABCDEF12\" was already used.","instance":"ABCDEF12"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discount-coupons~1use~1{code}/patch/responses/409/content/application~1json/example"},"paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/tooManyProducts":{"value":{"data":null,"errors":[{"errorCode":"validation-error","message":"Maximum number of products per coupon template is 1000.","instance":""}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"tooManyProducts","summary":"Too many products","id":"paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/tooManyProducts"},"paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/productNotFound":{"value":{"data":null,"errors":[{"errorCode":"validation-error","message":"Product(s) \"bffa3b98-d968-11e0-b04f-57a43310b768\" not found.","instance":""}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"key":"productNotFound","summary":"Product not found","id":"paths/~1api~1discount-coupons~1templates/post/responses/400/content/application~1json/examples/productNotFound"},"paths/~1api~1discount-coupons~1templates~1{guid}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"discount-coupon-template-not-found","message":"Discount coupon template\n\"bffa3b98-d968-11e0-b04f-57a43310b768\" was not found.","instance":"bffa3b98-d968-11e0-b04f-57a43310b768"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discount-coupons~1templates~1{guid}/get/responses/404/content/application~1json/example"},"paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"discount-coupon-template-not-found","message":"Discount coupon template\n\"bffa3b98-d968-11e0-b04f-57a43310b768\" was not found.","instance":"bffa3b98-d968-11e0-b04f-57a43310b768"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/404/content/application~1json/example"},"paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"discount-coupon-template-used","message":"Discount coupon template\n\"bffa3b98-d968-11e0-b04f-57a43310b768\" cannot be deleted\nbecause it is used.","instance":"bffa3b98-d968-11e0-b04f-57a43310b768"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1discount-coupons~1templates~1{guid}/delete/responses/409/content/application~1json/example"},"paths/~1api~1quantity-discounts/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Quantity discount with ID \"1\" not found.","instance":"data.sortAfter"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1quantity-discounts/post/responses/404/content/application~1json/example"},"paths/~1api~1quantity-discounts~1{id}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"quantity-discount-not-found","message":"Quantity discount with ID \"1\" not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1quantity-discounts~1{id}/get/responses/404/content/application~1json/example"},"paths/~1api~1quantity-discounts~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"quantity-discount-not-found","message":"Quantity discount with ID \"1\" not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1quantity-discounts~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1quantity-discounts~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"quantity-discount-not-found","message":"Quantity discount with ID \"1\" not found.","instance":"1"},{"errorCode":"quantity-discount-deletion-failed","message":"Cannot delete quantity discount with id \"1\".","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1quantity-discounts~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1xy-discounts~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"xy-discount-not-found","message":"X + Y discount with ID \"1\" not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1xy-discounts~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1xy-discounts~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"xy-discount-not-found","message":"X + Y discount with ID \"1\" not found.","instance":"1"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1xy-discounts~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1xy-discounts~1settings/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Does not have a value in the enumeration\n[\"all-categories\",\"primary-category\",null]","instance":"data.categoryTargeting"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1xy-discounts~1settings/patch/responses/422/content/application~1json/example"},"paths/~1api~1categories~1{categoryGuid}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"category-not-found","message":"Category with identificator\n\"5c499200-70ac-11e9-9208-08002774f818\" not found.","instance":"5c499200-70ac-11e9-9208-08002774f818"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"},"paths/~1api~1categories~1{categoryGuid}/delete/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"category-used-by-products","message":"Category \"5c499200-70ac-11e9-9208-08002774f818\" cannot\nbe deleted, because some products are assigned to it.","instance":"5c499200-70ac-11e9-9208-08002774f818"},{"errorCode":"category-has-children","message":"Category \"5c499200-70ac-11e9-9208-08002774f818\" cannot\nbe deleted, because it is a parent category.","instance":"5c499200-70ac-11e9-9208-08002774f818"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1categories~1{categoryGuid}/delete/responses/409/content/application~1json/example"},"paths/~1api~1categories~1batch/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File \"https://jsonlines.org/categories.jsonl\" not found.","instance":"batchFileUrlPath"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1categories~1batch/patch/responses/404/content/application~1json/example"},"paths/~1api~1categories~1batch/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"batch-job-already-running","message":"Concurrent job already running!","instance":"categories-batch-update"},{"errorCode":"another-import-is-running","message":"Another import is running. Please try again later.","instance":"categories-batch-update"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1categories~1batch/patch/responses/409/content/application~1json/example"},"paths/~1api~1categories~1products-priority~1batch/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File \"https://jsonlines.org/category-product-priority.jsonl\" not found.","instance":"batchFileUrlPath"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1categories~1products-priority~1batch/patch/responses/404/content/application~1json/example"},"paths/~1api~1categories~1products-priority~1batch/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"batch-job-already-running","message":"Concurrent job already running!","instance":"categories-batch-update"},{"errorCode":"another-import-is-running","message":"Another import is running. Please try again later.","instance":"categories-batch-update"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1categories~1products-priority~1batch/patch/responses/409/content/application~1json/example"},"paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/responses/400/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"unknown-product","message":"Product \"19ee3c7c-92c7-11e9-9373-08002774f818\" does not\nexist. Skipped.","instance":"19ee3c7c-92c7-11e9-9373-08002774f818"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1categories~1{categoryGuid}~1productsPriority/patch/responses/400/content/application~1json/example"},"paths/~1api~1parametric-categories/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process this request as \"advancedSeo\" module is not active.","instance":"advancedSeo"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories/get/responses/403/content/application~1json/example"},"paths/~1api~1parametric-categories/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process this request as \"advancedSeo\" module is not active.","instance":"advancedSeo"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories/post/responses/403/content/application~1json/example"},"paths/~1api~1parametric-categories/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Category with given \\\"11f7d2f4-4c42-11e7-819d-002590dc5efc\\\" does not exist.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"No parametric category definition exists for this combination of parameterCodes. Create a definition first using the /parametric-categories-definition endpoint.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"Parametric category with the same combination of valueCodes already exists.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"One or more valueCodes does not exist for the specified parameters.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"File image.png does not exist in temp upload storage.","instance":"data.sourceImageName"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories/post/responses/422/content/application~1json/example"},"paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process this request as \"advancedSeo\" module is not active.","instance":"advancedSeo"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/403/content/application~1json/example"},"paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"parametric-category-not-found","message":"Parametric category \"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005\" was not found.","instance":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories~1{categoryGuid}/get/responses/404/content/application~1json/example"},"paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process this request as \"advancedSeo\" module is not active.","instance":"advancedSeo"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/403/content/application~1json/example"},"paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"parametric-category-not-found","message":"Parametric category \"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005\" was not found.","instance":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories~1{categoryGuid}/patch/responses/404/content/application~1json/example"},"paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process this request as \"advancedSeo\" module is not active.","instance":"advancedSeo"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/403/content/application~1json/example"},"paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"parametric-category-not-found","message":"Parametric category \"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005\" was not found.","instance":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories~1{categoryGuid}/delete/responses/404/content/application~1json/example"},"paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process this request as \"advancedSeo\" module is not active.","instance":"advancedSeo"}]},"id":"paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/403/content/application~1json/example"},"paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"category-not-found","message":"Category with guid \"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005\" not found.","instance":"1e3f3f3f-3f3f-63ca-b93f-02423f1f0005"}]},"id":"paths/~1api~1parametric-categories-available-parameters~1{categoryGuid}/get/responses/404/content/application~1json/example"},"paths/~1api~1parametric-categories-definition/post/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Unable to process this request as \"advancedSeo\" module is not active.","instance":"advancedSeo"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories-definition/post/responses/403/content/application~1json/example"},"paths/~1api~1parametric-categories-definition/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Category with given guid \"11f7d2f4-4c42-11e7-819d-002590dc5efc\" does not exist.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"Parameter with code \"neexistujici-parametr\" does not exist.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"Parametric category definition with the same set of parameters already exists for this category.","instance":"integration-call"},{"errorCode":"invalid-request-data","message":"Duplicate parameterCodes are not allowed.","instance":"integration-call"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1parametric-categories-definition/post/responses/422/content/application~1json/example"},"paths/~1api~1products~1consumption-taxes/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Method requires active consumptionTax module in eshop.","instance":"consumptionTax"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1consumption-taxes/get/responses/403/content/application~1json/example"},"paths/~1api~1products~1consumption-taxes/post/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"consumption-tax-already-exists","message":"Consumption tax \"ABC\" with price \"50.00\" and currency \"EUR\" already exists.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1consumption-taxes/post/responses/409/content/application~1json/example"},"paths/~1api~1products~1consumption-taxes/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Currency \"CZE\" not found.","instance":"currency"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1consumption-taxes/post/responses/422/content/application~1json/example"},"paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"consumption-tax-not-found","message":"Consumption tax with ID \"8\" not found.","instance":"8"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/409/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"consumption-tax-already-exists","message":"Consumption tax \"ABC\" with price \"50.00\" and currency \"EUR\" already exists.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/409/content/application~1json/example"},"paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Currency \"CZE\" not found.","instance":"currency"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1consumption-taxes~1{id}/patch/responses/422/content/application~1json/example"},"paths/~1api~1products~1consumption-taxes~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"consumption-tax-not-found","message":"Consumption tax with ID \"8\" not found.","instance":"8"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1products~1consumption-taxes~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1payment-methods/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \"Sales channel\" is not active.","instance":"salesChannel"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1payment-methods/get/responses/403/content/application~1json/example"},"paths/~1api~1payment-methods/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"sales-channel-not-found","message":"Sales channel with GUID \"0199bdfd-0979-71fb-85ce-e483c61d391b\" not found.","instance":"salesChannelGuid"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1payment-methods/get/responses/404/content/application~1json/example"},"paths/~1api~1payment-methods/get/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"sales-channel-guid-invalid","message":"Sales channel GUID \\\"invalid\\\" is not valid.","instance":"salesChannelGuid"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1payment-methods/get/responses/422/content/application~1json/example"},"paths/~1api~1shipping-methods/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \"Sales channel\" is not active.","instance":"salesChannel"}]},"id":"paths/~1api~1shipping-methods/get/responses/403/content/application~1json/example"},"paths/~1api~1shipping-methods/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"sales-channel-not-found","message":"Sales channel with GUID \"0199bdfd-0979-71fb-85ce-e483c61d391b\" not found.","instance":"salesChannelGuid"}]},"id":"paths/~1api~1shipping-methods/get/responses/404/content/application~1json/example"},"paths/~1api~1shipping-methods/get/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"sales-channel-guid-invalid","message":"Sales channel GUID \\\"invalid\\\" is not valid.","instance":"salesChannelGuid"}]},"id":"paths/~1api~1shipping-methods/get/responses/422/content/application~1json/example"},"paths/~1api~1shipping-methods~1{guid}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"shipping-method-not-found","message":"Shipping method with GUID \"b57f91bb-e920-11e0-baa3-7dc668b75ca8\" not found.","instance":"b57f91bb-e920-11e0-baa3-7dc668b75ca8"}]},"id":"paths/~1api~1shipping-methods~1{guid}/get/responses/404/content/application~1json/example"},"paths/~1api~1stocks~1{stockId}~1movements/patch/responses/200/content/application~1json/example":{"value":{"errors":[{"errorCode":"unknown-product","message":"Product \"001-non-exists\" does not exist. Skipped.","instance":"001-non-exist"},{"errorCode":"unknown-product","message":"Product \"002-non-exists\" does not exist. Skipped.","instance":"002-non-exist"}]},"id":"paths/~1api~1stocks~1{stockId}~1movements/patch/responses/200/content/application~1json/example"},"paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example1":{"value":{"data":null,"errors":[{"errorCode":"unknown-product","message":"Product \"82\" does not exist. Skipped.","instance":"82"}]},"key":"example1","summary":"example1","id":"paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example1"},"paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example2":{"value":{"data":null,"errors":[{"errorCode":"stock-change-not-allowed","message":"Stock change not allowed for product set \"82\".\nSkipped.","instance":"82"}]},"key":"example2","summary":"example2","id":"paths/~1api~1stocks~1{stockId}~1movements/patch/responses/400/content/application~1json/examples/example2"},"paths/~1api~1sales-channels~1{guid}/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \"Sales channel\" is not active.","instance":"salesChannel"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1sales-channels~1{guid}/get/responses/403/content/application~1json/example"},"paths/~1api~1sales-channels~1{guid}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"sales-channel-not-found","message":"Sales channel with guid \"0199bdfd-0979-71fb-85ce-e483c61d391a\" not found.","instance":"0199bdfd-0979-71fb-85ce-e483c61d391a"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1sales-channels~1{guid}/get/responses/404/content/application~1json/example"},"paths/~1api~1sales-channels~1id~1{id}/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"missing-module","message":"Module \"Sales channel\" is not active.","instance":"salesChannel"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1sales-channels~1id~1{id}/get/responses/403/content/application~1json/example"},"paths/~1api~1sales-channels~1id~1{id}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"sales-channel-not-found","message":"Sales channel with id \"2\" not found.","instance":"2"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1sales-channels~1id~1{id}/get/responses/404/content/application~1json/example"},"paths/~1api~1system~1file/post/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"file-not-found","message":"File with URL \"https://example.com/image.png\" not found.","instance":"https://example.com/image.png"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1system~1file/post/responses/404/content/application~1json/example"},"paths/~1api~1system~1file/post/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Does not match the regex pattern ^[0-9a-zA-Z\\\\-.]+$","instance":"data.name"},{"errorCode":"file-upload-error","message":"File upload failed.","instance":"payload"},{"errorCode":"file-upload-size-limit","message":"Uploaded file size limit exceeded. Limit is 2 MB.","instance":"payload"},{"errorCode":"file-upload-invalid-type","message":"Unsupported filetype.","instance":"payload"},{"errorCode":"file-upload-invalid-chars","message":"Filename contains invalid characters or extension is missing.","instance":"payload"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1system~1file/post/responses/422/content/application~1json/example"},"paths/~1api~1system~1jobs~1{jobId}/get/responses/403/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"job-detail-try-counter-exceeded-limit","message":"You have exceeded the limit of job detail request for\nunprocessed job \"1xv8s4c\". Please wait for job:finished\nevent after job is completed!","instance":"1xv8s4c"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1system~1jobs~1{jobId}/get/responses/403/content/application~1json/example"},"paths/~1api~1system~1jobs~1{jobId}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"job-not-found","message":"Job with ID \"1xv8s4c\" not found.","instance":"1xv8s4c"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1system~1jobs~1{jobId}/get/responses/404/content/application~1json/example"},"paths/~1api~1payment-status~1{paymentCode}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"payment-not-found","message":"The payment code \"nonExists\" not found.","instance":"paymentCode"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1payment-status~1{paymentCode}/patch/responses/404/content/application~1json/example"},"paths/~1api~1payment-status~1{paymentCode}/patch/responses/422/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"invalid-request-data","message":"Does not have a value in the enumeration\n[\"FAILED\",\"OK\",\"PENDING\"]","instance":"data.status"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1payment-status~1{paymentCode}/patch/responses/422/content/application~1json/example"},"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"shipping-request-not-found","message":"Unknown shippingGuid\n\"97a4b2da-6f2e-11e4-877e-ac162d8a2455\" or\nshippingRequestCode \"5ee3b74071f72c460757155cb0ae0aaa\".","instance":"shippingGuid, shippingRequestCode"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/404/content/application~1json/example"},"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/408/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"cart-data-missing","message":"Cart data of \"10c50b2f9dde1e9b1050623586547d9f\" from CMS\nis missing","instance":"shippingRequest"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/get/responses/408/content/application~1json/example"},"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"shipping-request-not-found","message":"Unknown shippingGuid\n\"97a4b2da-6f2e-11e4-877e-ac162d8a2455\" or\nshippingRequestCode \"5ee3b74071f72c460757155cb0ae0aaa\".","instance":"shippingGuid, shippingRequestCode"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/404/content/application~1json/example"},"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/408/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"cart-data-missing","message":"Cart data of \"10c50b2f9dde1e9b1050623586547d9f\" from CMS\nis missing","instance":"shippingRequest"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}/put/responses/408/content/application~1json/example"},"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/200/content/application~1json/example":{"value":{"data":{"status":"open","orderCode":"20200010"},"errors":null,"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/200/content/application~1json/example"},"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"shipping-request-not-found","message":"Unknown shippingGuid\n\"97a4b2da-6f2e-11e4-877e-ac162d8a2455\" or\nshippingRequestCode \"5ee3b74071f72c460757155cb0ae0aaa\".","instance":"shippingGuid, shippingRequestCode"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1shipping-request~1{shippingRequestCode}~1{shippingGuid}~1status/get/responses/404/content/application~1json/example"},"paths/~1api~1webhooks~1{id}/get/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"webhook-not-found","message":"Webhook with id \"999\" not found.","instance":"999"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1webhooks~1{id}/get/responses/404/content/application~1json/example"},"paths/~1api~1webhooks~1{id}/patch/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"webhook-not-found","message":"Webhook with id \"999\" not found.","instance":"999"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1webhooks~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1webhooks~1{id}/delete/responses/404/content/application~1json/example":{"value":{"data":null,"errors":[{"errorCode":"webhook-not-found","message":"Webhook with id \"999\" not found.","instance":"999"}],"metadata":{"requestId":"019c8c34-64f3-7328-af43-bf1e34fa39d7"}},"id":"paths/~1api~1webhooks~1{id}/delete/responses/404/content/application~1json/example"}},"securitySchemeStore":{"shoptetAccessToken":{"id":"shoptetAccessToken","type":"apiKey","in":"header","paramName":"Shoptet-Access-Token"},"shoptetPrivateApiToken":{"id":"shoptetPrivateApiToken","type":"apiKey","in":"header","paramName":"Shoptet-Private-Api-Token"}},"servers":[{"url":"/_mock/shoptet-api/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.myshoptet.com"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/shoptet-api/openapi","position":"first","description":"Mock server","off":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/Shoptet API/openapi.json?download"},{"url":"/_bundle/Shoptet API/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Shoptet API","description":"Created in cooperation with the Ministry of Industry and Trade of the Czech\nRepublic within the \"The Country for the Future\" programme.\n\n\n\n\nThis documentation provides information about the interface for developers\nwho would like to gain access to Shoptet\n\ne-shops. For more information about Shoptet, see https://www.shoptet.cz/.\n\n\nThe API is available in two access modes:\n\n\n- for \"Shoptet partner” developers who create the interconnection with the\nservices and extend the Shoptet system's\n functions for public usage. For more information about API and conditions, under which\n it can be used, see https://developers.shoptet.com/addons/.\n\n- direct private access to eshop data for eshop owner - available only for\n[Premium Members](https://www.shoptetpremium.cz/).\n See https://developers.shoptet.com/premium for more information about API access.\n\n# Basic principles\n\n\n## How to call API\n\n\nAPI supports communication in JSON format. The URL for calling API requests\nis https://api.myshoptet.com. The API calls\n\n(endpoints and message formats) are common for private as well as addons\naccess, it however uses different authentication\n\nand authorization principles.\n\n\n### For Addons\n\n\nAPI is made to create the supplements for the Shoptet system and uses OAuth2\nauthorization principles.\n\nTo access the API it is necessary to implement a web service at your side,\nwhich will communicate with our OAuth server.\n\n\nIn your e-shop administration, which you are using to work with our API, you\nmust search in the `API Partner` section for the `Access to API` tab.\n\nHere, you will find your clientID and addresses, from where you can call our\nOAuth server.\n\n\nThe work with API begins with e-shop addon installation. (The installation\nprocess can be tested in the addon detail in the `Users` section, where you\ncan cause the installation for your e-shop.)\n\nIn your addon detail, in the `Settings` section, enter URL to gain a OAuth\ncode. The URL must be linked to your server, where the script is prepared,\nwhich is able to gain an OAuth access token.\n\nAt this address, you will receive the HTTP request with a GET parameter\n`code`, when installing the addon, with unique value (a 255 character long\nstring).\n\nThe `code` provided only has short-term validity and can be used only once.\nWith this code, request our OAuth server to provide an `OAuth access token`.\n\nSuch a request shall follow within the same script that received the `code`.\n\nDo not put off gaining the OAuth access token for a later time, and do not\nreply to our request with a `200 OK` status, until you gain the OAuth access\ntoken.\n\nThe address for you to call, and an example of implementation, can be found\nin e-shop administration in the `Access to API` section.\n\n\nAs a response you will obtain a JSON with your OAuth access token. Save this\ntoken securely. Never send this token to the client computer, and use it\nonly\n\nfor communication between the servers and for gaining the temporary token\nfor access to API.\n\n\nIf you have successfully received an OAuth access token, your script must\nend with the HTTP status code “200”.\n\n\nNow you have your OAuth access token, which links your addon with a specific\ne-shop, perhaps you would like to communicate with the e-shop via API.\n\n\nFrom your server, call\n`https:///action/ApiOAuthServer/getAccessToken` address\nwith HTTP header `Authorization: Bearer `.\n\nAs the reply, you will receive a JSON containing an API access token value\nand the token expiration time value. An example of calling can be found in\ne-shop administration in the `Access to API` section.\n\nIt is possible to request a maximum of 5 valid tokens.\n\n\nThe API access token will enable you to call an individual URL of our API,\nfor example `https://api.myshoptet.com/api/eshop`. Send the API access token\nin each request in the HTTP header`Shoptet-Access-Token`.\n\nYou can have several valid API access tokens available at any one time.\nShould the validity of the API access token expire, you will receive a HTTP\nstatus code 401 and message about token expiration.\n\n\n```\n\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"expired-token\",\n \"message\": \"Token is expired. Please ask for new one.\",\n \"instance\": \"unknown\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n```\n\n\nIf your token does not have the access right for a specific endpoint, you\nwill obtain a reply with HTTP status code 403 Forbidden.\n\n\n```\n\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"invalid-token-no-rights\",\n \"message\": \"Your access token \\\"afd..123\\\" has no defined rights for this resource.\",\n \"instance\": \"access-token\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n```\n\n\n### For private API access (Premium)\n\n\nYou can create API access tokens simply in the eshop administration. Send\nthem in the request header `Shoptet-Private-API-Token`.\n\nPrivate API tokens use **endpoint group rights** to control access. Each\ntoken is assigned one or more endpoint groups, and each group grants either\nread, write, or read+write access to the endpoints it contains.\n\nWhen new token is created, all available endpoint groups are granted\nautomatically, so the token can access all API endpoints out of the box.\nAccess can be restricted by removing individual endpoint groups in the\neshop administration under `Access to API`.\n\nIf the token does not have the required right for an endpoint, you will\nreceive a HTTP status code 403 Forbidden with the error code\n`invalid-token-no-rights`.\n\n\n## Rate limiting\n\n\nRate limiting is at the level of server overload protection (DDoS), whereas the quantity of queries or total volume of data are unlimited.\n\nThese are therefore the limits of the maximum number of coincident active connections. A maximum of 50 from a single IP address, and a maximum of 3 connections for a single token. If the limit is exceeded, the HTTP code 429 is returned. See also Nginx configuration:\n\n\n```\nlimit_conn per_ip 50;\nlimit_conn per_token 3;\nlimit_conn_status 429;\n```\n\n\nSome URLs, for example for bulk operations, can have their own specific limits, which are mentioned in this documentation.\n\n### Leaky bucket\nWe have also prepared more detailed rules for checking the efficiency of calling your integrations using a leaky bucket algorithm.\n\nWe inform you about reaching the limits via headers `X-RateLimit-Bucket-Filling` (in every response), and `Retry-After` (only if bucket is fulfilled), e.g.\n\n```\nX-RateLimit-Bucket-Filling: 200/200\nRetry-After: Mon, 01 Jul 2024 12:01:11 GMT\n```\n\n\nFor more information, visit [API Rate limiter](https://developers.shoptet.com/api/documentation/rate-limiter/).\n\n## Locks\n\n\nWrite endpoints (DELETE, PATCH, POST, PUT methods) can take longer and may\nbe prone to two concurrent matching requests.\n\nTo avoid problems with retrying identical write requests, we have added the\nlocking function of these requests to the application.\n\nIf you execute the same request two times in quick succession, the second\nrequest receives error response with a 423 code.\n\nThe lock is only valid for a specific called URL, for the duration of the\nrequest processing, but no longer than 5 seconds.\n\n\n## Server response format\n\n\nAll JSON responses from the server have the same format, as a base.\n\nIf any of the sections is not present in the response, a `null` value is\nthen received.\n\n\nExample of call for addons:\n\n\n```\n\ncurl --include \\\n -H 'Shoptet-Access-Token: 123456-a-123-XXXXXXXXXXXXXXXXXXXXXXXXX' \\\n -H 'Content-Type: application/json' \\\n 'https://api.myshoptet.com/api/eshop'\n```\n\n\nExample of call for private API access:\n\n\n```\n\ncurl --include \\\n -H 'Shoptet-Private-API-Token: 123456-a-123-XXXXXXXXXXXXXXXXXXXXXXXXX' \\\n -H 'Content-Type: application/json' \\\n 'https://api.myshoptet.com/api/eshop'\n```\n\n\nExample of response:\n\n\n```\n\nHTTP/2 200\n\ndate: Fri, 13 Jul 2018 15:57:29 GMT\n\ncontent-type: application/json; charset=utf-8\n\n\n{\n \"data\": {\n \"contactInformation\": {\n \"eshopName\": \"www.domena-eshopu.cz\",\n \"url\": \"https:\\/\\/www.domena-eshopu.cz\\/\",\n \"companyId\": \"28935675\",\n ...\n }\n ...\n },\n \"errors\": 'null',\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n```\n\n\nThe basic structure of the response in the event of an error is as follows:\n\n\n```\n\n{\n \"data\": 'null',\n \"errors\": [\n {\n \"errorCode\": \"missing-access-token\",\n \"message\": \"Missing access token. Please add `Shoptet-Access-Token` header to your request.\",\n \"instance\": \"unknown\"\n }\n ],\n \"metadata\": {\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"\n }\n}\n\n```\n`metadata.requestId` is primary used for logging/reporting purposes. Please remember to include the value from `metadata.requestId` or from the header `X-Request-ID` when contacting the technical support with your specific inquiry for better traceability.\nMost of the endpoints are synchronous, i.e. your answer is provided\nimmediately and contains the data requested. There\n\nare however some endpoints, where either the request or the response\nprocessing takes longer time. These are implemented as\n\n[Asynchronous\nrequests](https://developers.shoptet.com/asynchronous-requests/). Your\nrequest will be queued and you\n\nreceive only job identification in the response. You will be notified using\na\n\n[webhook](https://developers.shoptet.com/api/documentation/webhooks/) when\nthe job is completed and your results\n\ndownloadable. Be aware, that registration of webhook `job:finished` is\nrequired to be able to run asynchronous requests.\n\nIf webhook is not registered, you will receive an error response with HTTP\nstatus code 403 and job won't be queued.\n\nWebhook `job:finished` is also emitted when the job is failed so there is need to check the [Job detail](#tag/jobs/getjobdetail)\nto get the result of the job. If an error occurs during an asynchronous request, the job is automatically marked as\nfailed 3 hours after its creation, and in this case, the `job:finished` webhook is not emitted.\n\n\nSome attributes may be added to the new API version, or the sequence of\nattributes can be changed.\n\nYour software, therefore, shall not rely on either of these.\n\nIf some attributes are renamed or removed, you will be informed in an additional header - see also [Deprecated header + Sunset](#section/basic-principles/deprecated-header-+-sunset).\n\n\n## Deprecated header + Sunset\n\n\nIf you are calling some endpoint in a version that will not be supported in\nthe future, you will receive a response with the header\n\n`X-Shoptet-Deprecated`. If you detect this header within the response and\nits presence is logged,\n\nyou should be aware of the support termination for a specific endpoint in\nadvance and thus have enough time for correction.\n\n\nFurthermore, you shall also receive the response with a`Sunset` header with\nthe date when the support for this endpoint is to be terminated.\n\n\n## Status codes\n\n\nWhen processing the response, the client shall first detect, what response\nstatus code was received.\n\n\nFor GET requests for responses with 200 code, it is not necessary to explore\nthe `errors` part of the response.\n\nFor PATCH/PUT requests, which can process more records at the same time and\nsome records\n\nare not processed successfully, these end with a 200 response code and the\nerrors key contains info\n on skipped rows.\n\nThe unknown record is returned with a 404 code, etc. These responses have\nthe error field filled in, where you can\n\nfind detailed info about the error.\n\n\nThe following errors might be expected:\n\n\n* 400 - Some of the validations on item level have failed. There is no\nreason to retry, it will fail always.\n\n\n* 401 - Invalid token or the token has expired (for addons access tokens).\nYou have to ask for another one.\n\n\n* 403 - Forbidden. The token has no rights to the endpoint called. The\nendpoints must be allowed for an addon\n and the eshop must have approved them. Valid for addons access tokens, private tokens can always access all\n endpoints. Can be also returned when required module for request is missing.\n\n* 404 - Either the endpoint is wrong; or most commonly, an entity\nidentifier, which is part of the URL, does\n not exist.\n\n* 409 - Conflict - the action could not be completed for some consistency\nrules, such as duplicate data\n or relation, which would be broken.\n\n* 413 - Payload too large - update requests can sometimes contain multiple\nentities to be amended. There is\n however a limit (varying for each request), how many can be specified within one request. If you breach the\n limit, you will get this error and nothing will be updated.\n\n* 422 - Unprocessable entity - we were not able to parse the request - it\ndoes not match the expected format.\n Something is wrong with the request as whole, it might not be a correct JSON or it does not match the expected\n JSON schema. There is no reason to retry, it will always fail.\n\n* 423 - Locked - for update and some read request we apply locks, usually on\nan URL level, which should avoid\n consistency problems possibly occuring from parallel updates. See [Locks](#section/basic-principles/locks) section. Retry later,\n try to avoid parallel update requests.\n\n* 500 - General server error. Yes, this might happen to our software, too.\nMost commonly this is a temporary\n database issue and it might (but might not), work a few minutes later. We monitor all such errors and we\n try to analyze and fix them.\n\n* 503 - System maintenance. Most commonly we move a database to another\ndatabase cluster or a database migration is\n pending and it will be available in a few minutes. Please try later.\n\n\n## Paging\n\n\nSome endpoints can return larger quantity of records. Such endpoints do not\nreturn the entire result, but support pagination of results.\n\nYou can page using `page` (int) and `itemsPerPage` (int) parameters.\nThe first page has number 1. If you require a different quantity of items per page, use the `itemsPerPage` parameter. \n`itemsPerPage` has a default value used when the parameter is not specified, and a maximum value that cannot be exceeded. If a higher value is provided, the maximum is applied automatically.\nThe default and maximum value can be different for each endpoint.\n\nWhen paging, check the total number of items, if not altered (`totalCount`), then the items on pages could be shifted and some of them could be missed or processed twice.\n\n\n## Section on demand\n\n\nSome endpoints return the data sections as optional, on demand. The request\nis done by giving the section name in the\n\n`include` parameter. Part of the data is returned each time, the other\nsection only on demand. This makes the responses smaller for those, who do\nnot need the data\n\n, thus saving the volume of data transmitted and shortening the time to\nprocess the request.\n\n\nFor example, for \"Eshop Info\" endpoint, you will gain basic info when simply\ncalling `[GET] /api/eshop`, but payment\n\nmethods and transport options only when using `[GET]\n/api/eshop?include=paymentMethods,shippingMethods`.\n\n\nMore values are separated by a comma, no sequencing, no upper/lower case\ndifferentiation. Other blocks are available on demand\n\nand each endpoint informs you which identifier to request.\n\n\n## Translations\n\n\nFor proper functionality in translations you will have to get module Foreign\nlanguages (Cizí jazyky) activated on customer e-shop. Multi-language support\nin API is handled by query parameter `language`, which can be used in whole\nAPI. If parameter is not set, default shop language is used.\n\nWhen module foreignLanguages is active and initialized, read endpoints (HTTP \nverb GET) will return corresponding language version of texts where applicable.\n\n\nFor write endpoints, first use POST endpoint to create entity and then use\nPATCH endpoint with corresponding language query parameter to set language\nfields. Language can be set only when module foreignLanguages is active and initialized.\n\n\nPlease note that in some endpoints (typically surcharge/filtering/variant\nparameters) you must use the identifier's currently selected language\nvariant (which is filtered in list).\n\n\n## Files upload\n\n\nFor files upload, there are [Files](#tag/files) endpoints.\n\n\nThe file is uploaded to a temporary storage which is not accessible\npublicly. The file is kept there for 7 days and then deleted.\n\n\nAfter you upload a file, you may copy it to some API entities in their\nendpoints - you specify filename returned in response of upload job.\n\n\nPlease note that currently only images (png, jpg, gif, webp) are allowed filetypes\nfor file upload.\n\n\n# Product images\n\n\nShoptet saves the product images in their original size and then prepares\nseveral sizes for standardized usage (called\n\nimage cuts). These cuts are created in advance and saved on the disk, so\nthey are readily available. The list of cuts is\n\nthe same for each e-shop, and each e-shop can theoretically have different\ncut sizes. In practice, their size is given\n\nby the template and most templates use the same sizes. The list of provided\ncuts is given by\n\nthe [Image cuts](#section/code-lists/image-cuts) code list.\n\n\nThe `/api/eshop?include=imageCuts` endpoint returns the `imageCuts` field in\nthe response, where each cut has the actual\n\nsize defined, and the URL base path. There are two base URLs (example for\nclassic.shoptet.cz, cut `detail`):\n\n\n- `urlPath`: \"https://classic.shoptet.cz/user/shop/detail/\"\n\n\n- `cdnPath`:\n\"https://cdn-api.myshoptet.com/usr/classic.shoptet.cz/user/shop/detail/\"\n\n\nUse the `urlPath` in case you need an up-to-date image right now. Use the\nurl for your backend processing and you\n\nwill retrieve the images only once. Images retrieved via `urlPath` are not\ncached. You can use image name or SEO version\n\nof the image name - see below.\n\n\nUse the `cdnPath` in case you want to use the image url on the frontend and\nusers of your application will display it,\n\ne.g. if you provide an alternative frontend, mobile application etc. The\nimages are cached and provided with lower\n\nlatency. Use `cdnName` retrieved from the product detail endpoint (or\nsimilar) - see below.\n\n\nOnce you determine the URL based on the purpose and image cut size (for\nexample `detail` for product detail, or `related`\n\nfor product preview), just append the filename you need. The filename can be\nretrieved from Product detail endpoint.\n\n\nAlthough the e-shop is behind the content delivery network (Cloudflare CDN),\nAPI still returns the same domain. Whether\n\nthe e-shop is behind the Cloudflare CDN, you can find out from response\nheaders (`CDN-Loop: cloudflare` header).\n\n\nThe product detail endpoint `/api/products/{guid}?include=images` returns\nthe image field `data.images[]` in the same\n\nsequence, as these are entered in administration. The file name `name` (for\nexample `100.jpg`) needs to be connected\n\nto the URL cut and then you have complete path to the image of a given cut\n(size), for example\n\n`https://classic.shoptet.cz/user/shop/detail/100.jpg`. You can also use\n`seoName`, which also contains a description\n\nof the image - you will be redirected to the same image. The `cdnName` is\nintended for use with the `cdnPath` only.\n\n`cdnName` contains a signed URL for the `big` cut. For other cuts, use the\n`signedCdnNames` array. Each element has a `type` (the cut code, e.g. `big`,\n`detail`, `thumbnail`) and a `name` (the pre-signed filename) that can be\nappended to the matching cut's `cdnPath` from `/api/eshop?include=imageCuts`.\nOld-format bare-hash URLs remain valid on the CDN.\n\nThe fields look like: (excerpt)\n\n\n```json\n \"name\": \"106.png\",\n \"description\": \"shamrock 2115611 640\",\n \"seoName\": \"106_shamrock-2115611-640.png\",\n \"cdnName\": \"106_shamrock-2115611-640.png?ff=1&x=1024&y=768&q=85&ts=5b2a41f5&sg=cce48299\",\n \"signedCdnNames\": [\n {\"type\": \"big\", \"name\": \"106_shamrock-2115611-640.png?ff=1&x=1024&y=768&q=85&ts=5b2a41f5&sg=cce48299\"},\n {\"type\": \"detail\", \"name\": \"106_shamrock-2115611-640.png?ff=1&x=423&y=318&q=85&ts=5b2a41f5&sg=265606b9\"}\n ]\n```\n\n\nOne of the images mentioned for the product can be selected as the default\nimage for the product variant. The selected\n\nimage is in `data.variants[].image` item and contains the name of the image\n– this can be searched for in the image\n\nlist, in the `name` item. Should the variant have no preselected default\nimage, the parameter `image` is `null`.\n\nIf `data.variants[].isProductDefaultImage` is true, then the default product image is given. If it is `false`, then\nit is the default variant image.\n\nThe item `data.items[].mainImage` contains the main image in order detail -\nthis is either a default variant image,\n\nor, if not set (or product does not have variants), the default product\nimage is given. The structure is the same as\n\nin product details, but not all images are given here, only the default one\n– representative image. The full path can\n\nbe gained by assembling the `urlPath` from the e-shop info and the `name` or\n`seoName` items, given for the order item.\n\n\nSimilarly, the product list gives `data.products[].mainImage`, which\nmentions the initial image for each product.\n\n\n# Code lists\n\n\n## Image cuts\n\n\nValue | Description\n-------- | ---------\norig | original image (in the original resolution)\nbig | big image (typically 1024x768 px)\ndetail |image detail (typically 360x270 px)\ncategory | size for listing in category (typically 216x105 px)\nrelated | size for related products (typically 100x100 px)\n\n## Product visibility\n\nValue | Description\n-------- | ---------\nhidden | Hide product\nvisible | Show product\nblocked | Cannot be ordered\nshow-registered | Show only to logged-in users\nblock-unregistered | Do not allow order to logged-out users\ncash-desk-only | Show only in cash desk\ndetail-only | Do not show e-shop navigation\n\n## Product types\n\nValue | Description\n-------- | ---------\nproduct | Product\nbazar | Second-hand product\nservice | Service\ngift-certificate | Gift (deprecated)\nproduct-set | Product set\n\n## Types of order items\n\n\nValue | Description\n-------- | ---------\nproduct | Product\nbazar | Second-hand product\nservice | Service\nshipping | Transportation\nbilling | Payment method\ndiscount-coupon | Discount coupon\nvolume-discount | Volume discount\ngift | Gift\ngift-certificate | Gift certificate\ngeneric-item | Non-specific item\nproduct-set | Product set\nproduct-set-item | Product set item\ndeposit | Deposit\n\n\n## Sorting of products in category\n\n\nValue | Description\n-------- | ---------\ndefault | Default\nmost-selling | Most selling first\ncheapest | Cheapest first\nmost-expensive | Most expensive first\noldest | Oldest first\nnewest | Newest first\nalphabetically | Alphabetically\nalphabetically-desc | Alphabetically, descending\nproduct-code | Per product code\nproduct-code-desc | Per product code, descending\ncategory-priority | Category priority\ncategory-priority-desc | Category priority, descending\n\n## Webhook event types\n\nValue | Description | Identifier meaning | Payload supported\n-------- | --------- | --------- | ---------\navailability:create | Availability creation event | Availability ID | no\navailability:update | Availability change event | Availability ID | no\navailability:delete | Availability deleting event | Availability ID | no\nbrand:create | Brand creation event | String (`code`) - brand unique code | no\nbrand:update | Brand change event | String (`code`) - brand unique code | no\nbrand:delete | Brand deleting event | String (`code`) - brand unique code | no\ncategory:create | Category creation event | String (`guid`) of product category | no\ncategory:update | Category change event | String (`guid`) of product category | no\ncategory:delete | Category deleting event | String (`guid`) of product category | no\ncreditNote:create | Credit note creation event | Number (`code`) of credit note | no\ncreditNote:delete | Credit note deleting event | Number (`code`) of credit note | no\ncreditNote:update | Credit note change event | Number (`code`) of credit note | no\ncustomer:create | New customer was created | Customer GUID | no\ncustomer:update | Customer was updated. Throws `409 Conflict` when try to register simultaneously with `customer:disableOrders` or `customer:enableOrders` | Customer GUID | no\ncustomer:disableOrders | An event disabled the customer, and his future orders will be automatically cancelled. Throws `409 Conflict` when try to register simultaneously with `customer:update` | Customer GUID | no\ncustomer:enableOrders | An event enabled the customer's future orders. Throws `409 Conflict` when try to register simultaneously with `customer:update` | Customer GUID | no\ncustomer:import | Import of 1 and more customers was executed | Fixed string \"customers\" | no\ncustomer:delete | Customer was deleted | Customer GUID | no\ncustomerGroup:create | Customer group creation event | ID of customer group | no\ncustomerGroup:update | Customer group change event | ID of customer group | no\ncustomerGroup:delete | Customer group deleting event | ID of customer group | no\ndeliveryNote:create | Delivery note creation event | Number (`code`) of delivery note | no\ndeliveryNote:delete | Delivery note deleting event | Number (`code`) of delivery note | no\ndeliveryNote:create | Delivery note creation event | Number (`code`) of delivery note | no\ndeliveryNote:update | Delivery note change event | Number (`code`) of delivery note | no\ndiscountCoupon:create | Discount coupon creating event | String (`code`) - discount coupon unique code | no\ndiscountCoupon:delete | Discount coupon deleting event | String (`code`) of discount coupon | no\ndiscountCoupon:update | Discount coupon updating event | String (`code`) - discount coupon unique code | no\neshop:currencies | Currencies settings change event | ID of eshop | no\neshop:billingInformation | Billing information (i.e. eshop billing address) change event | ID of eshop | no\neshop:settingsInformation | Eshop settings change event. Whenever some attribute from `data.settings` response section of GET eshop detail change | ID of eshop | no\neshop:design | Design settings (template, colors, fonts, layout) | ID of eshop | no\neshop:mandatoryFields | Mandatory fields of customer were updated | ID of eshop | no\neshop:projectDomain | Domain of eshop was changed | ID of eshop | no\ninvoice:create | Invoice creation event | Number (`code`) of invoice | no\ninvoice:delete | Invoice deleting event | Number (`code`) of invoice | no\ninvoice:update | Invoice change event | Number (`code`) of invoice | no\njob:finished | The asynchronous request was finished | Job `id` | no\nmailingListEmail:create | E-mail addition event into the e-mail distribution list | Name (`code`) of e-mail distribution list | no\nmailingListEmail:delete | E-mail deleting event from the e-mail distribution list | Name (`code`) of e-mail distribution | no\norder:cancel | Order cancel event. Webhook is emitted when order status is set to `canceled`. Throws `409 Conflict` when try to register simultaneously with `order:update` | Number (`code`) of order | no\norder:create | Order creation event | Number (`code`) of order | no\norder:delete | Order deleting event | Number (`code`) of order | no\norder:paid | Order paid event. Not emitted if a new order with paid status is created (register `order:create`/`order:massCreate`). Emitted only if the unpaid state is changed to paid during order update. | Number (`code`) of order | no\norder:update | Order change event. Throws `409 Conflict` when try to register simultaneously with `order:cancel` | Number (`code`) of order | no\norderHistoryRemarks:change | Order history remarks have been changed. Emitted when order remark is created or deleted | Number (`code`) of order | no\norderStatusesList:change | Order status list change event. Emitted when order status is created, updated or deleted | Order status `ID` | no\npricelist:create | Pricelist creation event | ID of pricelist | no\npricelist:delete | Pricelist deleting event | ID of pricelist | no\npaymentMethod:change | Payment method change event | Payment method GUID | no\nproformaInvoice:create | Proforma invoice creation event | Number (`code`) of proforma invoice | no\nproformaInvoice:delete | Proforma invoice deleting event | Number (`code`) of proforma invoice | no\nproformaInvoice:update | Proforma invoice change event | Number (`code`) of proforma invoice | no\nprojectReview:create | Project review creation event | ID of project review | no\nproduct:create (*) | Product creation event | String (`guid`) of product | no\nproduct:update (*) | Product change event | String (`guid`) of product | no\nproduct:delete (*) | Product deleting event | String (`guid`) of product | no\nproductVariant:create (*) | Product variant creation event | Variant code | no\nproductVariant:update (*) | Product variant change event | Variant code | no\nproductVariant:delete (*) | Product variant deleting event | Variant code | no\nproductVariantPrice:update (*) | Product variant price change event | Variant code | no\nproductReview:created | Product review creation event | ID of product review | no\nproofPayment:create | Proof of payment creation event | Number (`code`) of proof payment | no\nproofPayment:delete | Proof of payment deleting event | Number (`code`) of proof payment | no\nproofPayment:update | Proof of payment change event | Number (`code`) of proof payment | no\nquantityDiscount:create | Quantity discount creation event | ID of quantity discount | no\nquantityDiscount:update | Quantity discount change event | ID of quantity discount | no\nquantityDiscount:delete | Quantity discount deleting event | ID of quantity discount | no\nsalesChannel:create | Sales channel create event | GUID of sales channel | no\nsalesChannel:update | Sales channel update event | GUID of Shipment | no\nsalesChannel:delete | Sales channel delete event | GUID of Shipment | no\nshipment:create | Shipment confirmation event. Carrier confirmed the shipment (tracking number assigned, label ready) | GUID of Shipment | no\nshipment:update | Shipment status change event (in transit, delivered, returned, closed, cancel requested, etc.) | Shipment ID | no\nshipment:fail | Shipment failure event. Status changed to failed | Shipment ID | no\nshippingMethod:change | Shipping method change event | Shipping method GUID | no\nsectionArticle:create | Article section create event | ID of article section | no\nsectionArticle:update | Article section update event | ID of article section | no\nsectionArticle:delete | Article section delete event | ID of article section | no\nshippingRequest:cancelled | Shipping request was not chosen for order delivery | `shippingRequestCode` associated with the cart | no\nshippingRequest:confirmed | Shipping request was chosen for order delivery | `shippingRequestCode` associated with the cart | no\nstock:movement | Stock change event | Stock ID | no\nstock:inStock (*) | Stock change event - sum across all of the stocks raised above 0 (beta, see below) | Number (`code`) of product | no\nstock:soldOut (*) | Stock change event - sum across all of the stocks reached 0 (beta, see below) | Number (`code`) of product | no\nstock:minStockSupplyReached (*) | Stock change event - sum across all of the stocks reached minimum stock supply value, if this limit is set for product (beta, see below) | Number (`code`) of product | no\nsupplier:create | Supplier creation event | String (`guid`) of supplier | no\nsupplier:update | Supplier change event | String (`guid`) of supplier | no\nsupplier:delete | Supplier deletion event | String (`guid`) of supplier | no\nwarranty:create | Warranty creation event | Warranty ID | no\nwarranty:update | Warranty change event | Warranty ID | no\nwarranty:delete | Warranty deleting event | Warranty ID | no\n\n(*) These webhooks are considered beta/experimental, for more information, please visit the X-url\n\n### Mass Webhooks\n\nThese webhooks are sent when a mass change of entities is performed. The\npayload contains a json serialized list of IDs of changed entities.\n\nPurpose of these webhooks is to downgrade number of requests, while i.e.\nadministrator performs mass change of orders status at once etc.\n\nSo instead of emitting one event for every order, we emit one event for all\nof them.\n\n\nFor now, if some mass event is performed, we also sent \"single\"\nwebhook event for every updated entity as usual, but it will be changed in\nfuture, \nso please watch [release changes](https://developers.shoptet.com/category/api/) for more info\n\nPayload delivery (the `payload` field) is not available for mass webhooks, which is why the table below has no **Payload supported** column - it applies to single events only.\n\n\nValue | Description | Identifier meaning\n-------- | --------- | ---------\ncategory:massCreate | Mass create of product categories event | Json serialized list of string (`guid`) of product categories\ncategory:massUpdate | Mass change of product categories event | Json serialized list of string (`guid`) of product categories\ncategory:massDelete | Mass delete of product categories event | Json serialized list of string (`guid`) of product categories\ndiscountCoupon:massCreate | Mass create of discount coupons event | Json serialized list of string (`code`) of discount coupons\ndiscountCoupon:massDelete | Mass delete of discount coupons event | Json serialized list of string (`code`) of discount coupons\ninvoice:massUpdate | Mass change of invoices event | Json serialized list of number (`code`) of invoices\norder:massCreate | Mass create of orders event | Json serialized list of number (`code`) of orders\norder:massUpdate | Mass change of orders event | Json serialized list of number (`code`) of orders\norder:massPaid | Mass paid of orders event. Not emitted if a new mass orders with paid status are created (register `order:create`/`order:massCreate`). Emitted only if the unpaid state is changed to paid during mass orders update. | Json serialized list of number (`code`) of orders\nproduct:massCreate (*) | Mass create of products event | Json serialized list of string (`guid`) of products\nproduct:massUpdate (*) | Mass change of products event | Json serialized list of string (`guid`) of products\nproduct:massDelete (*) | Mass delete of products event | Json serialized list of string (`guid`) of products\nproductVariant:massCreate (*) | Mass create of product variants event | Json serialized list of variant codes\nproductVariant:massUpdate (*) | Mass change of product variants event | Json serialized list of variant codes\nproductVariant:massDelete (*) | Mass delete of product variants event | Json serialized list of variant codes\nproductVariantPrice:massUpdate (*) | Mass change of product variant prices event | Json serialized list of variant codes\nquantityDiscount:massDelete | Mass delete of quantity discount event | Json serialized list of quantity discounts IDs\nquantityDiscount:massUpdate | Mass change of quantity discount event | Json serialized list of quantity discounts IDs \n\n### System Webhooks\n\nThese webhooks cannot be registered via API, they are setup in Partners'\nAddon administration section instead.\n\n\nValue | Description\n----- | -----------\naddon:suspend | The addon was suspended by the eshop or by Shoptet operations staff\naddon:approve | The addon was approved (resumed) after it was suspended\naddon:terminate | The addon was terminated by the eshop or by Shoptet operations staff\naddon:uninstall | The addon was uninstalled by the eshop admin or the eshop was terminated\n\n## URL address from endpoint Eshop info\n\nSee endpoint [Eshop info](#tag/eshop/geteshopinfo)\n\nIdent | Description\n------| -----\nadmin-orders-list | Listing of orders in administration\nadmin-customers-list | List of customers in administration\noauth | OAuth server address, used for [e-shop user verification](https://developers.shoptet.com/api/documentation/eshop-verification-using-oauth/)\n\n## List of product catalogues\n\nProvider (identification) | Description\n------| -----\nglami | Glami\ngoogle | Google\nheureka | Heuréka\nzbozi | Zboží.cz\n\n## Invoice billing methods\n\nid | Description\n------| -----\n1 | COD (cz: Dobírka)\n2 | Wire transfer (cz: Převodem)\n3 | Cash (cz: Hotově)\n4 | Card (cz: Kartou)\n\n## VAT modes\n \n \nValue |\n------|\nNormal |\nOne Stop Shop |\nMini One Stop Shop |\nReverse charge |\nOutside the EU |\n\n## Shipment carrier types\nValue |\n------|\ncore |\nexternal |\nintegration |\nintegration_product_contract |\nbalikobot |\nsystem |\n\n## Shipment statuses\nValue |\n------|\nrequested |\nrequest_failed |\ncreated |\nin_transit |\nready_for_pickup |\ndelivered |\nfailed |\ncarrier_issue |\nback_transit |\nreturned |\ncanceled |\ncancel_requested |\nclosed |\ndeleted |\n\n\n# Postman collection\n\n\nIf you use Postman as an API platform for building and using APIs, we provide you a complex collection of Shoptet API.\n\nYou have 2 options how to import our postman collection (created from [openApi schema](https://swagger.io/specification/) - openapi.yaml ) into your postman client\n\n\n## Fork Shoptet API Collection from Shoptet Public API Workspace (recommended)\n\n\nSee [Shoptet Public API Workspace](https://www.postman.com/shoptet-developers/shoptet-public-api-workspace).\n\nAlso check postman documentation for more details: [Fork a collection](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/).\n\n\n### Step 1: Navigate to Shoptet Public API Workspace\n\n\n- Launch Postman on your desktop or in the browser.\n\n- In the search bar in the top header of app, type **Shoptet Public API** and select collection from Shoptet public API Workspace.\n\n\n### Step 2: Locate the Shoptet API Collection\n\n\n- Once inside the Shoptet Public API Workspace, go to the **Collections** tab.\n\n- Find the **Shoptet API** collection.\n\n\n### Step 3: Fork the Collection\n\n\n- Click on the **Shoptet API** collection to open it.\n\n- In the collection view, click the **Fork** button in the top-right corner.\n\n- In the fork dialog, choose a name for your forked collection.\n\n- Select the workspace where you want to save the forked collection.\n\n- **It’s recommended to check `watch original collection` to get notified about changes in the original collection.**\n\n- Click **Fork Collection**.\n\n\n### Step 4: Access Your Forked Collection\n\n\n- Navigate to the workspace where you saved the forked collection.\n\n- You’ll now find the forked **Shoptet API** collection under the **Collections** tab, ready for you to use and modify.\n\nNow you have your own copy of the Shoptet API collection! If you want to add changes from the original collection, you can do so by click on `pull changes` in collection settings.\n\n\n## Import openapi.yaml into Postman as a Collection\n\n\n### Step 1: Upload the `openapi.yaml` File\n\n\n- Download the [openapi.yaml](https://github.com/shoptet/developers/blob/master/openapi/openapi.yaml) file from our developers [repository](https://github.com/shoptet/developers).\n\n- Launch Postman on your desktop or in the browser.\n\n- In the top-left corner of Postman, click the **Import** button.\n\n- A pop-up window will appear.\n\n- Drag and drop your `openapi.yaml` file into the window, or click **Upload Files** and browse to the file's location.\n\n\n### Step 2: Verify OpenAPI Import\n\n\n- Postman will automatically recognize the OpenAPI schema.\n\n- It will display a preview of the API schema.\n\n\n### Step 3: Import as Collection\n\n\n- Once the file is recognized, click **Import**.\n\n- Postman will convert the OpenAPI schema into a collection of requests, based on the defined endpoints in the `openapi.yaml` file.\n\n\n### Step 4: Access the Imported Collection\n\n\n- After the import is successful, go to the **Collections** tab.\n\n- You’ll find your new collection, named after the OpenAPI schema, containing all the API requests generated from the file.\n\n\nNow you can explore the API endpoints and use them directly within Postman!\n\n## Collection settings\n\n1. Click the **Shoptet API** collection name.\n\n2. Go to **Authorization** tab.\n\n3. Set your access token into the `value` of `Shoptet-Access-Token` key.\n\n4. Go to **Variables** tab.\n\n5. You can set `baseUrl` variable here.\n\n# SDK\nThe official PHP library for the Shoptet REST API. The SDK is open-source and available on both [Packagist](https://packagist.org/packages/shoptet/api-sdk-php) and [GitHub](https://github.com/shoptet/api-sdk).\n## Requirements\nPHP 8.3 or later\n \n## Dependencies\nThe SDK requires the following extensions and libraries to work properly:\n- **[curl](https://www.php.net/manual/en/book.curl.php)** — You can use your own non-cURL client if preferred.\n- **[json](https://www.php.net/manual/en/book.json.php)**\n- **[psr/log](https://www.php-fig.org/psr/psr-3/)**\n\n> If you use Composer, these dependencies will be handled automatically. \n> If you install the library manually, please ensure that these extensions are available.\n## Installation\n### Composer\nYou can install the sdk via [Composer](https://getcomposer.org/). Run the following command:\n```bash\n composer require shoptet/api-sdk-php\n``` \nTo use the sdk, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):\n```bash\n require_once 'vendor/autoload.php';\n```\n### Manual\n```bash\n require_once '/path/to/api-sdk-php/init.php';\n```\n## Getting Started \n### Simple usage\n \n**Authorization**\n\nFor authorization, you need to set the partner domain URL and the token.\n```php\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n```\nIf token does not exist or is expired, you will need to obtain it first. For Obtaining a fresh public API token, you need to have the OAuth token for the eshop. See [how to get access token](https://developers.shoptet.com/api/documentation/getting-api-access-token/) for more information.\n \n```php\n // Set partner domain URL for obtaining fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \n try {\n // Try to authorize request with token for some eshop\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n } catch (TokenHasExpiredException | TokenNotFoundException) {\n // If token has expired or not found, create fresh public API token with specific OAuth token for eshop.\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::createFreshPublicApiToken('token-for-target-eshop', 'oauth-token-for-target-eshop');\n // Try to authorize request again with fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n }\n```\nYou can obtain oAuth access token after addon is installed in the eshop and you receive installation callback request. See [how to process addon installation](https://developers.shoptet.com/api/documentation/installing-the-addon/) for more information.\n```php\n // Set partner domain URL for obtaining fresh public API token\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n\n $requestData = new \\Shoptet\\Api\\Sdk\\Php\\Endpoint\\OAuth\\CreateOauthAccessToken\\CreateOauthAccessTokenRequestData([\n 'client_id' => 'some-client-id',\n 'client_secret' => 'some-client-secret',\n 'redirect_uri' => 'https://partner-redirect-domain.com/after/authorize',\n 'code' => 'fdqmcvw0b89p3xv31j7w....', // use code from request\n ]);\n\n $authorizationFacade = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createAuthorizationFacade();\n // obtain and store new OAuth token\n $authorizationFacade->addonInstallationCallback('oauth-token-for-target-eshop', $requestData);\n```\nFor storing tokens, there is in default basic implementation used `FileTokenStorage` which stores tokens in the file system. Default path for storing tokens is:\n```php\n protected const string DEFAULT_FILE_STORAGE_PATH = '/tmp/shoptet-api';\n```\n\nThis implementation is not recommended for production use. You should implement your own token storage which implements `TokenStorage` interface.\n```php\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setTokenStorage(new MyTokenStorage());\n```\n\n**Call endpoint with request body**\n```php\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n\n $createdBrandResponse = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createBrand([\n 'data' => [\n 'name' => 'Brand name',\n 'description' => 'Brand description',\n 'indexName' => 'brand-name',\n ]\n ]);\n\n $createdBrandResponse->getBody();\n //...\n```\n> [Read more](https://github.com/shoptet/api-sdk/blob/master/docs/request_body_processing_methods.md) about possible methods, how to call endpoints with request body.\n\n**Paginator**\n```php\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setPartnerDomainUrl('https://partner-eshop.myshoptet.com');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::authorizeRequest('token-for-target-eshop');\n\n $listOfProductResponse = \\Shoptet\\Api\\Sdk\\Php\\Sdk::getListOfProducts();\n //... Process response\n try {\n $listOfProductResponseNextPage = $listOfProductResponse->getNextPage();\n } catch (\\Shoptet\\Api\\Sdk\\Php\\Exception\\OutOfRangeException $e) {\n //Next page is out of range - Last page already reached\n }\n```\n\n### Webhooks\nList of supported webhooks can be found in `\\Shoptet\\Api\\Sdk\\Php\\Webhook\\Event` enum.\n\nUse the enum above or plain string in request body to register new webhook.\n```php\n Sdk::registerNewWebhook([\n 'data' => [\n [\n 'event' => \\Shoptet\\Api\\Sdk\\Php\\Webhook\\Event::BRAND_CREATE,\n 'url' => 'https://my-domain.com/shoptet-webhook-consumer/brand-create'\n ]\n ],\n ]);\n```\n\n### Custom header\n```php\n // Add/remove custom header\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setHeader('X-MY-AWESOME-HEADER', 'my-awesome-header-value');\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::unsetHeader('X-MY-AWESOME-HEADER');\n```\n\n### Custom request timeouts\n```php\n $httpClient = \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient();\n\n /**\n * Set connection timeout on 60sec\n * Default is 30sec\n * @see \\Shoptet\\Api\\Sdk\\Php\\HttpClient\\CurlClient::DEFAULT_TIMEOUT\n */\n $httpClient->setTimeout(60);\n\n /**\n * Set timeout on 90sec\n * Default is 80sec\n * @see \\Shoptet\\Api\\Sdk\\Php\\HttpClient\\CurlClient::DEFAULT_CONNECT_TIMEOUT\n */\n $httpClient->setConnectTimeout(90);\n\n echo $httpClient->getTimeout(); // 60\n echo $httpClient->getConnectTimeout(); // 90\n```\n\n### Handling Rate Limits\nWhen the API rate limit is exceeded, the SDK throws a `RateLimitExceededException`. You can handle this exception by retrying the request after the suggested `Retry-After` date. For more information, see the [Rate Limiting](https://api.docs.shoptet.com/openapi/section/basic-principles/rate-limiting) section in the API documentation.\n```php\n try {\n // ... Prepare the order entity\n // Send the request, which may exceed the rate limit\n $response = \\Shoptet\\Api\\Sdk\\Php\\Sdk::createOrder($orderEntity);\n } catch (\\Shoptet\\Api\\Sdk\\Php\\Exception\\RateLimitExceededException $e) {\n // Try again after Retry-After\n $retryAfter = $e->getRetryAfter();\n // ...\n }\n```\n\n### Custom cURL options\nYou can customize the default CurlClient with extra options. The keys should be valid `CURLOPT_*` constants or their integer equivalents. The options will be used in `curl_setopt_array()`.\n```php\n // Add/remove custom option in HttpClient\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient()\n ->addOption(CURLOPT_PROXY, 'my-proxy.local:80');\n ->removeOption(CURLOPT_PROXY);\n```\n\n### Response body type\nThe SDK provides multiple options how to handle response body automatically.\n- Return response body as the corresponding `Entity` object\n - Factory class: `\\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\EntityResponseFactory`\n - Default option\n- Return response body as array\n - Factory class: `\\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\ArrayResponseFactory`\n- Return response body as raw string\n - Factory class: `\\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\RawResponseFactory`\n\n```php\n echo get_class(\\Shoptet\\Api\\Sdk\\Php\\Sdk::getEshopInfo()->getBody()); // Shoptet\\Api\\Sdk\\Php\\Endpoint\\Eshop\\GetEshopInfoResponse\\GetEshopInfoResponse\n\n // Set response factory to ArrayResponseFactory so the response body will return as array (not the Entity)\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::getHttpClient()->setResponseFactory(new \\Shoptet\\Api\\Sdk\\Php\\Factory\\Response\\ArrayResponseFactory());\n\n echo gettype(\\Shoptet\\Api\\Sdk\\Php\\Sdk::getEshopInfo()->getBody()); // array\n```\n\n### Custom HttpClient\nIf current HttpClient is not sufficient you can implement your own Client. The client must implement `\\Shoptet\\Api\\Sdk\\Php\\HttpClient\\ClientInterface`.\n```php\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setHttpClient($httpClient);\n```\n\n### Logger\nThe library does minimal logging. Logging can be configured with a [PSR-3 compatible logger](https://www.php-fig.org/psr/psr-3/). Default Logger is the `Psr\\Log\\NullLogger` - So the logs end up in the void.\n```php\n \\Shoptet\\Api\\Sdk\\Php\\Sdk::setLogger($logger);\n```\n \n \n### Handeling snapshot endpoints result\nIf you need to process snapshot job result, i.e. `/api/products/snapshot`, you can use `JobResultProcessor` or Sdk helper method `Sdk::processSnapshotResult`. This method gets job result file path from response and processes it.\n\nIt returns an iterator over snapshot job result data. This method use Generator to process data with smaller memory footprint.\n```php\n $snapshotResultData = Sdk::processSnapshotResult('3xhzjz2');\n\n foreach ($snapshotResultData as $entity) {\n // do something with entity\n }\n```\n\n### Exceptions\nAll exceptions should implement `Shoptet\\Api\\Sdk\\Php\\Exception\\Exception`.\n\nThere are 3 base types of Exceptions:\n- `Shoptet\\Api\\Sdk\\Php\\Exception\\LogicException`\n- `Shoptet\\Api\\Sdk\\Php\\Exception\\RuntimeException`\n- `Shoptet\\Api\\Sdk\\Php\\Exception\\ReflectionException`\n\n### Tests\nTo run unit tests, use the following command:\n```bash\n composer test:unit\n```\n# Last changes\n\n\nLast API changes are published on the [API news] page\n(https://developers.shoptet.com/category/api/)."}},"baseSlug":"/shoptet-api/openapi","routesMapping":{}}