{"items":[{"type":"link","label":"Zoined API (ZAPI)","link":"/","routeSlug":"/","content":{"contentType":"overview","meta":{"name":"Zoined API (ZAPI)"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/index.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/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Zoined API (ZAPI)","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":"Zoined API enables customers or third parties to send their data to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zoined using RESTful HTTP API. Uploaded data will be processed and stored to our data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"warehouse and used for generating analytic reports for the retailers. API service has end"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"points for almost every facet of a retail business be it sales, inventory or even"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"employee time keeping."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This document contains instructions on how to access the Zoined API. This document"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contains two parts: introduction and reference. Introduction walks you through the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"general structure of the API and how to use it. Reference contains detailed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation for each API end point including code examples for multiple programming"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"languages, and live in-browser testing tool for the API end points."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you have any questions related to Zoined API, don't hesitate to contact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:support@zoined.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zoined support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication-and-security"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication and security"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every client must authenticate itself to send data towards any end points in Zoined API service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This means that every request to the service must have an authorization header with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an identification token. Token is unique to every customer and can be obtained by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contacting Zoined support services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An example of the header would be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer dGVzdGlhc2lha2FzOnZhaWtlYXBhc3N1\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer dGVzdGlhc2lha2FzOnZhaWtlYXBhc3N1\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All traffic to Zoined API is sent with HTTPS and protected with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Transport_Layer_Security"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLS"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"messaging"}},"children":[]}]}]}]}],"sectionId":"/section/authentication-and-security"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/messaging-and-error-handling"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Messaging and error handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API service uses JSON data format to exchange data with clients. This means all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replies to clients will be delivered in JSON (including all possible error messages)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The successful requests; i.e. the requests which delivered data in the correct format"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and thereby resulted in successful archiving of data will get 200 OK response with a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON message conveying number of records and the model to which it has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"been been added. This message looks like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n status: OK\n msg: \"1 Customer added\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n status: OK\n msg: \"1 Customer added\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error handling is done through standard HTTP status codes where code 200 means successful"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reply (no errors) and any other code describes error conditions while executing the service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usually error code is accompanied by JSON reply that further describes what went wrong."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generally following error codes are used:"},"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":"text","inline":true,"attributes":{"content":"400"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Means that there is something wrong with the request submitted by the client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usually there is JSON-reply describing the error. In most cases it is caused by missing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or malformed request body (JSON), missing mandatory fields in the JSON or Type errors,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g character instead of number, date/time format issues etc. Below is an example of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visitors end point if an empty request body was sent."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"status\": \"NOT OK\",\n  \"msg\": [\n    \"/visitors: error.path.missing\",\n    \"/date: error.path.missing\",\n    \"/organisation_id: error.path.missing\",\n    \"/time: error.path.missing\"\n  ]\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"status\": \"NOT OK\",\n  \"msg\": [\n    \"/visitors: error.path.missing\",\n    \"/date: error.path.missing\",\n    \"/organisation_id: error.path.missing\",\n    \"/time: error.path.missing\"\n  ]\n}\n"},"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":"text","inline":true,"attributes":{"content":"401"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – This code means that authentication has failed, due to missing or incorrect access token in authorization header. The response JSON body would be:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"status\":\"NOT OK\",\n  \"msg\":\"Unauthorized\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"status\":\"NOT OK\",\n  \"msg\":\"Unauthorized\"\n}\n"},"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":"text","inline":true,"attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Requested service does not exist or request method (eg. GET vs. POST) is incorrect. The response JSON in this case would be:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"status\":\"NOT OK\",\n  \"msg\":\"End point requested does not exist\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"status\":\"NOT OK\",\n  \"msg\":\"End point requested does not exist\"\n}\n"},"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":"text","inline":true,"attributes":{"content":"500"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – There was an internal error while processing the request. This is often a problem with the service itself. If this persists please contact Zoined service team with detailed information about the error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"status\":\"NOT OK\",\n  \"msg\":\"An Exception Occurred\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"status\":\"NOT OK\",\n  \"msg\":\"An Exception Occurred\"\n}\n"},"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":"text","inline":true,"attributes":{"content":"503"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Service is entirely offline. This indicates maintenance break or problem with the infrastructure. If error persists, please contact support."},"children":[]}]}]}]}]}],"sectionId":"/section/messaging-and-error-handling"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/frequently-asked-questions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frequently asked questions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I choose data format to send my data?"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A: You need to set Content-Type header in your request to correct value. Zoined API currently supports either JSON or CSV data formats. Any other format is NOT supported and will cause error reply."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default we assume content is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but it can be changed to CSV by adding header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Content-Type: application/csv\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Content-Type: application/csv\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What is the number format?"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No thousand separators. Use dot "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as decimal separator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What is the date format?"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A: All dates should be in ISO-format \"YYYY-MM-DD\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I enter the time? What is \"Z\" at the end of the time example?"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A: Enter the time in 24 hour format \"H24:Mi:ss\". 'Z' stands for UTC time zone and is optional like all time zone information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zoined will always use local time so any time zone information is just ignored and no time zone conversions are done."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do I enter values and headers with quotes (single or double) or without?"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A: For JSON, use double quotes for all headers and values. For CSV, do not use anything for either except when escaping special characters (see below)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I escape special characters in CSV?"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A: If field value has separator character (eg. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") backslash "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or double quote "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in it, you'll need to escape it by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wrapping the field value with double quotes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and prefixing any double quotes and backslashes with backslash. For example value"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"example;\\\"value\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"example;\\\\\\\"value\\\"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Separator character can be specified with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"separator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query string parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default we assume semicolon ';'. Escape characters ('' and '\"') cannot be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What character encoding should be used?"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A: For JSON the standard specifies that character set should be Unicode with either UTF-8, UTF-16 or UTF-32 encoding."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For CSV you can use any character encoding where separators and other special characters are encoded with single byte."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hence pure multi-byte encodings like UTF-16 are NOT supported with CSV format but mixed ones like UTF-8 are as long as special characters are encoded with single byte."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encoding should be specified with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"encoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query string parameter and it must correspond to encoding used in actual data. If unspecified then by default UTF-8 is assumed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How to get best performance for bigger data volume uploads?"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A: First of don't send your data one row at a time by making separate API call for each row."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That will severely degrade performance of overall data load causing it to take significantly longer time to complete."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead use fixed size chunks of suitable size (eg. 100000 rows per chunk) for each API call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json format is also generally slightly faster to process than csv data format."},"children":[]}]}]}]}],"sectionId":"/section/frequently-asked-questions"}]}]}},{"type":"link","label":"Authentication and security","link":"/section/authentication-and-security","routeSlug":"/section/authentication-and-security","content":null},{"type":"link","label":"Messaging and error handling","link":"/section/messaging-and-error-handling","routeSlug":"/section/messaging-and-error-handling","content":null},{"type":"link","label":"Frequently asked questions","link":"/section/frequently-asked-questions","routeSlug":"/section/frequently-asked-questions","content":null},{"type":"separator","label":"Data upload","content":null},{"type":"group","label":"Data upload: Introduction","link":"/overview-data-upload","routeSlug":"/overview-data-upload","items":[],"content":{"contentType":"group","meta":{"name":"overview-data-upload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data upload: Introduction","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":"Data upload end points allow one to upload data into Zoined warehouse. Each different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data type has their own end points which are documented below, however all of these end points have the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same structure. They expect HTTP POST request with either JSON or CSV data as request body."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please not that all end point names in URL string are case sensitive and must be written exactly as written in this document."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON data should be array of objects. For example for campaigns this could be"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"[\n  { \"campaign_id\": \"My campaign ID\", \"campaign_name\": \"February 2016\", \"start_date\": \"2016-02-01\", \"end_date\": \"2016-02-29\"\n},\n  { \"campaign_id\": \"My campaign ID2\", \"campaign_name\": \"March 2016\", \"start_date\": \"2016-03-01\", \"end_date\": \"2016-03-31\"\n} ]\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"[\n  { \"campaign_id\": \"My campaign ID\", \"campaign_name\": \"February 2016\", \"start_date\": \"2016-02-01\", \"end_date\": \"2016-02-29\"\n},\n  { \"campaign_id\": \"My campaign ID2\", \"campaign_name\": \"March 2016\", \"start_date\": \"2016-03-01\", \"end_date\": \"2016-03-31\"\n} ]\n"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV data should declare fields on the first line (header), and remaining lines should contain data to be uploaded. You can select"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field separator by adding parameter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"separator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to URL (URL escaping might be needed depending on separator char selected)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default separator is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You also need to escape all field values properly in case they contain separator chars and/or double quotes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or backslashes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Escaping is done by enclosing whole field with double quotes and adding backslash in front of any double quote or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"backslash characters. Eg. field: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\this\\ ;is; \"test\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be escaped as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"\\\\this\\\\ ;is; \\\"test\\\"\""},"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 campaigns the uploaded CSV -file could be"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"campaign_id; campaign_name; start_date; end_date\nMy Campaign ID; February 2016; 2016-02-01; 2016-02-29\n\"My Campaign \\\"March\\\"\";\"March 2016\";\"2016-03-01\";\"2016-03-31\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"campaign_id; campaign_name; start_date; end_date\nMy Campaign ID; February 2016; 2016-02-01; 2016-02-29\n\"My Campaign \\\"March\\\"\";\"March 2016\";\"2016-03-01\";\"2016-03-31\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details for usable fields available within individual end point documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each of the data upload end points also support \"dry run\" mode where data is validated, but not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stored into warehouse. This is useful when testing the API integration, as no changes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are stored, but any structural errors are reported immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our API end points can handle very large messages as received data is streaming within our back-end."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, it usually makes sense to split files into max 5Gb chunks. This makes it faster"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to retry transfers if there are any network errors while transferring data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For large files we recommend using Gzip encoding, as it can dramatically reduce amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of data to transfer. Gzip encoding can be used by encoding the data when sending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and adding Content-Encoding header."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Content-Encoding: gzip\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Content-Encoding: gzip\n"},"children":[]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/overview-data-upload"}],"panels":[]}]}},{"type":"group","label":"Sales transactions","link":"/upload-sales-transactions","routeSlug":"/upload-sales-transactions","items":[{"label":"Upload list of sales transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-sales-transactions/uploadsalestransactions","routeSlug":"/upload-sales-transactions/uploadsalestransactions","metadata":{"seo":{"title":"Upload list of sales transactions","description":"POST https://api.zoined.com/sales?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadSalesTransactions","name":"Upload list of sales transactions","isWebhook":false,"pointer":"/paths/~1sales/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of sales transactions","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/sales?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1sales/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2"},"text/csv":{"schemaId":"components/schemas/SalesTransactionUploadPayloadCsv"}},"schemaId":"schema_2","pointer":"/paths/~1sales/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sales","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_2"},"text/csv":{"schemaId":"components/schemas/SalesTransactionUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/sales","href":"/upload-sales-transactions/uploadsalestransactions","openApiOperationId":"uploadSalesTransactions","summary":"Upload list of sales transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_2","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2"},"text/csv":{"schemaId":"components/schemas/SalesTransactionUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1sales/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1sales/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1sales/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1sales/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1sales/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1sales/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1sales/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1sales/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1sales/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1sales/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1sales/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1sales/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1sales/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1sales/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1sales/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1sales/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1sales/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-sales-transactions/uploadsalestransactions"}],"panels":[]}]},"httpPath":"/sales"}],"content":{"contentType":"group","meta":{"name":"upload-sales-transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales transactions","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":"This is the main fact entity within Zoined. It contains essential information about sales, such as number of items sold, sales price, rebates and purchase price."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It also links masterdata together by storing information about:"},"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":"What was sold (Product dimension)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where was it sold (Organisation dimension)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who sold it (Salesperson Dimension)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To whom was it sold (Customer dimension)"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sales","summary":"Upload list of sales transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-sales-transactions/uploadsalestransactions","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/upload-products","routeSlug":"/upload-products","items":[{"label":"Upload list of products","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-products/uploadproducts","routeSlug":"/upload-products/uploadproducts","metadata":{"seo":{"title":"Upload list of products","description":"POST https://api.zoined.com/products?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadProducts","name":"Upload list of products","isWebhook":false,"pointer":"/paths/~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/products?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1products/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3"},"text/csv":{"schemaId":"schema_4","exampleIds":["paths/~1products/post/requestBody/content/text~1csv/examples/categoryId","paths/~1products/post/requestBody/content/text~1csv/examples/categoryLevelsInline"]}},"schemaId":"schema_3","pointer":"/paths/~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_3"},"text/csv":{"schemaId":"schema_4","exampleIds":["paths/~1products/post/requestBody/content/text~1csv/examples/categoryId","paths/~1products/post/requestBody/content/text~1csv/examples/categoryLevelsInline"]}},"responseCodes":["200","400","401","500"],"pointer":"/products","href":"/upload-products/uploadproducts","openApiOperationId":"uploadProducts","summary":"Upload list of products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_3","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_3"},"text/csv":{"schemaId":"schema_4","exampleIds":["paths/~1products/post/requestBody/content/text~1csv/examples/categoryId","paths/~1products/post/requestBody/content/text~1csv/examples/categoryLevelsInline"]}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1products/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1products/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1products/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1products/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1products/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1products/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1products/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1products/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1products/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1products/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1products/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1products/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1products/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1products/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1products/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1products/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-products/uploadproducts"}],"panels":[]}]},"httpPath":"/products"}],"content":{"contentType":"group","meta":{"name":"upload-products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","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":"Sales items or services being sold."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products usually belong to product hierarchy which allows one to drill down from top of hierarchy to lower levels in the Zoined Analytics Portal. There are two ways of defining the product hierarchy:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use FlatHierarchies endpoint with one of the product hierarchy keys "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" having same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload product hierarchy using ProductHierarchy endpoint, and add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field pointing to correct hierarchy level."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/products","summary":"Upload list of products","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-products/uploadproducts","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/upload-customers","routeSlug":"/upload-customers","items":[{"label":"Upload list of customers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-customers/uploadcustomers","routeSlug":"/upload-customers/uploadcustomers","metadata":{"seo":{"title":"Upload list of customers","description":"POST https://api.zoined.com/customers?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCustomers","name":"Upload list of customers","isWebhook":false,"pointer":"/paths/~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/customers?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1customers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5"},"text/csv":{"schemaId":"components/schemas/CustomerUploadPayloadCsv"}},"schemaId":"schema_5","pointer":"/paths/~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5"},"text/csv":{"schemaId":"components/schemas/CustomerUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/customers","href":"/upload-customers/uploadcustomers","openApiOperationId":"uploadCustomers","summary":"Upload list of customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_5","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5"},"text/csv":{"schemaId":"components/schemas/CustomerUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1customers/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1customers/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customers/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customers/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1customers/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1customers/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customers/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customers/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1customers/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1customers/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customers/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customers/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1customers/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1customers/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customers/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customers/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-customers/uploadcustomers"}],"panels":[]}]},"httpPath":"/customers"}],"content":{"contentType":"group","meta":{"name":"upload-customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":"Customers are identified consumers or businesses that buy your products or services. Details about customers are not shown in the service for data security reasons."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers","summary":"Upload list of customers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-customers/uploadcustomers","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer feedback","link":"/upload-customer-feedback","routeSlug":"/upload-customer-feedback","items":[{"label":"Upload list of customer feedback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-customer-feedback/uploadcustomerfeedback","routeSlug":"/upload-customer-feedback/uploadcustomerfeedback","metadata":{"seo":{"title":"Upload list of customer feedback","description":"POST https://api.zoined.com/customerFeedbacks?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCustomerFeedback","name":"Upload list of customer feedback","isWebhook":false,"pointer":"/paths/~1customerFeedbacks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of customer feedback","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/customerFeedbacks?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"true"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1customerFeedbacks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6"},"text/csv":{"schemaId":"components/schemas/CustomerFeedbackUploadPayloadCsv"}},"schemaId":"schema_6","pointer":"/paths/~1customerFeedbacks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customerFeedbacks","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"true","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_6"},"text/csv":{"schemaId":"components/schemas/CustomerFeedbackUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/customerFeedbacks","href":"/upload-customer-feedback/uploadcustomerfeedback","openApiOperationId":"uploadCustomerFeedback","summary":"Upload list of customer feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_6","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6"},"text/csv":{"schemaId":"components/schemas/CustomerFeedbackUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1customerFeedbacks/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1customerFeedbacks/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1customerFeedbacks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1customerFeedbacks/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1customerFeedbacks/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1customerFeedbacks/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-customer-feedback/uploadcustomerfeedback"}],"panels":[]}]},"httpPath":"/customerFeedbacks"}],"content":{"contentType":"group","meta":{"name":"upload-customer-feedback"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer feedback","showPageActions":true},{"nodeType":"markdoc","content":"Customer feedback endpoint can be used to upload either free form survey results or satisfaction grades."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customerFeedbacks","summary":"Upload list of customer feedback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-customer-feedback/uploadcustomerfeedback","deprecated":false}]}]}]}]}},{"type":"group","label":"Cashier balance","link":"/upload-cashier-balance","routeSlug":"/upload-cashier-balance","items":[{"label":"Upload list of cashier balances","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-cashier-balance/uploadcashierbalance","routeSlug":"/upload-cashier-balance/uploadcashierbalance","metadata":{"seo":{"title":"Upload list of cashier balances","description":"POST https://api.zoined.com/cashierBalance?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCashierBalance","name":"Upload list of cashier balances","isWebhook":false,"pointer":"/paths/~1cashierBalance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of cashier balances","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/cashierBalance?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"true"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1cashierBalance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"},"text/csv":{"schemaId":"components/schemas/CashierBalanceUploadPayloadCsv"}},"schemaId":"schema_7","pointer":"/paths/~1cashierBalance/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cashierBalance","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"true","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7"},"text/csv":{"schemaId":"components/schemas/CashierBalanceUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/cashierBalance","href":"/upload-cashier-balance/uploadcashierbalance","openApiOperationId":"uploadCashierBalance","summary":"Upload list of cashier balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_7","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7"},"text/csv":{"schemaId":"components/schemas/CashierBalanceUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1cashierBalance/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1cashierBalance/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashierBalance/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashierBalance/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1cashierBalance/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1cashierBalance/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashierBalance/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashierBalance/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1cashierBalance/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1cashierBalance/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1cashierBalance/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashierBalance/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashierBalance/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1cashierBalance/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1cashierBalance/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashierBalance/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashierBalance/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-cashier-balance/uploadcashierbalance"}],"panels":[]}]},"httpPath":"/cashierBalance"}],"content":{"contentType":"group","meta":{"name":"upload-cashier-balance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cashier balance","showPageActions":true},{"nodeType":"markdoc","content":"Cashier balance end point can be used to upload cash register book keeping reports mainly used to verify that payments match with store sales."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cashierBalance","summary":"Upload list of cashier balances","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-cashier-balance/uploadcashierbalance","deprecated":false}]}]}]}]}},{"type":"group","label":"Organisations","link":"/upload-organisations","routeSlug":"/upload-organisations","items":[{"label":"Upload list of organisation units","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-organisations/uploadorganisations","routeSlug":"/upload-organisations/uploadorganisations","metadata":{"seo":{"title":"Upload list of organisation units","description":"POST https://api.zoined.com/organisations?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadOrganisations","name":"Upload list of organisation units","isWebhook":false,"pointer":"/paths/~1organisations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of organisation units","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/organisations?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1organisations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8"},"text/csv":{"schemaId":"components/schemas/OrganisationUnitUploadPayloadCsv"}},"schemaId":"schema_8","pointer":"/paths/~1organisations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/organisations","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_8"},"text/csv":{"schemaId":"components/schemas/OrganisationUnitUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/organisations","href":"/upload-organisations/uploadorganisations","openApiOperationId":"uploadOrganisations","summary":"Upload list of organisation units"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_8","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8"},"text/csv":{"schemaId":"components/schemas/OrganisationUnitUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1organisations/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1organisations/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1organisations/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1organisations/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1organisations/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1organisations/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1organisations/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1organisations/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1organisations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1organisations/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1organisations/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1organisations/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1organisations/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1organisations/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1organisations/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1organisations/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1organisations/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-organisations/uploadorganisations"}],"panels":[]}]},"httpPath":"/organisations"}],"content":{"contentType":"group","meta":{"name":"upload-organisations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organisations","showPageActions":true},{"nodeType":"markdoc","content":"Organisations are the sales locations. They can be physical stores, web commerce sites, warehouses or personal payment terminals."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations","summary":"Upload list of organisation units","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-organisations/uploadorganisations","deprecated":false}]}]}]}]}},{"type":"group","label":"Departments","link":"/upload-departments","routeSlug":"/upload-departments","items":[{"label":"Upload list of departments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-departments/uploaddepartments","routeSlug":"/upload-departments/uploaddepartments","metadata":{"seo":{"title":"Upload list of departments","description":"POST https://api.zoined.com/departments?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadDepartments","name":"Upload list of departments","isWebhook":false,"pointer":"/paths/~1departments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of departments","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/departments?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1departments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9"},"text/csv":{"schemaId":"components/schemas/DepartmentUploadPayloadCsv"}},"schemaId":"schema_9","pointer":"/paths/~1departments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/departments","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_9"},"text/csv":{"schemaId":"components/schemas/DepartmentUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/departments","href":"/upload-departments/uploaddepartments","openApiOperationId":"uploadDepartments","summary":"Upload list of departments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_9","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9"},"text/csv":{"schemaId":"components/schemas/DepartmentUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1departments/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1departments/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1departments/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1departments/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1departments/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1departments/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1departments/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1departments/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1departments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1departments/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1departments/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1departments/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1departments/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1departments/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1departments/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1departments/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1departments/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-departments/uploaddepartments"}],"panels":[]}]},"httpPath":"/departments"}],"content":{"contentType":"group","meta":{"name":"upload-departments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Departments","showPageActions":true},{"nodeType":"markdoc","content":"Departments are sections of sales locations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/departments","summary":"Upload list of departments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-departments/uploaddepartments","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales persons","link":"/upload-sales-persons","routeSlug":"/upload-sales-persons","items":[{"label":"Upload list of sales persons","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-sales-persons/uploadsalespersons","routeSlug":"/upload-sales-persons/uploadsalespersons","metadata":{"seo":{"title":"Upload list of sales persons","description":"POST https://api.zoined.com/salesPersons?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadSalesPersons","name":"Upload list of sales persons","isWebhook":false,"pointer":"/paths/~1salesPersons/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of sales persons","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/salesPersons?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1salesPersons/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_10"},"text/csv":{"schemaId":"components/schemas/SalesPersonUploadPayloadCsv"}},"schemaId":"schema_10","pointer":"/paths/~1salesPersons/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/salesPersons","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_10"},"text/csv":{"schemaId":"components/schemas/SalesPersonUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/salesPersons","href":"/upload-sales-persons/uploadsalespersons","openApiOperationId":"uploadSalesPersons","summary":"Upload list of sales persons"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_10","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_10"},"text/csv":{"schemaId":"components/schemas/SalesPersonUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesPersons/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesPersons/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPersons/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPersons/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesPersons/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesPersons/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPersons/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPersons/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1salesPersons/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesPersons/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesPersons/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPersons/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPersons/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesPersons/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesPersons/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPersons/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPersons/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-sales-persons/uploadsalespersons"}],"panels":[]}]},"httpPath":"/salesPersons"}],"content":{"contentType":"group","meta":{"name":"upload-sales-persons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales persons","showPageActions":true},{"nodeType":"markdoc","content":"This is the sales person associated with the receipt."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/salesPersons","summary":"Upload list of sales persons","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-sales-persons/uploadsalespersons","deprecated":false}]}]}]}]}},{"type":"group","label":"Cash registers","link":"/upload-cash-registers","routeSlug":"/upload-cash-registers","items":[{"label":"Upload list of cash registers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-cash-registers/uploadcashregisters","routeSlug":"/upload-cash-registers/uploadcashregisters","metadata":{"seo":{"title":"Upload list of cash registers","description":"POST https://api.zoined.com/cashRegisters?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCashRegisters","name":"Upload list of cash registers","isWebhook":false,"pointer":"/paths/~1cashRegisters/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of cash registers","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/cashRegisters?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1cashRegisters/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11"},"text/csv":{"schemaId":"components/schemas/CashRegisterUploadPayloadCsv"}},"schemaId":"schema_11","pointer":"/paths/~1cashRegisters/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cashRegisters","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_11"},"text/csv":{"schemaId":"components/schemas/CashRegisterUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/cashRegisters","href":"/upload-cash-registers/uploadcashregisters","openApiOperationId":"uploadCashRegisters","summary":"Upload list of cash registers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_11","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11"},"text/csv":{"schemaId":"components/schemas/CashRegisterUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1cashRegisters/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1cashRegisters/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashRegisters/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashRegisters/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1cashRegisters/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1cashRegisters/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashRegisters/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashRegisters/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1cashRegisters/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1cashRegisters/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1cashRegisters/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashRegisters/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashRegisters/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1cashRegisters/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1cashRegisters/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashRegisters/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1cashRegisters/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-cash-registers/uploadcashregisters"}],"panels":[]}]},"httpPath":"/cashRegisters"}],"content":{"contentType":"group","meta":{"name":"upload-cash-registers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cash registers","showPageActions":true},{"nodeType":"markdoc","content":"This is the physical cash register device associated with the receipt."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cashRegisters","summary":"Upload list of cash registers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-cash-registers/uploadcashregisters","deprecated":false}]}]}]}]}},{"type":"group","label":"Store open hours","link":"/upload-store-open-hours","routeSlug":"/upload-store-open-hours","items":[{"label":"Upload list of open hours","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-store-open-hours/uploadstoreopenhours","routeSlug":"/upload-store-open-hours/uploadstoreopenhours","metadata":{"seo":{"title":"Upload list of open hours","description":"POST https://api.zoined.com/openHours?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadStoreOpenHours","name":"Upload list of open hours","isWebhook":false,"pointer":"/paths/~1openHours/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of open hours","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/openHours?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"true"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1openHours/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_12"},"text/csv":{"schemaId":"components/schemas/OpeningHourUploadPayloadCsv"}},"schemaId":"schema_12","pointer":"/paths/~1openHours/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/openHours","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"true","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_12"},"text/csv":{"schemaId":"components/schemas/OpeningHourUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/openHours","href":"/upload-store-open-hours/uploadstoreopenhours","openApiOperationId":"uploadStoreOpenHours","summary":"Upload list of open hours"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_12","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_12"},"text/csv":{"schemaId":"components/schemas/OpeningHourUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1openHours/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1openHours/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1openHours/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1openHours/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1openHours/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1openHours/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1openHours/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1openHours/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1openHours/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1openHours/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1openHours/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1openHours/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1openHours/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1openHours/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1openHours/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1openHours/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1openHours/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-store-open-hours/uploadstoreopenhours"}],"panels":[]}]},"httpPath":"/openHours"}],"content":{"contentType":"group","meta":{"name":"upload-store-open-hours"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Store open hours","showPageActions":true},{"nodeType":"markdoc","content":"Open hours end point can be used to upload store open hours for all weekdays and for different seasons. Helps forecasting accuracy."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/openHours","summary":"Upload list of open hours","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-store-open-hours/uploadstoreopenhours","deprecated":false}]}]}]}]}},{"type":"group","label":"Counters","link":"/upload-counters","routeSlug":"/upload-counters","items":[{"label":"Upload list of counters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-counters/uploadcounters","routeSlug":"/upload-counters/uploadcounters","metadata":{"seo":{"title":"Upload list of counters","description":"POST https://api.zoined.com/counters?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCounters","name":"Upload list of counters","isWebhook":false,"pointer":"/paths/~1counters/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of counters","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/counters?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1counters/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_13"},"text/csv":{"schemaId":"components/schemas/CounterUploadPayloadCsv"}},"schemaId":"schema_13","pointer":"/paths/~1counters/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/counters","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_13"},"text/csv":{"schemaId":"components/schemas/CounterUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/counters","href":"/upload-counters/uploadcounters","openApiOperationId":"uploadCounters","summary":"Upload list of counters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_13","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_13"},"text/csv":{"schemaId":"components/schemas/CounterUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1counters/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1counters/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1counters/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1counters/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1counters/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1counters/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1counters/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1counters/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1counters/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1counters/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1counters/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1counters/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1counters/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1counters/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1counters/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1counters/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1counters/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-counters/uploadcounters"}],"panels":[]}]},"httpPath":"/counters"}],"content":{"contentType":"group","meta":{"name":"upload-counters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Counters","showPageActions":true},{"nodeType":"markdoc","content":"Counters are visitor counting devices."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/counters","summary":"Upload list of counters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-counters/uploadcounters","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounts","link":"/upload-accounts","routeSlug":"/upload-accounts","items":[{"label":"Upload list of bookkeeping accounts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-accounts/uploadaccounts","routeSlug":"/upload-accounts/uploadaccounts","metadata":{"seo":{"title":"Upload list of bookkeeping accounts","description":"POST https://api.zoined.com/accounts?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadAccounts","name":"Upload list of bookkeeping accounts","isWebhook":false,"pointer":"/paths/~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of bookkeeping 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/accounts?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1accounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_14"},"text/csv":{"schemaId":"components/schemas/AccountUploadPayloadCsv"}},"schemaId":"schema_14","pointer":"/paths/~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_14"},"text/csv":{"schemaId":"components/schemas/AccountUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/accounts","href":"/upload-accounts/uploadaccounts","openApiOperationId":"uploadAccounts","summary":"Upload list of bookkeeping accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_14","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_14"},"text/csv":{"schemaId":"components/schemas/AccountUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1accounts/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1accounts/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounts/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounts/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1accounts/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1accounts/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1accounts/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounts/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounts/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-accounts/uploadaccounts"}],"panels":[]}]},"httpPath":"/accounts"}],"content":{"contentType":"group","meta":{"name":"upload-accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":"This is the account associated with accounting data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts","summary":"Upload list of bookkeeping accounts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-accounts/uploadaccounts","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/upload-events","routeSlug":"/upload-events","items":[{"label":"Upload list of booking events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-events/uploadevents","routeSlug":"/upload-events/uploadevents","metadata":{"seo":{"title":"Upload list of booking events","description":"POST https://api.zoined.com/events?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadEvents","name":"Upload list of booking events","isWebhook":false,"pointer":"/paths/~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of booking events","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/events?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1events/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_15"},"text/csv":{"schemaId":"components/schemas/EventUploadPayloadCsv"}},"schemaId":"schema_15","pointer":"/paths/~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_15"},"text/csv":{"schemaId":"components/schemas/EventUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/events","href":"/upload-events/uploadevents","openApiOperationId":"uploadEvents","summary":"Upload list of booking events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_15","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_15"},"text/csv":{"schemaId":"components/schemas/EventUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1events/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1events/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1events/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1events/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1events/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1events/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1events/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1events/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1events/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1events/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1events/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1events/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1events/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1events/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-events/uploadevents"}],"panels":[]}]},"httpPath":"/events"}],"content":{"contentType":"group","meta":{"name":"upload-events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":"This is the event associated with booking data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events","summary":"Upload list of booking events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-events/uploadevents","deprecated":false}]}]}]}]}},{"type":"group","label":"Calendar","link":"/upload-calendar","routeSlug":"/upload-calendar","items":[{"label":"Upload custom calendar attributes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-calendar/uploadcalendar","routeSlug":"/upload-calendar/uploadcalendar","metadata":{"seo":{"title":"Upload custom calendar attributes","description":"POST https://api.zoined.com/calendar?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCalendar","name":"Upload custom calendar attributes","isWebhook":false,"pointer":"/paths/~1calendar/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload custom calendar attributes","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/calendar?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1calendar/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"},"text/csv":{"schemaId":"components/schemas/CalendarUploadPayloadCsv"}},"schemaId":"schema_16","pointer":"/paths/~1calendar/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/calendar","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_16"},"text/csv":{"schemaId":"components/schemas/CalendarUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/calendar","href":"/upload-calendar/uploadcalendar","openApiOperationId":"uploadCalendar","summary":"Upload custom calendar attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_16","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"},"text/csv":{"schemaId":"components/schemas/CalendarUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1calendar/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1calendar/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1calendar/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1calendar/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1calendar/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1calendar/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1calendar/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1calendar/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1calendar/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1calendar/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1calendar/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1calendar/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1calendar/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1calendar/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1calendar/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1calendar/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1calendar/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-calendar/uploadcalendar"}],"panels":[]}]},"httpPath":"/calendar"}],"content":{"contentType":"group","meta":{"name":"upload-calendar"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calendar","showPageActions":true},{"nodeType":"markdoc","content":"Custom calendar attributes can be used to define custom retail calendar like 4-4-5 etc. with year starting and ending at desirable dates.\nSupported attributes include year, period (month), season and week number."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/calendar","summary":"Upload custom calendar attributes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-calendar/uploadcalendar","deprecated":false}]}]}]}]}},{"type":"group","label":"Campaigns","link":"/upload-campaigns","routeSlug":"/upload-campaigns","items":[{"label":"Upload list of campaigns","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-campaigns/uploadcampaigns","routeSlug":"/upload-campaigns/uploadcampaigns","metadata":{"seo":{"title":"Upload list of campaigns","description":"POST https://api.zoined.com/campaigns?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCampaigns","name":"Upload list of campaigns","isWebhook":false,"pointer":"/paths/~1campaigns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of campaigns","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/campaigns?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1campaigns/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"},"text/csv":{"schemaId":"components/schemas/CampaignUploadPayloadCsv"}},"schemaId":"schema_17","pointer":"/paths/~1campaigns/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaigns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_17"},"text/csv":{"schemaId":"components/schemas/CampaignUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/campaigns","href":"/upload-campaigns/uploadcampaigns","openApiOperationId":"uploadCampaigns","summary":"Upload list of campaigns"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_17","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"},"text/csv":{"schemaId":"components/schemas/CampaignUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1campaigns/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1campaigns/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaigns/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaigns/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1campaigns/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1campaigns/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaigns/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaigns/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1campaigns/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1campaigns/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1campaigns/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaigns/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaigns/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1campaigns/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1campaigns/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaigns/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaigns/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-campaigns/uploadcampaigns"}],"panels":[]}]},"httpPath":"/campaigns"}],"content":{"contentType":"group","meta":{"name":"upload-campaigns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaigns","showPageActions":true},{"nodeType":"markdoc","content":"A campaign is a sales effort which can be measured for progress and success.\nCampaigns can be linked to sales transactions either directly or via Campaign Products."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/campaigns","summary":"Upload list of campaigns","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-campaigns/uploadcampaigns","deprecated":false}]}]}]}]}},{"type":"group","label":"Campaign products","link":"/upload-campaign-products","routeSlug":"/upload-campaign-products","items":[{"label":"Upload list of campaign products","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-campaign-products/uploadcampaignproducts","routeSlug":"/upload-campaign-products/uploadcampaignproducts","metadata":{"seo":{"title":"Upload list of campaign products","description":"POST https://api.zoined.com/campaignProducts?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCampaignProducts","name":"Upload list of campaign products","isWebhook":false,"pointer":"/paths/~1campaignProducts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of campaign 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/campaignProducts?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1campaignProducts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18"},"text/csv":{"schemaId":"components/schemas/CampaignProductUploadPayloadCsv"}},"schemaId":"schema_18","pointer":"/paths/~1campaignProducts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaignProducts","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_18"},"text/csv":{"schemaId":"components/schemas/CampaignProductUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/campaignProducts","href":"/upload-campaign-products/uploadcampaignproducts","openApiOperationId":"uploadCampaignProducts","summary":"Upload list of campaign products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_18","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18"},"text/csv":{"schemaId":"components/schemas/CampaignProductUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1campaignProducts/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1campaignProducts/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaignProducts/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaignProducts/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1campaignProducts/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1campaignProducts/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error while processing the request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaignProducts/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaignProducts/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1campaignProducts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1campaignProducts/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1campaignProducts/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaignProducts/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaignProducts/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1campaignProducts/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1campaignProducts/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaignProducts/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1campaignProducts/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-campaign-products/uploadcampaignproducts"}],"panels":[]}]},"httpPath":"/campaignProducts"}],"content":{"contentType":"group","meta":{"name":"upload-campaign-products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaign products","showPageActions":true},{"nodeType":"markdoc","content":"Campaign products associates products with specific campaigns.\nThis allows creation of campaigns retroactively, but will slow down data loading as each sales row needs to be matched against existing campaigns.\n\nCampaign products should only be used if it is not possible to add campaign information directly to sales transactions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/campaignProducts","summary":"Upload list of campaign products","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-campaign-products/uploadcampaignproducts","deprecated":false}]}]}]}]}},{"type":"group","label":"Campaign Sales","link":"/upload-campaign-sales","routeSlug":"/upload-campaign-sales","items":[{"label":"Upload list of campaign sales","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-campaign-sales/uploadcampaignsales","routeSlug":"/upload-campaign-sales/uploadcampaignsales","metadata":{"seo":{"title":"Upload list of campaign sales","description":"POST https://api.zoined.com/salesCampaigns?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCampaignSales","name":"Upload list of campaign sales","isWebhook":false,"pointer":"/paths/~1salesCampaigns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of campaign sales","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/salesCampaigns?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1salesCampaigns/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_19"},"text/csv":{"schemaId":"components/schemas/SalesCampaignUploadPayloadCsv"}},"schemaId":"schema_19","pointer":"/paths/~1salesCampaigns/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/salesCampaigns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_19"},"text/csv":{"schemaId":"components/schemas/SalesCampaignUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/salesCampaigns","href":"/upload-campaign-sales/uploadcampaignsales","openApiOperationId":"uploadCampaignSales","summary":"Upload list of campaign sales"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_19","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_19"},"text/csv":{"schemaId":"components/schemas/SalesCampaignUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesCampaigns/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesCampaigns/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesCampaigns/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesCampaigns/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesCampaigns/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesCampaigns/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesCampaigns/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesCampaigns/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1salesCampaigns/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesCampaigns/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesCampaigns/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesCampaigns/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesCampaigns/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesCampaigns/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesCampaigns/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesCampaigns/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesCampaigns/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-campaign-sales/uploadcampaignsales"}],"panels":[]}]},"httpPath":"/salesCampaigns"}],"content":{"contentType":"group","meta":{"name":"upload-campaign-sales"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaign Sales","showPageActions":true},{"nodeType":"markdoc","content":"Campaign sales provides a way to link multiple campaigns to a single sales, sales order or sales offer line. Ordinarily only one campaign can be linked directly but this allows support for any number of campaigns per line."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/salesCampaigns","summary":"Upload list of campaign sales","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-campaign-sales/uploadcampaignsales","deprecated":false}]}]}]}]}},{"type":"group","label":"Currency rates","link":"/upload-currency-rates","routeSlug":"/upload-currency-rates","items":[{"label":"Upload list of currency rates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-currency-rates/uploadcurrencyrates","routeSlug":"/upload-currency-rates/uploadcurrencyrates","metadata":{"seo":{"title":"Upload list of currency rates","description":"POST https://api.zoined.com/currencyRates?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCurrencyRates","name":"Upload list of currency rates","isWebhook":false,"pointer":"/paths/~1currencyRates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of currency rates","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/currencyRates?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1currencyRates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20"},"text/csv":{"schemaId":"components/schemas/CurrencyRateUploadPayloadCsv"}},"schemaId":"schema_20","pointer":"/paths/~1currencyRates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/currencyRates","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_20"},"text/csv":{"schemaId":"components/schemas/CurrencyRateUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/currencyRates","href":"/upload-currency-rates/uploadcurrencyrates","openApiOperationId":"uploadCurrencyRates","summary":"Upload list of currency rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_20","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20"},"text/csv":{"schemaId":"components/schemas/CurrencyRateUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1currencyRates/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1currencyRates/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1currencyRates/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1currencyRates/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1currencyRates/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1currencyRates/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error while processing the request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1currencyRates/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1currencyRates/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1currencyRates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1currencyRates/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1currencyRates/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1currencyRates/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1currencyRates/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1currencyRates/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1currencyRates/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1currencyRates/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1currencyRates/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-currency-rates/uploadcurrencyrates"}],"panels":[]}]},"httpPath":"/currencyRates"}],"content":{"contentType":"group","meta":{"name":"upload-currency-rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Currency rates","showPageActions":true},{"nodeType":"markdoc","content":"Currency rates allow you to define internal exchange rates between different currencies in use."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/currencyRates","summary":"Upload list of currency rates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-currency-rates/uploadcurrencyrates","deprecated":false}]}]}]}]}},{"type":"group","label":"Work shifts","link":"/upload-work-shifts","routeSlug":"/upload-work-shifts","items":[{"label":"Upload list of work shifts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-work-shifts/uploadworkshifts","routeSlug":"/upload-work-shifts/uploadworkshifts","metadata":{"seo":{"title":"Upload list of work shifts","description":"POST https://api.zoined.com/workShifts?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadWorkShifts","name":"Upload list of work shifts","isWebhook":false,"pointer":"/paths/~1workShifts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of work shifts","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/workShifts?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1workShifts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21"},"text/csv":{"schemaId":"components/schemas/WorkshiftUploadPayloadCsv"}},"schemaId":"schema_21","pointer":"/paths/~1workShifts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workShifts","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_21"},"text/csv":{"schemaId":"components/schemas/WorkshiftUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/workShifts","href":"/upload-work-shifts/uploadworkshifts","openApiOperationId":"uploadWorkShifts","summary":"Upload list of work shifts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_21","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21"},"text/csv":{"schemaId":"components/schemas/WorkshiftUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1workShifts/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1workShifts/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1workShifts/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1workShifts/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1workShifts/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1workShifts/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1workShifts/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1workShifts/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1workShifts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1workShifts/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1workShifts/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1workShifts/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1workShifts/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1workShifts/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1workShifts/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1workShifts/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1workShifts/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-work-shifts/uploadworkshifts"}],"panels":[]}]},"httpPath":"/workShifts"}],"content":{"contentType":"group","meta":{"name":"upload-work-shifts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Work shifts","showPageActions":true},{"nodeType":"markdoc","content":"Allows you to upload planned of punched work shifts. This is interesting when combined with number of visitors or receipts - are the sales people working during the busiest times?\n\nIf you are also recording breaks, you should send multiple entries per shift and just have suitable absence codes in place. We'll combine the shifts based on shift ids."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workShifts","summary":"Upload list of work shifts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-work-shifts/uploadworkshifts","deprecated":false}]}]}]}]}},{"type":"group","label":"Employee hour entries","link":"/upload-employee-hour-entries","routeSlug":"/upload-employee-hour-entries","items":[{"label":"Upload list of employee hour entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-employee-hour-entries/uploademployeehourentries","routeSlug":"/upload-employee-hour-entries/uploademployeehourentries","metadata":{"seo":{"title":"Upload list of employee hour entries","description":"POST https://api.zoined.com/employeeHours?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadEmployeeHourEntries","name":"Upload list of employee hour entries","isWebhook":false,"pointer":"/paths/~1employeeHours/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of employee hour entries","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/employeeHours?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1employeeHours/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"},"text/csv":{"schemaId":"components/schemas/EmployeeHourUploadPayloadCsv"}},"schemaId":"schema_22","pointer":"/paths/~1employeeHours/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/employeeHours","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22"},"text/csv":{"schemaId":"components/schemas/EmployeeHourUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/employeeHours","href":"/upload-employee-hour-entries/uploademployeehourentries","openApiOperationId":"uploadEmployeeHourEntries","summary":"Upload list of employee hour entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_22","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"},"text/csv":{"schemaId":"components/schemas/EmployeeHourUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1employeeHours/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1employeeHours/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1employeeHours/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1employeeHours/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1employeeHours/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1employeeHours/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1employeeHours/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1employeeHours/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1employeeHours/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1employeeHours/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1employeeHours/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1employeeHours/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1employeeHours/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1employeeHours/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1employeeHours/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1employeeHours/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1employeeHours/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-employee-hour-entries/uploademployeehourentries"}],"panels":[]}]},"httpPath":"/employeeHours"}],"content":{"contentType":"group","meta":{"name":"upload-employee-hour-entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employee hour entries","showPageActions":true},{"nodeType":"markdoc","content":"Allows you to upload worked hours for specific time. This is interesting when combined with number of visitors or receipts - are the sales people working during the busiest times?\n\nThis endpoint is intended to be used when you have aggregate level information per minute/hour/day. If your data is consists of workshifts, you should use Workshifts endpoint."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/employeeHours","summary":"Upload list of employee hour entries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-employee-hour-entries/uploademployeehourentries","deprecated":false}]}]}]}]}},{"type":"group","label":"Hourly staff costs","link":"/upload-hourly-staff-costs","routeSlug":"/upload-hourly-staff-costs","items":[{"label":"Upload list of staff cost entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-hourly-staff-costs/uploadhourlystaffcosts","routeSlug":"/upload-hourly-staff-costs/uploadhourlystaffcosts","metadata":{"seo":{"title":"Upload list of staff cost entries","description":"POST https://api.zoined.com/staffCosts?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadHourlyStaffCosts","name":"Upload list of staff cost entries","isWebhook":false,"pointer":"/paths/~1staffCosts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of staff cost entries","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/staffCosts?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1staffCosts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_23"},"text/csv":{"schemaId":"components/schemas/StaffCostUploadPayloadCsv"}},"schemaId":"schema_23","pointer":"/paths/~1staffCosts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/staffCosts","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_23"},"text/csv":{"schemaId":"components/schemas/StaffCostUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/staffCosts","href":"/upload-hourly-staff-costs/uploadhourlystaffcosts","openApiOperationId":"uploadHourlyStaffCosts","summary":"Upload list of staff cost entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_23","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_23"},"text/csv":{"schemaId":"components/schemas/StaffCostUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1staffCosts/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1staffCosts/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1staffCosts/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1staffCosts/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1staffCosts/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1staffCosts/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1staffCosts/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1staffCosts/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1staffCosts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1staffCosts/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1staffCosts/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1staffCosts/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1staffCosts/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1staffCosts/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1staffCosts/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1staffCosts/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1staffCosts/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-hourly-staff-costs/uploadhourlystaffcosts"}],"panels":[]}]},"httpPath":"/staffCosts"}],"content":{"contentType":"group","meta":{"name":"upload-hourly-staff-costs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hourly staff costs","showPageActions":true},{"nodeType":"markdoc","content":"Allows you to upload store, department or sales person level hourly salaries for specific time period.\nThis data is used as fallback method when provided employee hour or work shift data does not have costs included."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/staffCosts","summary":"Upload list of staff cost entries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-hourly-staff-costs/uploadhourlystaffcosts","deprecated":false}]}]}]}]}},{"type":"group","label":"Inventory snapshots","link":"/upload-inventory-snapshots","routeSlug":"/upload-inventory-snapshots","items":[{"label":"Upload list of inventory snapshots","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-inventory-snapshots/uploadinventorysnapshots","routeSlug":"/upload-inventory-snapshots/uploadinventorysnapshots","metadata":{"seo":{"title":"Upload list of inventory snapshots","description":"POST https://api.zoined.com/inventorySnapshots?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadInventorySnapshots","name":"Upload list of inventory snapshots","isWebhook":false,"pointer":"/paths/~1inventorySnapshots/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of inventory snapshots","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/inventorySnapshots?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1inventorySnapshots/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"},"text/csv":{"schemaId":"components/schemas/InventorySnapshotUploadPayloadCsv"}},"schemaId":"schema_24","pointer":"/paths/~1inventorySnapshots/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventorySnapshots","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24"},"text/csv":{"schemaId":"components/schemas/InventorySnapshotUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/inventorySnapshots","href":"/upload-inventory-snapshots/uploadinventorysnapshots","openApiOperationId":"uploadInventorySnapshots","summary":"Upload list of inventory snapshots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_24","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"},"text/csv":{"schemaId":"components/schemas/InventorySnapshotUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1inventorySnapshots/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1inventorySnapshots/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1inventorySnapshots/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1inventorySnapshots/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1inventorySnapshots/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventorySnapshots/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-inventory-snapshots/uploadinventorysnapshots"}],"panels":[]}]},"httpPath":"/inventorySnapshots"}],"content":{"contentType":"group","meta":{"name":"upload-inventory-snapshots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory snapshots","showPageActions":true},{"nodeType":"markdoc","content":"Inventory snapshots are used to provide product inventory saldo at specific point of time."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventorySnapshots","summary":"Upload list of inventory snapshots","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-inventory-snapshots/uploadinventorysnapshots","deprecated":false}]}]}]}]}},{"type":"group","label":"Inventory transactions","link":"/upload-inventory-transactions","routeSlug":"/upload-inventory-transactions","items":[{"label":"Upload list of inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-inventory-transactions/uploadinventorytransactions","routeSlug":"/upload-inventory-transactions/uploadinventorytransactions","metadata":{"seo":{"title":"Upload list of inventory transactions","description":"POST https://api.zoined.com/inventoryTransactions?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadInventoryTransactions","name":"Upload list of inventory transactions","isWebhook":false,"pointer":"/paths/~1inventoryTransactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of inventory transactions","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/inventoryTransactions?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1inventoryTransactions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"},"text/csv":{"schemaId":"components/schemas/InventoryTransactionUploadPayloadCsv"}},"schemaId":"schema_25","pointer":"/paths/~1inventoryTransactions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/inventoryTransactions","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_25"},"text/csv":{"schemaId":"components/schemas/InventoryTransactionUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/inventoryTransactions","href":"/upload-inventory-transactions/uploadinventorytransactions","openApiOperationId":"uploadInventoryTransactions","summary":"Upload list of inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_25","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"},"text/csv":{"schemaId":"components/schemas/InventoryTransactionUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1inventoryTransactions/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1inventoryTransactions/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1inventoryTransactions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1inventoryTransactions/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1inventoryTransactions/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1inventoryTransactions/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-inventory-transactions/uploadinventorytransactions"}],"panels":[]}]},"httpPath":"/inventoryTransactions"}],"content":{"contentType":"group","meta":{"name":"upload-inventory-transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory transactions","showPageActions":true},{"nodeType":"markdoc","content":"Inventory transactions provide information about balance changes in inventories. They allow you to send information when new items have been purchased for inventory, or when existing products have been removed from inventory as waste.\n\nInventory transactions are not used to update inventory saldo values. For that you should use Inventory snapshots."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/inventoryTransactions","summary":"Upload list of inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-inventory-transactions/uploadinventorytransactions","deprecated":false}]}]}]}]}},{"type":"group","label":"Capacity","link":"/upload-capacity","routeSlug":"/upload-capacity","items":[{"label":"Upload list of capacities","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-capacity/uploadcapacity","routeSlug":"/upload-capacity/uploadcapacity","metadata":{"seo":{"title":"Upload list of capacities","description":"POST https://api.zoined.com/capacity?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCapacity","name":"Upload list of capacities","isWebhook":false,"pointer":"/paths/~1capacity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of capacities","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/capacity?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1capacity/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"},"text/csv":{"schemaId":"components/schemas/CapacityUploadPayloadCsv"}},"schemaId":"schema_26","pointer":"/paths/~1capacity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/capacity","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_26"},"text/csv":{"schemaId":"components/schemas/CapacityUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/capacity","href":"/upload-capacity/uploadcapacity","openApiOperationId":"uploadCapacity","summary":"Upload list of capacities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_26","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"},"text/csv":{"schemaId":"components/schemas/CapacityUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1capacity/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1capacity/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1capacity/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1capacity/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1capacity/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1capacity/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1capacity/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1capacity/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1capacity/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1capacity/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1capacity/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1capacity/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1capacity/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1capacity/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1capacity/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1capacity/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1capacity/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-capacity/uploadcapacity"}],"panels":[]}]},"httpPath":"/capacity"}],"content":{"contentType":"group","meta":{"name":"upload-capacity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capacity","showPageActions":true},{"nodeType":"markdoc","content":"Capacities are used to provide details about available capacity for various resources at specific point of time. These could be eg. hotel rooms or event tickets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/capacity","summary":"Upload list of capacities","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-capacity/uploadcapacity","deprecated":false}]}]}]}]}},{"type":"group","label":"Flat hierarchies","link":"/upload-flat-hierarchies","routeSlug":"/upload-flat-hierarchies","items":[{"label":"Upload list of flat hierarchies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-flat-hierarchies/uploadflathierarchies","routeSlug":"/upload-flat-hierarchies/uploadflathierarchies","metadata":{"seo":{"title":"Upload list of flat hierarchies","description":"POST https://api.zoined.com/flatHierarchies?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadFlatHierarchies","name":"Upload list of flat hierarchies","isWebhook":false,"pointer":"/paths/~1flatHierarchies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of flat hierarchies","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/flatHierarchies?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1flatHierarchies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_27"},"text/csv":{"schemaId":"components/schemas/FlatHierarchyUploadPayloadCsv"}},"schemaId":"schema_27","pointer":"/paths/~1flatHierarchies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flatHierarchies","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_27"},"text/csv":{"schemaId":"components/schemas/FlatHierarchyUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/flatHierarchies","href":"/upload-flat-hierarchies/uploadflathierarchies","openApiOperationId":"uploadFlatHierarchies","summary":"Upload list of flat hierarchies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_27","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_27"},"text/csv":{"schemaId":"components/schemas/FlatHierarchyUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1flatHierarchies/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1flatHierarchies/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1flatHierarchies/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1flatHierarchies/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1flatHierarchies/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1flatHierarchies/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1flatHierarchies/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1flatHierarchies/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1flatHierarchies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1flatHierarchies/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1flatHierarchies/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1flatHierarchies/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1flatHierarchies/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1flatHierarchies/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1flatHierarchies/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1flatHierarchies/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1flatHierarchies/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-flat-hierarchies/uploadflathierarchies"}],"panels":[]}]},"httpPath":"/flatHierarchies"}],"content":{"contentType":"group","meta":{"name":"upload-flat-hierarchies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Flat hierarchies","showPageActions":true},{"nodeType":"markdoc","content":"This end point provides way to upload hierarchy information for different entities like products and organisations in \"flat\"-form.\n\nThis means that for each entity its full path in hierarchy is send, and hierarchy tree is build by us based on that."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flatHierarchies","summary":"Upload list of flat hierarchies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-flat-hierarchies/uploadflathierarchies","deprecated":false}]}]}]}]}},{"type":"group","label":"Product hierarchies","link":"/upload-product-hierarchies","routeSlug":"/upload-product-hierarchies","items":[{"label":"Upload list of product categories","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-product-hierarchies/uploadproducthierarchies","routeSlug":"/upload-product-hierarchies/uploadproducthierarchies","metadata":{"seo":{"title":"Upload list of product categories","description":"POST https://api.zoined.com/productHierarchies?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadProductHierarchies","name":"Upload list of product categories","isWebhook":false,"pointer":"/paths/~1productHierarchies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload 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":[{"$$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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/productHierarchies?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1productHierarchies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_28"},"text/csv":{"schemaId":"components/schemas/CategoryUploadPayloadCsv"}},"schemaId":"schema_28","pointer":"/paths/~1productHierarchies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productHierarchies","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_28"},"text/csv":{"schemaId":"components/schemas/CategoryUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/productHierarchies","href":"/upload-product-hierarchies/uploadproducthierarchies","openApiOperationId":"uploadProductHierarchies","summary":"Upload list of product categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_28","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_28"},"text/csv":{"schemaId":"components/schemas/CategoryUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1productHierarchies/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1productHierarchies/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1productHierarchies/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1productHierarchies/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1productHierarchies/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1productHierarchies/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1productHierarchies/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1productHierarchies/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1productHierarchies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1productHierarchies/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1productHierarchies/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1productHierarchies/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1productHierarchies/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1productHierarchies/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1productHierarchies/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1productHierarchies/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1productHierarchies/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-product-hierarchies/uploadproducthierarchies"}],"panels":[]}]},"httpPath":"/productHierarchies"}],"content":{"contentType":"group","meta":{"name":"upload-product-hierarchies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product hierarchies","showPageActions":true},{"nodeType":"markdoc","content":"Product hierarchies provide a way to assign products into categories and subcategories."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/productHierarchies","summary":"Upload list of product categories","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-product-hierarchies/uploadproducthierarchies","deprecated":false}]}]}]}]}},{"type":"group","label":"Rebate codes","link":"/upload-rebate-codes","routeSlug":"/upload-rebate-codes","items":[{"label":"Upload list of rebate codes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-rebate-codes/uploadrebatecodes","routeSlug":"/upload-rebate-codes/uploadrebatecodes","metadata":{"seo":{"title":"Upload list of rebate codes","description":"POST https://api.zoined.com/rebateCodes?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadRebateCodes","name":"Upload list of rebate codes","isWebhook":false,"pointer":"/paths/~1rebateCodes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of rebate 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/rebateCodes?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1rebateCodes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"},"text/csv":{"schemaId":"components/schemas/RebateCodeUploadPayloadCsv"}},"schemaId":"schema_29","pointer":"/paths/~1rebateCodes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/rebateCodes","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29"},"text/csv":{"schemaId":"components/schemas/RebateCodeUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/rebateCodes","href":"/upload-rebate-codes/uploadrebatecodes","openApiOperationId":"uploadRebateCodes","summary":"Upload list of rebate codes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_29","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"},"text/csv":{"schemaId":"components/schemas/RebateCodeUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1rebateCodes/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1rebateCodes/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1rebateCodes/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1rebateCodes/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1rebateCodes/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1rebateCodes/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1rebateCodes/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1rebateCodes/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1rebateCodes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1rebateCodes/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1rebateCodes/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1rebateCodes/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1rebateCodes/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1rebateCodes/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1rebateCodes/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1rebateCodes/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1rebateCodes/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-rebate-codes/uploadrebatecodes"}],"panels":[]}]},"httpPath":"/rebateCodes"}],"content":{"contentType":"group","meta":{"name":"upload-rebate-codes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rebate codes","showPageActions":true},{"nodeType":"markdoc","content":"The rebate codes can be used to describe reason for giving rebate on sales transactions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/rebateCodes","summary":"Upload list of rebate codes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-rebate-codes/uploadrebatecodes","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment types","link":"/upload-payment-types","routeSlug":"/upload-payment-types","items":[{"label":"Upload list of payment types","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-payment-types/uploadpaymenttypes","routeSlug":"/upload-payment-types/uploadpaymenttypes","metadata":{"seo":{"title":"Upload list of payment types","description":"POST https://api.zoined.com/paymentTypes?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadPaymentTypes","name":"Upload list of payment types","isWebhook":false,"pointer":"/paths/~1paymentTypes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of payment types","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/paymentTypes?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1paymentTypes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_30"},"text/csv":{"schemaId":"components/schemas/PaymentTypeUploadPayloadCsv"}},"schemaId":"schema_30","pointer":"/paths/~1paymentTypes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paymentTypes","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_30"},"text/csv":{"schemaId":"components/schemas/PaymentTypeUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/paymentTypes","href":"/upload-payment-types/uploadpaymenttypes","openApiOperationId":"uploadPaymentTypes","summary":"Upload list of payment types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_30","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_30"},"text/csv":{"schemaId":"components/schemas/PaymentTypeUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1paymentTypes/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1paymentTypes/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1paymentTypes/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1paymentTypes/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1paymentTypes/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1paymentTypes/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1paymentTypes/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1paymentTypes/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1paymentTypes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1paymentTypes/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1paymentTypes/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1paymentTypes/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1paymentTypes/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1paymentTypes/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1paymentTypes/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1paymentTypes/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1paymentTypes/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-payment-types/uploadpaymenttypes"}],"panels":[]}]},"httpPath":"/paymentTypes"}],"content":{"contentType":"group","meta":{"name":"upload-payment-types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment types","showPageActions":true},{"nodeType":"markdoc","content":"Payment types provide attributes for payment methods used in sales transactions and/or payments."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/paymentTypes","summary":"Upload list of payment types","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-payment-types/uploadpaymenttypes","deprecated":false}]}]}]}]}},{"type":"group","label":"Purchase orders","link":"/upload-purchase-orders","routeSlug":"/upload-purchase-orders","items":[{"label":"Upload list of purchase orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-purchase-orders/uploadpurchaseorders","routeSlug":"/upload-purchase-orders/uploadpurchaseorders","metadata":{"seo":{"title":"Upload list of purchase orders","description":"POST https://api.zoined.com/purchaseOrders?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadPurchaseOrders","name":"Upload list of purchase orders","isWebhook":false,"pointer":"/paths/~1purchaseOrders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of purchase 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/purchaseOrders?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1purchaseOrders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"},"text/csv":{"schemaId":"components/schemas/PurchaseOrdersUploadPayloadCsv"}},"schemaId":"schema_31","pointer":"/paths/~1purchaseOrders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/purchaseOrders","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_31"},"text/csv":{"schemaId":"components/schemas/PurchaseOrdersUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/purchaseOrders","href":"/upload-purchase-orders/uploadpurchaseorders","openApiOperationId":"uploadPurchaseOrders","summary":"Upload list of purchase orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_31","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_31"},"text/csv":{"schemaId":"components/schemas/PurchaseOrdersUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1purchaseOrders/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1purchaseOrders/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1purchaseOrders/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1purchaseOrders/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1purchaseOrders/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1purchaseOrders/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1purchaseOrders/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1purchaseOrders/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1purchaseOrders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1purchaseOrders/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1purchaseOrders/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1purchaseOrders/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1purchaseOrders/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1purchaseOrders/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1purchaseOrders/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1purchaseOrders/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1purchaseOrders/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-purchase-orders/uploadpurchaseorders"}],"panels":[]}]},"httpPath":"/purchaseOrders"}],"content":{"contentType":"group","meta":{"name":"upload-purchase-orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Purchase orders","showPageActions":true},{"nodeType":"markdoc","content":"This end point can be used to record purchase orders into Zoined service."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/purchaseOrders","summary":"Upload list of purchase orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-purchase-orders/uploadpurchaseorders","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales offers","link":"/upload-sales-offers","routeSlug":"/upload-sales-offers","items":[{"label":"Upload list of sales offers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-sales-offers/uploadsalesoffers","routeSlug":"/upload-sales-offers/uploadsalesoffers","metadata":{"seo":{"title":"Upload list of sales offers","description":"POST https://api.zoined.com/salesOffers?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadSalesOffers","name":"Upload list of sales offers","isWebhook":false,"pointer":"/paths/~1salesOffers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of sales offers","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/salesOffers?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1salesOffers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_32"},"text/csv":{"schemaId":"components/schemas/SalesOffersUploadPayloadCsv"}},"schemaId":"schema_32","pointer":"/paths/~1salesOffers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/salesOffers","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_32"},"text/csv":{"schemaId":"components/schemas/SalesOffersUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/salesOffers","href":"/upload-sales-offers/uploadsalesoffers","openApiOperationId":"uploadSalesOffers","summary":"Upload list of sales offers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_32","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_32"},"text/csv":{"schemaId":"components/schemas/SalesOffersUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesOffers/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesOffers/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOffers/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOffers/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesOffers/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesOffers/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOffers/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOffers/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1salesOffers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesOffers/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesOffers/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOffers/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOffers/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesOffers/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesOffers/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOffers/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOffers/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-sales-offers/uploadsalesoffers"}],"panels":[]}]},"httpPath":"/salesOffers"}],"content":{"contentType":"group","meta":{"name":"upload-sales-offers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales offers","showPageActions":true},{"nodeType":"markdoc","content":"This end point can be used to record sales offers into Zoined service. Offers can be linked to sales orders."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/salesOffers","summary":"Upload list of sales offers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-sales-offers/uploadsalesoffers","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales orders","link":"/upload-sales-orders","routeSlug":"/upload-sales-orders","items":[{"label":"Upload list of sales orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-sales-orders/uploadsalesorders","routeSlug":"/upload-sales-orders/uploadsalesorders","metadata":{"seo":{"title":"Upload list of sales orders","description":"POST https://api.zoined.com/salesOrders?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadSalesOrders","name":"Upload list of sales orders","isWebhook":false,"pointer":"/paths/~1salesOrders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of sales 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/salesOrders?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1salesOrders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_33"},"text/csv":{"schemaId":"components/schemas/SalesOrdersUploadPayloadCsv"}},"schemaId":"schema_33","pointer":"/paths/~1salesOrders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/salesOrders","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_33"},"text/csv":{"schemaId":"components/schemas/SalesOrdersUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/salesOrders","href":"/upload-sales-orders/uploadsalesorders","openApiOperationId":"uploadSalesOrders","summary":"Upload list of sales orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_33","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_33"},"text/csv":{"schemaId":"components/schemas/SalesOrdersUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesOrders/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesOrders/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOrders/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOrders/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesOrders/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesOrders/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOrders/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOrders/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1salesOrders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesOrders/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesOrders/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOrders/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOrders/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesOrders/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesOrders/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOrders/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesOrders/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-sales-orders/uploadsalesorders"}],"panels":[]}]},"httpPath":"/salesOrders"}],"content":{"contentType":"group","meta":{"name":"upload-sales-orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales orders","showPageActions":true},{"nodeType":"markdoc","content":"This end point can be used to record sales orders into Zoined service."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/salesOrders","summary":"Upload list of sales orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-sales-orders/uploadsalesorders","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales summary","link":"/upload-sales-summary","routeSlug":"/upload-sales-summary","items":[{"label":"Upload sales summaries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-sales-summary/uploadsalessummary","routeSlug":"/upload-sales-summary/uploadsalessummary","metadata":{"seo":{"title":"Upload sales summaries","description":"POST https://api.zoined.com/salesSummaries?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadSalesSummary","name":"Upload sales summaries","isWebhook":false,"pointer":"/paths/~1salesSummaries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload sales summaries","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/salesSummaries?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1salesSummaries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_34"},"text/csv":{"schemaId":"components/schemas/SalesSummaryUploadPayloadCsv"}},"schemaId":"schema_34","pointer":"/paths/~1salesSummaries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/salesSummaries","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_34"},"text/csv":{"schemaId":"components/schemas/SalesSummaryUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/salesSummaries","href":"/upload-sales-summary/uploadsalessummary","openApiOperationId":"uploadSalesSummary","summary":"Upload sales summaries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_34","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_34"},"text/csv":{"schemaId":"components/schemas/SalesSummaryUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesSummaries/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesSummaries/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesSummaries/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesSummaries/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesSummaries/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesSummaries/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesSummaries/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesSummaries/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1salesSummaries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesSummaries/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesSummaries/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesSummaries/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesSummaries/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesSummaries/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesSummaries/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesSummaries/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesSummaries/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-sales-summary/uploadsalessummary"}],"panels":[]}]},"httpPath":"/salesSummaries"}],"content":{"contentType":"group","meta":{"name":"upload-sales-summary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales summary","showPageActions":true},{"nodeType":"markdoc","content":"Sales Summary is a reduced, simplified data set that can be used instead of the detailed endpoints.\n\nIt allows demoing Zoined with own, aggregated data, or can be used in production environment when the more detailed data set is not required or available."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/salesSummaries","summary":"Upload sales summaries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-sales-summary/uploadsalessummary","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales payment","link":"/upload-sales-payment","routeSlug":"/upload-sales-payment","items":[{"label":"Upload sales payments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-sales-payment/uploadsalespayment","routeSlug":"/upload-sales-payment/uploadsalespayment","metadata":{"seo":{"title":"Upload sales payments","description":"POST https://api.zoined.com/salesPayments?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadSalesPayment","name":"Upload sales payments","isWebhook":false,"pointer":"/paths/~1salesPayments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload sales 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/salesPayments?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1salesPayments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_35"},"text/csv":{"schemaId":"components/schemas/SalesPaymentUploadPayloadCsv"}},"schemaId":"schema_35","pointer":"/paths/~1salesPayments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/salesPayments","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_35"},"text/csv":{"schemaId":"components/schemas/SalesPaymentUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/salesPayments","href":"/upload-sales-payment/uploadsalespayment","openApiOperationId":"uploadSalesPayment","summary":"Upload sales payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_35","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_35"},"text/csv":{"schemaId":"components/schemas/SalesPaymentUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesPayments/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesPayments/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPayments/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPayments/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesPayments/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesPayments/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPayments/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPayments/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1salesPayments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesPayments/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1salesPayments/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPayments/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPayments/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesPayments/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1salesPayments/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPayments/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1salesPayments/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-sales-payment/uploadsalespayment"}],"panels":[]}]},"httpPath":"/salesPayments"}],"content":{"contentType":"group","meta":{"name":"upload-sales-payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales payment","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":"Sales payment can be used to send payment data for sales receipts since payment data with multiple payment types per receipt does not mix well with receipt row level transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summed sales values from payment receipts should of course correspond to line item level sum in sales data and transaction_id should be the same as corresponding sales receipt transaction_id so that we can match them together when needed."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/salesPayments","summary":"Upload sales payments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-sales-payment/uploadsalespayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Giftcard Payments","link":"/upload-giftcard-payments","routeSlug":"/upload-giftcard-payments","items":[{"label":"Upload list of giftcard payments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-giftcard-payments/uploadgiftcardpayments","routeSlug":"/upload-giftcard-payments/uploadgiftcardpayments","metadata":{"seo":{"title":"Upload list of giftcard payments","description":"POST https://api.zoined.com/giftcardPayments?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadGiftcardPayments","name":"Upload list of giftcard payments","isWebhook":false,"pointer":"/paths/~1giftcardPayments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of giftcard 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/giftcardPayments?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1giftcardPayments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_36"},"text/csv":{"schemaId":"components/schemas/GiftcardPaymentUploadPayloadCsv"}},"schemaId":"schema_36","pointer":"/paths/~1giftcardPayments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftcardPayments","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_36"},"text/csv":{"schemaId":"components/schemas/GiftcardPaymentUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/giftcardPayments","href":"/upload-giftcard-payments/uploadgiftcardpayments","openApiOperationId":"uploadGiftcardPayments","summary":"Upload list of giftcard payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_36","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_36"},"text/csv":{"schemaId":"components/schemas/GiftcardPaymentUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1giftcardPayments/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1giftcardPayments/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1giftcardPayments/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1giftcardPayments/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1giftcardPayments/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1giftcardPayments/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1giftcardPayments/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1giftcardPayments/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1giftcardPayments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1giftcardPayments/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1giftcardPayments/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1giftcardPayments/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1giftcardPayments/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1giftcardPayments/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1giftcardPayments/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1giftcardPayments/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1giftcardPayments/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-giftcard-payments/uploadgiftcardpayments"}],"panels":[]}]},"httpPath":"/giftcardPayments"}],"content":{"contentType":"group","meta":{"name":"upload-giftcard-payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Giftcard Payments","showPageActions":true},{"nodeType":"markdoc","content":"Giftcard Payments can be used to send giftcard payments data for sales transactions involving gift cards as a payment method.\n\nIt streamlines the management of giftcard payment information and usage, ensuring accuracy and consistency in sales records."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/giftcardPayments","summary":"Upload list of giftcard payments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-giftcard-payments/uploadgiftcardpayments","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounting","link":"/upload-accounting","routeSlug":"/upload-accounting","items":[{"label":"Upload accounting data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-accounting/uploadaccounting","routeSlug":"/upload-accounting/uploadaccounting","metadata":{"seo":{"title":"Upload accounting data","description":"POST https://api.zoined.com/accounting?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadAccounting","name":"Upload accounting data","isWebhook":false,"pointer":"/paths/~1accounting/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload accounting 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/accounting?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1accounting/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_37"},"text/csv":{"schemaId":"components/schemas/AccountingUploadPayloadCsv"}},"schemaId":"schema_37","pointer":"/paths/~1accounting/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounting","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_37"},"text/csv":{"schemaId":"components/schemas/AccountingUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/accounting","href":"/upload-accounting/uploadaccounting","openApiOperationId":"uploadAccounting","summary":"Upload accounting data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_37","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_37"},"text/csv":{"schemaId":"components/schemas/AccountingUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1accounting/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1accounting/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounting/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounting/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1accounting/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1accounting/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounting/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounting/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1accounting/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1accounting/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1accounting/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounting/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounting/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1accounting/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1accounting/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounting/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1accounting/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-accounting/uploadaccounting"}],"panels":[]}]},"httpPath":"/accounting"}],"content":{"contentType":"group","meta":{"name":"upload-accounting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting","showPageActions":true},{"nodeType":"markdoc","content":"Accounting can be used to send account level information (receipts) about operational income and costs of running the company.\n\nThis information is used to eg. to calculate various margins usually found in profit loss statements."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounting","summary":"Upload accounting data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-accounting/uploadaccounting","deprecated":false}]}]}]}]}},{"type":"group","label":"Bookings","link":"/upload-bookings","routeSlug":"/upload-bookings","items":[{"label":"Upload list of bookings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-bookings/uploadbookings","routeSlug":"/upload-bookings/uploadbookings","metadata":{"seo":{"title":"Upload list of bookings","description":"POST https://api.zoined.com/bookings?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadBookings","name":"Upload list of bookings","isWebhook":false,"pointer":"/paths/~1bookings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of bookings","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/bookings?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1bookings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_38"},"text/csv":{"schemaId":"components/schemas/BookingUploadPayloadCsv"}},"schemaId":"schema_38","pointer":"/paths/~1bookings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bookings","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_38"},"text/csv":{"schemaId":"components/schemas/BookingUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/bookings","href":"/upload-bookings/uploadbookings","openApiOperationId":"uploadBookings","summary":"Upload list of bookings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_38","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_38"},"text/csv":{"schemaId":"components/schemas/BookingUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1bookings/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1bookings/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1bookings/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1bookings/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1bookings/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1bookings/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1bookings/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1bookings/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1bookings/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1bookings/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1bookings/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1bookings/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1bookings/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1bookings/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1bookings/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1bookings/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1bookings/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-bookings/uploadbookings"}],"panels":[]}]},"httpPath":"/bookings"}],"content":{"contentType":"group","meta":{"name":"upload-bookings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bookings","showPageActions":true},{"nodeType":"markdoc","content":"This end point can be used to record bookings into Zoined service."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bookings","summary":"Upload list of bookings","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-bookings/uploadbookings","deprecated":false}]}]}]}]}},{"type":"group","label":"Suppliers","link":"/upload-suppliers","routeSlug":"/upload-suppliers","items":[{"label":"Upload list of suppliers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-suppliers/uploadsuppliers","routeSlug":"/upload-suppliers/uploadsuppliers","metadata":{"seo":{"title":"Upload list of suppliers","description":"POST https://api.zoined.com/suppliers?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadSuppliers","name":"Upload list of suppliers","isWebhook":false,"pointer":"/paths/~1suppliers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/suppliers?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1suppliers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"},"text/csv":{"schemaId":"components/schemas/SupplierUploadPayloadCsv"}},"schemaId":"schema_39","pointer":"/paths/~1suppliers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/suppliers","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_39"},"text/csv":{"schemaId":"components/schemas/SupplierUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/suppliers","href":"/upload-suppliers/uploadsuppliers","openApiOperationId":"uploadSuppliers","summary":"Upload list of suppliers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_39","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"},"text/csv":{"schemaId":"components/schemas/SupplierUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1suppliers/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1suppliers/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1suppliers/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1suppliers/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1suppliers/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1suppliers/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1suppliers/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1suppliers/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1suppliers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1suppliers/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1suppliers/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1suppliers/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1suppliers/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1suppliers/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1suppliers/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1suppliers/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1suppliers/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-suppliers/uploadsuppliers"}],"panels":[]}]},"httpPath":"/suppliers"}],"content":{"contentType":"group","meta":{"name":"upload-suppliers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Suppliers","showPageActions":true},{"nodeType":"markdoc","content":"The party that sells your organisation the goods or merchandise."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/suppliers","summary":"Upload list of suppliers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-suppliers/uploadsuppliers","deprecated":false}]}]}]}]}},{"type":"group","label":"Visitors","link":"/upload-visitors","routeSlug":"/upload-visitors","items":[{"label":"Upload list of visitors","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-visitors/uploadvisitors","routeSlug":"/upload-visitors/uploadvisitors","metadata":{"seo":{"title":"Upload list of visitors","description":"POST https://api.zoined.com/visitors?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadVisitors","name":"Upload list of visitors","isWebhook":false,"pointer":"/paths/~1visitors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of visitors","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/visitors?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1visitors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40"},"text/csv":{"schemaId":"components/schemas/VisitorUploadPayloadCsv"}},"schemaId":"schema_40","pointer":"/paths/~1visitors/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/visitors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_40"},"text/csv":{"schemaId":"components/schemas/VisitorUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/visitors","href":"/upload-visitors/uploadvisitors","openApiOperationId":"uploadVisitors","summary":"Upload list of visitors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_40","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40"},"text/csv":{"schemaId":"components/schemas/VisitorUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1visitors/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1visitors/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitors/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitors/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1visitors/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1visitors/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitors/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitors/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1visitors/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1visitors/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1visitors/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitors/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitors/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1visitors/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1visitors/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitors/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitors/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-visitors/uploadvisitors"}],"panels":[]}]},"httpPath":"/visitors"}],"content":{"contentType":"group","meta":{"name":"upload-visitors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Visitors","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":"Visitor count information from anti-theft gates or camera systems. Five different types of visitors can be reported: visitors coming in, visitors going out, visitors passing by, visitor average occupancy and visitor average visit time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also send data for visiting cars & bicycles for all of these five metrics but default is people."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visitor data can be sent either on store or department level. If department is empty visitors are considered to be entering/leaving/passing/visiting store. If department is specified then visitor entry is considered to be person moving inside the store."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When showing visitor counts on portal store-level visitor counts are used, unless data is viewed on department level."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/visitors","summary":"Upload list of visitors","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-visitors/uploadvisitors","deprecated":false}]}]}]}]}},{"type":"group","label":"Visitor demographics","link":"/upload-visitor-demographics","routeSlug":"/upload-visitor-demographics","items":[{"label":"Upload list of visitor demographics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-visitor-demographics/uploadvisitordemographics","routeSlug":"/upload-visitor-demographics/uploadvisitordemographics","metadata":{"seo":{"title":"Upload list of visitor demographics","description":"POST https://api.zoined.com/visitorDemographics?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadVisitorDemographics","name":"Upload list of visitor demographics","isWebhook":false,"pointer":"/paths/~1visitorDemographics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of visitor demographics","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/visitorDemographics?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1visitorDemographics/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41"},"text/csv":{"schemaId":"components/schemas/VisitorDemographicsUploadPayloadCsv"}},"schemaId":"schema_41","pointer":"/paths/~1visitorDemographics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/visitorDemographics","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_41"},"text/csv":{"schemaId":"components/schemas/VisitorDemographicsUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/visitorDemographics","href":"/upload-visitor-demographics/uploadvisitordemographics","openApiOperationId":"uploadVisitorDemographics","summary":"Upload list of visitor demographics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_41","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41"},"text/csv":{"schemaId":"components/schemas/VisitorDemographicsUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1visitorDemographics/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1visitorDemographics/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitorDemographics/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitorDemographics/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1visitorDemographics/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1visitorDemographics/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitorDemographics/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitorDemographics/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1visitorDemographics/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1visitorDemographics/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1visitorDemographics/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitorDemographics/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitorDemographics/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1visitorDemographics/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1visitorDemographics/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitorDemographics/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1visitorDemographics/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-visitor-demographics/uploadvisitordemographics"}],"panels":[]}]},"httpPath":"/visitorDemographics"}],"content":{"contentType":"group","meta":{"name":"upload-visitor-demographics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Visitor demographics","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":"Visitor demographics endpoint can be used to send data for detected visitor's age and gender."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Demographic data is usually obtained with different (camera) system, and only for part of the visitors. This API endpoint allows sending of the data separately, so that we can then combine data with visitor information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our analytics backend will use combined data to project gender & age group estimates into actual visitor counts."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/visitorDemographics","summary":"Upload list of visitor demographics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-visitor-demographics/uploadvisitordemographics","deprecated":false}]}]}]}]}},{"type":"group","label":"Id mapping","link":"/upload-id-mapping","routeSlug":"/upload-id-mapping","items":[{"label":"Upload list of identifier mappings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-id-mapping/uploadidmapping","routeSlug":"/upload-id-mapping/uploadidmapping","metadata":{"seo":{"title":"Upload list of identifier mappings","description":"POST https://api.zoined.com/idMapping?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadIdMapping","name":"Upload list of identifier mappings","isWebhook":false,"pointer":"/paths/~1idMapping/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of identifier mappings","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/idMapping?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1idMapping/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_42"},"text/csv":{"schemaId":"components/schemas/IdMappingUploadPayloadCsv"}},"schemaId":"schema_42","pointer":"/paths/~1idMapping/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idMapping","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_42"},"text/csv":{"schemaId":"components/schemas/IdMappingUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/idMapping","href":"/upload-id-mapping/uploadidmapping","openApiOperationId":"uploadIdMapping","summary":"Upload list of identifier mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_42","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_42"},"text/csv":{"schemaId":"components/schemas/IdMappingUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1idMapping/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1idMapping/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1idMapping/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1idMapping/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1idMapping/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1idMapping/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1idMapping/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1idMapping/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1idMapping/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1idMapping/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1idMapping/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1idMapping/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1idMapping/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1idMapping/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1idMapping/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1idMapping/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1idMapping/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-id-mapping/uploadidmapping"}],"panels":[]}]},"httpPath":"/idMapping"}],"content":{"contentType":"group","meta":{"name":"upload-id-mapping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Id mapping","showPageActions":true},{"nodeType":"markdoc","content":"ID Mapping allows you to define mappings between identifiers in different source systems and the master data.\n\nThis allows you to link data between different systems so that they can be correlated and shown in sensible way in Zoined Analytics Portal."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idMapping","summary":"Upload list of identifier mappings","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-id-mapping/uploadidmapping","deprecated":false}]}]}]}]}},{"type":"group","label":"Budgets","link":"/upload-budgets","routeSlug":"/upload-budgets","items":[{"label":"Upload list of budget entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-budgets/uploadbudgets","routeSlug":"/upload-budgets/uploadbudgets","metadata":{"seo":{"title":"Upload list of budget entries","description":"POST https://api.zoined.com/budgets/budget?dryRun=false&isoWeeks=true"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadBudgets","name":"Upload list of budget entries","isWebhook":false,"pointer":"/paths/~1budgets~1{type}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload list of budget entries","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/budgets/budget?dryRun=false&isoWeeks=true"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"type","in":"path","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type for the budget. Currently supported types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forecast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"budget"}],"pointer":"/paths/~1budgets~1{type}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"isoWeeks","in":"query","schemaId":"schema_0","description":"For weekly budgets whether to use ISO 8610 weeks or US weeks (default true).","example":"true"},{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"}],"pointer":"/paths/~1budgets~1{type}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43","pointer":"/paths/~1budgets~1{type}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/budgets/{type}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[{"name":"type","in":"path","required":true,"example":"budget","schemaId":"schema_1"}],"query":[{"name":"isoWeeks","in":"query","required":false,"example":"true","schemaId":"schema_0"},{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_43"}},"responseCodes":["200","400","401","500"],"pointer":"/budgets/{type}","href":"/upload-budgets/uploadbudgets","openApiOperationId":"uploadBudgets","summary":"Upload list of budget entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1budgets~1{type}/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1budgets~1{type}/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1budgets~1{type}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1budgets~1{type}/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1budgets~1{type}/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1budgets~1{type}/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-budgets/uploadbudgets"}],"panels":[]}]},"httpPath":"/budgets/{type}"}],"content":{"contentType":"group","meta":{"name":"upload-budgets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Budgets","showPageActions":true},{"nodeType":"markdoc","content":"Budget end point allows you to upload budgets for individual metrics at the with selected level of granularity.\n\nYou can for example send daily budget per store and monthly forecasts per category for sales value."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/budgets/{type}","summary":"Upload list of budget entries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-budgets/uploadbudgets","deprecated":false}]}]}]}]}},{"type":"group","label":"Last updated","link":"/upload-last-updated","routeSlug":"/upload-last-updated","items":[{"label":"Upload last updated time stamps","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upload-last-updated/uploadlastupdated","routeSlug":"/upload-last-updated/uploadlastupdated","metadata":{"seo":{"title":"Upload last updated time stamps","description":"POST https://api.zoined.com/updateTime?dryRun=false&separator=%3B&encoding=utf-8"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadLastUpdated","name":"Upload last updated time stamps","isWebhook":false,"pointer":"/paths/~1updateTime/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload last updated time stamps","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/updateTime?dryRun=false&separator=%3B&encoding=utf-8"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dryRun","in":"query","schemaId":"schema_0","description":"Only validate the request without storing the data","required":true,"example":"false"},{"name":"separator","in":"query","schemaId":"schema_1","description":"Column separator used when loading CSV data","required":true,"example":";"},{"name":"encoding","in":"query","schemaId":"schema_1","description":"Character encoding used in the CSV data (default is utf-8)","required":true,"example":"utf-8"}],"pointer":"/paths/~1updateTime/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"},"text/csv":{"schemaId":"components/schemas/UpdateTimeUploadPayloadCsv"}},"schemaId":"schema_44","pointer":"/paths/~1updateTime/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/updateTime","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"dryRun","in":"query","required":true,"example":"false","schemaId":"schema_0"},{"name":"separator","in":"query","required":true,"example":";","schemaId":"schema_1"},{"name":"encoding","in":"query","required":true,"example":"utf-8","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_44"},"text/csv":{"schemaId":"components/schemas/UpdateTimeUploadPayloadCsv"}},"responseCodes":["200","400","401","500"],"pointer":"/updateTime","href":"/upload-last-updated/uploadlastupdated","openApiOperationId":"uploadLastUpdated","summary":"Upload last updated time stamps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_44","mediaTypes":["application/json","text/csv"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"},"text/csv":{"schemaId":"components/schemas/UpdateTimeUploadPayloadCsv"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1updateTime/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1updateTime/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid, malformed or missing JSON-data in request"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1updateTime/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1updateTime/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1updateTime/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1updateTime/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1updateTime/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1updateTime/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1updateTime/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1updateTime/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataUploadSuccessMessage","exampleIds":["paths/~1updateTime/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1updateTime/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1updateTime/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1updateTime/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1updateTime/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1updateTime/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1updateTime/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upload-last-updated/uploadlastupdated"}],"panels":[]}]},"httpPath":"/updateTime"}],"content":{"contentType":"group","meta":{"name":"upload-last-updated"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Last updated","showPageActions":true},{"nodeType":"markdoc","content":"This end point allows you to send information about last update time stamps for different entities you send to Zoined.\n\nAfter uploading entities you can post last update time stamp for each entity here, optionally on store level.\n\nThis information is used to report to end users when certain data set was last updated. Times should be posted in UTC time as they will be converted to user local time zone when presented in portal.\n\nSimilarly entity keys will be localized in user's selected language provided that correct key names are used."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/updateTime","summary":"Upload last updated time stamps","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upload-last-updated/uploadlastupdated","deprecated":false}]}]}]}]}},{"type":"separator","label":"Data download","content":null},{"type":"group","label":"Data download: Introduction","link":"/overview-data-download","routeSlug":"/overview-data-download","items":[],"content":{"contentType":"group","meta":{"name":"overview-data-download"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data download: Introduction","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":"Data download end points provide means for retrieving data from Zoined. This allows"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"building integrations feeding external systems with the data sent to Zoined. Data returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the download end points closely match the structures used while uploading the data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but doesn't always match exactly due to deprecations in upload API and processing on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Zoined system. Each data download end point will contain full list of fields supported."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently we support both JSON and CSV formats for all download end points."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For large downloads windowing should be used to keep individual result sets reasonable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters should be used to control this for each successive request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example with 100000 limit the first request would be with offset 0, next with 100000, then 200000 and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that max limit is hard capped to 1000000 rows per request so tune your parameters accordingly."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/overview-data-download"}],"panels":[]}]}},{"type":"group","label":"Sales transactions","link":"/download-sales-transactions","routeSlug":"/download-sales-transactions","items":[{"label":"Download sales transactions as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-transactions/downloadsalestransactionsjson","routeSlug":"/download-sales-transactions/downloadsalestransactionsjson","metadata":{"seo":{"title":"Download sales transactions as JSON","description":"GET https://api.zoined.com/v2/download/sales.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesTransactionsJson","name":"Download sales transactions as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1sales.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales transactions as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/sales.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return.","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which starting offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1sales.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/sales.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/sales.json","href":"/download-sales-transactions/downloadsalestransactionsjson","openApiOperationId":"downloadSalesTransactionsJson","summary":"Download sales transactions as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_46","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1sales.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_46","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-transactions/downloadsalestransactionsjson"}],"panels":[]}]},"httpPath":"/v2/download/sales.json"},{"label":"Download sales transactions as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-transactions/downloadsalestransactionscsv","routeSlug":"/download-sales-transactions/downloadsalestransactionscsv","metadata":{"seo":{"title":"Download sales transactions as CSV","description":"GET https://api.zoined.com/v2/download/sales.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesTransactionsCsv","name":"Download sales transactions as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1sales.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales transactions as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/sales.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1sales.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/sales.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/sales.csv","href":"/download-sales-transactions/downloadsalestransactionscsv","openApiOperationId":"downloadSalesTransactionsCsv","summary":"Download sales transactions as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1sales.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1sales.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-transactions/downloadsalestransactionscsv"}],"panels":[]}]},"httpPath":"/v2/download/sales.csv"}],"content":{"contentType":"group","meta":{"name":"download-sales-transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales transactions","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":"Returns list of sales transactions in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/sales.json","summary":"Download sales transactions as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-transactions/downloadsalestransactionsjson","deprecated":false},{"title":"/v2/download/sales.csv","summary":"Download sales transactions as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-transactions/downloadsalestransactionscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales orders","link":"/download-sales-orders","routeSlug":"/download-sales-orders","items":[{"label":"Download sales orders as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-orders/downloadsalesordersjson","routeSlug":"/download-sales-orders/downloadsalesordersjson","metadata":{"seo":{"title":"Download sales orders as JSON","description":"GET https://api.zoined.com/v2/download/salesOrders.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesOrdersJson","name":"Download sales orders as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesOrders.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales orders as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesOrders.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"},{"name":"order_status","in":"query","schemaId":"schema_45","description":"Return data with given order status only","example":"3"}],"pointer":"/paths/~1v2~1download~1salesOrders.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesOrders.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"},{"name":"order_status","in":"query","required":false,"example":"3","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesOrders.json","href":"/download-sales-orders/downloadsalesordersjson","openApiOperationId":"downloadSalesOrdersJson","summary":"Download sales orders as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_47","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesOrders.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_47","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-orders/downloadsalesordersjson"}],"panels":[]}]},"httpPath":"/v2/download/salesOrders.json"},{"label":"Download sales orders as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-orders/downloadsalesorderscsv","routeSlug":"/download-sales-orders/downloadsalesorderscsv","metadata":{"seo":{"title":"Download sales orders as CSV","description":"GET https://api.zoined.com/v2/download/salesOrders.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesOrdersCsv","name":"Download sales orders as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesOrders.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales orders as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesOrders.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"},{"name":"order_status","in":"query","schemaId":"schema_45","description":"Return data with given order status only","example":"3"}],"pointer":"/paths/~1v2~1download~1salesOrders.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesOrders.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"},{"name":"order_status","in":"query","required":false,"example":"3","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesOrders.csv","href":"/download-sales-orders/downloadsalesorderscsv","openApiOperationId":"downloadSalesOrdersCsv","summary":"Download sales orders as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesOrders.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOrders.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-orders/downloadsalesorderscsv"}],"panels":[]}]},"httpPath":"/v2/download/salesOrders.csv"}],"content":{"contentType":"group","meta":{"name":"download-sales-orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales orders","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":"Returns list of sales orders in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/salesOrders.json","summary":"Download sales orders as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-orders/downloadsalesordersjson","deprecated":false},{"title":"/v2/download/salesOrders.csv","summary":"Download sales orders as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-orders/downloadsalesorderscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales offers","link":"/download-sales-offers","routeSlug":"/download-sales-offers","items":[{"label":"Download sales offers as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-offers/downloadsalesoffersjson","routeSlug":"/download-sales-offers/downloadsalesoffersjson","metadata":{"seo":{"title":"Download sales offers as JSON","description":"GET https://api.zoined.com/v2/download/salesOffers.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&offer_status=3"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesOffersJson","name":"Download sales offers as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesOffers.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales offers as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesOffers.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&offer_status=3"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"},{"name":"offer_status","in":"query","schemaId":"schema_45","description":"Return data with given offer status only","example":"3"}],"pointer":"/paths/~1v2~1download~1salesOffers.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesOffers.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"},{"name":"offer_status","in":"query","required":false,"example":"3","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesOffers.json","href":"/download-sales-offers/downloadsalesoffersjson","openApiOperationId":"downloadSalesOffersJson","summary":"Download sales offers as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_48","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesOffers.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_48","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-offers/downloadsalesoffersjson"}],"panels":[]}]},"httpPath":"/v2/download/salesOffers.json"},{"label":"Download sales offers as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-offers/downloadsalesofferscsv","routeSlug":"/download-sales-offers/downloadsalesofferscsv","metadata":{"seo":{"title":"Download sales offers as CSV","description":"GET https://api.zoined.com/v2/download/salesOffers.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&offer_status=3"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesOffersCsv","name":"Download sales offers as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesOffers.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales offers as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesOffers.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&offer_status=3"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"},{"name":"offer_status","in":"query","schemaId":"schema_45","description":"Return data with given offer status only","example":"3"}],"pointer":"/paths/~1v2~1download~1salesOffers.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesOffers.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"},{"name":"offer_status","in":"query","required":false,"example":"3","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesOffers.csv","href":"/download-sales-offers/downloadsalesofferscsv","openApiOperationId":"downloadSalesOffersCsv","summary":"Download sales offers as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesOffers.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesOffers.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-offers/downloadsalesofferscsv"}],"panels":[]}]},"httpPath":"/v2/download/salesOffers.csv"}],"content":{"contentType":"group","meta":{"name":"download-sales-offers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales offers","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":"Returns list of sales offers in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/salesOffers.json","summary":"Download sales offers as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-offers/downloadsalesoffersjson","deprecated":false},{"title":"/v2/download/salesOffers.csv","summary":"Download sales offers as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-offers/downloadsalesofferscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Purchase orders","link":"/download-purchase-orders","routeSlug":"/download-purchase-orders","items":[{"label":"Download purchase orders as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-purchase-orders/downloadpurchaseordersjson","routeSlug":"/download-purchase-orders/downloadpurchaseordersjson","metadata":{"seo":{"title":"Download purchase orders as JSON","description":"GET https://api.zoined.com/v2/download/purchaseOrders.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPurchaseOrdersJson","name":"Download purchase orders as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1purchaseOrders.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download purchase orders as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/purchaseOrders.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"},{"name":"order_status","in":"query","schemaId":"schema_45","description":"Return data with given order status only","example":"3"}],"pointer":"/paths/~1v2~1download~1purchaseOrders.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/purchaseOrders.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"},{"name":"order_status","in":"query","required":false,"example":"3","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/purchaseOrders.json","href":"/download-purchase-orders/downloadpurchaseordersjson","openApiOperationId":"downloadPurchaseOrdersJson","summary":"Download purchase orders as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_49","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1purchaseOrders.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_49","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-purchase-orders/downloadpurchaseordersjson"}],"panels":[]}]},"httpPath":"/v2/download/purchaseOrders.json"},{"label":"Download purchase orders as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-purchase-orders/downloadpurchaseorderscsv","routeSlug":"/download-purchase-orders/downloadpurchaseorderscsv","metadata":{"seo":{"title":"Download purchase orders as CSV","description":"GET https://api.zoined.com/v2/download/purchaseOrders.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPurchaseOrdersCsv","name":"Download purchase orders as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1purchaseOrders.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download purchase orders as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/purchaseOrders.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&order_status=3"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"},{"name":"order_status","in":"query","schemaId":"schema_45","description":"Return data with given order status only","example":"3"}],"pointer":"/paths/~1v2~1download~1purchaseOrders.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/purchaseOrders.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"},{"name":"order_status","in":"query","required":false,"example":"3","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/purchaseOrders.csv","href":"/download-purchase-orders/downloadpurchaseorderscsv","openApiOperationId":"downloadPurchaseOrdersCsv","summary":"Download purchase orders as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1purchaseOrders.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1purchaseOrders.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-purchase-orders/downloadpurchaseorderscsv"}],"panels":[]}]},"httpPath":"/v2/download/purchaseOrders.csv"}],"content":{"contentType":"group","meta":{"name":"download-purchase-orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Purchase orders","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":"Returns list of purchase orders in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/purchaseOrders.json","summary":"Download purchase orders as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-purchase-orders/downloadpurchaseordersjson","deprecated":false},{"title":"/v2/download/purchaseOrders.csv","summary":"Download purchase orders as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-purchase-orders/downloadpurchaseorderscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales summaries","link":"/download-sales-summaries","routeSlug":"/download-sales-summaries","items":[{"label":"Download sales summaries as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-summaries/downloadsalessummariesjson","routeSlug":"/download-sales-summaries/downloadsalessummariesjson","metadata":{"seo":{"title":"Download sales summaries as JSON","description":"GET https://api.zoined.com/v2/download/salesSummaries.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesSummariesJson","name":"Download sales summaries as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesSummaries.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales summaries as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesSummaries.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1salesSummaries.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesSummaries.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesSummaries.json","href":"/download-sales-summaries/downloadsalessummariesjson","openApiOperationId":"downloadSalesSummariesJson","summary":"Download sales summaries as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_50","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesSummaries.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-summaries/downloadsalessummariesjson"}],"panels":[]}]},"httpPath":"/v2/download/salesSummaries.json"},{"label":"Download sales summaries as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-summaries/downloadsalessummariescsv","routeSlug":"/download-sales-summaries/downloadsalessummariescsv","metadata":{"seo":{"title":"Download sales summaries as CSV","description":"GET https://api.zoined.com/v2/download/salesSummaries.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesSummariesCsv","name":"Download sales summaries as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesSummaries.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales summaries as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesSummaries.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1salesSummaries.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesSummaries.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesSummaries.csv","href":"/download-sales-summaries/downloadsalessummariescsv","openApiOperationId":"downloadSalesSummariesCsv","summary":"Download sales summaries as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesSummaries.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesSummaries.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-summaries/downloadsalessummariescsv"}],"panels":[]}]},"httpPath":"/v2/download/salesSummaries.csv"}],"content":{"contentType":"group","meta":{"name":"download-sales-summaries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales summaries","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":"Returns list of sales summaries in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/salesSummaries.json","summary":"Download sales summaries as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-summaries/downloadsalessummariesjson","deprecated":false},{"title":"/v2/download/salesSummaries.csv","summary":"Download sales summaries as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-summaries/downloadsalessummariescsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales payments","link":"/download-sales-payments","routeSlug":"/download-sales-payments","items":[{"label":"Download sales payments as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-payments/downloadsalespaymentsjson","routeSlug":"/download-sales-payments/downloadsalespaymentsjson","metadata":{"seo":{"title":"Download sales payments as JSON","description":"GET https://api.zoined.com/v2/download/salesPayments.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesPaymentsJson","name":"Download sales payments as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesPayments.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales payments as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesPayments.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1salesPayments.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesPayments.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesPayments.json","href":"/download-sales-payments/downloadsalespaymentsjson","openApiOperationId":"downloadSalesPaymentsJson","summary":"Download sales payments as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_51","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesPayments.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_51","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-payments/downloadsalespaymentsjson"}],"panels":[]}]},"httpPath":"/v2/download/salesPayments.json"},{"label":"Download sales payments as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-payments/downloadsalespaymentscsv","routeSlug":"/download-sales-payments/downloadsalespaymentscsv","metadata":{"seo":{"title":"Download sales payments as CSV","description":"GET https://api.zoined.com/v2/download/salesPayments.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesPaymentsCsv","name":"Download sales payments as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesPayments.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales payments as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesPayments.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1salesPayments.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesPayments.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesPayments.csv","href":"/download-sales-payments/downloadsalespaymentscsv","openApiOperationId":"downloadSalesPaymentsCsv","summary":"Download sales payments as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesPayments.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPayments.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-payments/downloadsalespaymentscsv"}],"panels":[]}]},"httpPath":"/v2/download/salesPayments.csv"}],"content":{"contentType":"group","meta":{"name":"download-sales-payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales 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":"Returns list of sales payments in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/salesPayments.json","summary":"Download sales payments as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-payments/downloadsalespaymentsjson","deprecated":false},{"title":"/v2/download/salesPayments.csv","summary":"Download sales payments as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-payments/downloadsalespaymentscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Giftcard payments","link":"/download-giftcard-payments","routeSlug":"/download-giftcard-payments","items":[{"label":"Download giftcard payments as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-giftcard-payments/downloadgiftcardpaymentsjson","routeSlug":"/download-giftcard-payments/downloadgiftcardpaymentsjson","metadata":{"seo":{"title":"Download giftcard payments as JSON","description":"GET https://api.zoined.com/v2/download/giftcardPayments.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadGiftcardPaymentsJson","name":"Download giftcard payments as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1giftcardPayments.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download giftcard payments as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/giftcardPayments.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1giftcardPayments.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/giftcardPayments.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/giftcardPayments.json","href":"/download-giftcard-payments/downloadgiftcardpaymentsjson","openApiOperationId":"downloadGiftcardPaymentsJson","summary":"Download giftcard payments as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_52","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1giftcardPayments.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_52","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-giftcard-payments/downloadgiftcardpaymentsjson"}],"panels":[]}]},"httpPath":"/v2/download/giftcardPayments.json"},{"label":"Download giftcard payments as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-giftcard-payments/downloadgiftcardpaymentscsv","routeSlug":"/download-giftcard-payments/downloadgiftcardpaymentscsv","metadata":{"seo":{"title":"Download giftcard payments as CSV","description":"GET https://api.zoined.com/v2/download/giftcardPayments.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadGiftcardPaymentsCsv","name":"Download giftcard payments as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1giftcardPayments.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download giftcard payments as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/giftcardPayments.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1giftcardPayments.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/giftcardPayments.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/giftcardPayments.csv","href":"/download-giftcard-payments/downloadgiftcardpaymentscsv","openApiOperationId":"downloadGiftcardPaymentsCsv","summary":"Download giftcard payments as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1giftcardPayments.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1giftcardPayments.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-giftcard-payments/downloadgiftcardpaymentscsv"}],"panels":[]}]},"httpPath":"/v2/download/giftcardPayments.csv"}],"content":{"contentType":"group","meta":{"name":"download-giftcard-payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Giftcard 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":"Returns list of giftcard payments in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/giftcardPayments.json","summary":"Download giftcard payments as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-giftcard-payments/downloadgiftcardpaymentsjson","deprecated":false},{"title":"/v2/download/giftcardPayments.csv","summary":"Download giftcard payments as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-giftcard-payments/downloadgiftcardpaymentscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Bookings","link":"/download-bookings","routeSlug":"/download-bookings","items":[{"label":"Download bookings as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-bookings/downloadbookingsjson","routeSlug":"/download-bookings/downloadbookingsjson","metadata":{"seo":{"title":"Download bookings as JSON","description":"GET https://api.zoined.com/v2/download/bookings.json?limit=1000&offset=0&start=2021-01-01&end=2021-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadBookingsJson","name":"Download bookings as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1bookings.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download bookings as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/bookings.json?limit=1000&offset=0&start=2021-01-01&end=2021-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2021-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2021-01-31"}],"pointer":"/paths/~1v2~1download~1bookings.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/bookings.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2021-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2021-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/bookings.json","href":"/download-bookings/downloadbookingsjson","openApiOperationId":"downloadBookingsJson","summary":"Download bookings as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_53","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1bookings.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_53","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-bookings/downloadbookingsjson"}],"panels":[]}]},"httpPath":"/v2/download/bookings.json"},{"label":"Download bookings as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-bookings/downloadbookingscsv","routeSlug":"/download-bookings/downloadbookingscsv","metadata":{"seo":{"title":"Download bookings as CSV","description":"GET https://api.zoined.com/v2/download/bookings.csv?limit=1000&offset=0&start=2021-01-01&end=2021-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadBookingsCsv","name":"Download bookings as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1bookings.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download bookings as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/bookings.csv?limit=1000&offset=0&start=2021-01-01&end=2021-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2021-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2021-01-31"}],"pointer":"/paths/~1v2~1download~1bookings.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/bookings.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2021-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2021-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/bookings.csv","href":"/download-bookings/downloadbookingscsv","openApiOperationId":"downloadBookingsCsv","summary":"Download bookings as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1bookings.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1bookings.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-bookings/downloadbookingscsv"}],"panels":[]}]},"httpPath":"/v2/download/bookings.csv"}],"content":{"contentType":"group","meta":{"name":"download-bookings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bookings","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":"Returns list of bookings in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/bookings.json","summary":"Download bookings as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-bookings/downloadbookingsjson","deprecated":false},{"title":"/v2/download/bookings.csv","summary":"Download bookings as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-bookings/downloadbookingscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounting data","link":"/download-accounting-data","routeSlug":"/download-accounting-data","items":[{"label":"Download accounting data as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-accounting-data/downloadaccountingdatajson","routeSlug":"/download-accounting-data/downloadaccountingdatajson","metadata":{"seo":{"title":"Download accounting data as JSON","description":"GET https://api.zoined.com/v2/download/accounting.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadAccountingDataJson","name":"Download accounting data as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1accounting.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download accounting data as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/accounting.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1accounting.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/accounting.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/accounting.json","href":"/download-accounting-data/downloadaccountingdatajson","openApiOperationId":"downloadAccountingDataJson","summary":"Download accounting data as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_54","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1accounting.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_54","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-accounting-data/downloadaccountingdatajson"}],"panels":[]}]},"httpPath":"/v2/download/accounting.json"},{"label":"Download accounting dat as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-accounting-data/downloadaccountingdatacsv","routeSlug":"/download-accounting-data/downloadaccountingdatacsv","metadata":{"seo":{"title":"Download accounting dat as CSV","description":"GET https://api.zoined.com/v2/download/accounting.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadAccountingDataCsv","name":"Download accounting dat as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1accounting.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download accounting dat as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/accounting.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1accounting.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/accounting.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/accounting.csv","href":"/download-accounting-data/downloadaccountingdatacsv","openApiOperationId":"downloadAccountingDataCsv","summary":"Download accounting dat as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1accounting.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounting.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-accounting-data/downloadaccountingdatacsv"}],"panels":[]}]},"httpPath":"/v2/download/accounting.csv"}],"content":{"contentType":"group","meta":{"name":"download-accounting-data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting data","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":"Returns list of accounting data in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/accounting.json","summary":"Download accounting data as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-accounting-data/downloadaccountingdatajson","deprecated":false},{"title":"/v2/download/accounting.csv","summary":"Download accounting dat as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-accounting-data/downloadaccountingdatacsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Cashier balance","link":"/download-cashier-balance","routeSlug":"/download-cashier-balance","items":[{"label":"Download cashier balances as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-cashier-balance/downloadcashierbalancejson","routeSlug":"/download-cashier-balance/downloadcashierbalancejson","metadata":{"seo":{"title":"Download cashier balances as JSON","description":"GET https://api.zoined.com/v2/download/cashierBalance.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCashierBalanceJson","name":"Download cashier balances as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1cashierBalance.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download cashier balances as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/cashierBalance.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1cashierBalance.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/cashierBalance.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/cashierBalance.json","href":"/download-cashier-balance/downloadcashierbalancejson","openApiOperationId":"downloadCashierBalanceJson","summary":"Download cashier balances as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_55","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1cashierBalance.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_55","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-cashier-balance/downloadcashierbalancejson"}],"panels":[]}]},"httpPath":"/v2/download/cashierBalance.json"},{"label":"Download cashier balances as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-cashier-balance/downloadcashierbalancecsv","routeSlug":"/download-cashier-balance/downloadcashierbalancecsv","metadata":{"seo":{"title":"Download cashier balances as CSV","description":"GET https://api.zoined.com/v2/download/cashierBalance.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCashierBalanceCsv","name":"Download cashier balances as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1cashierBalance.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download cashier balances as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/cashierBalance.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1cashierBalance.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/cashierBalance.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/cashierBalance.csv","href":"/download-cashier-balance/downloadcashierbalancecsv","openApiOperationId":"downloadCashierBalanceCsv","summary":"Download cashier balances as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1cashierBalance.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashierBalance.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-cashier-balance/downloadcashierbalancecsv"}],"panels":[]}]},"httpPath":"/v2/download/cashierBalance.csv"}],"content":{"contentType":"group","meta":{"name":"download-cashier-balance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cashier balance","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":"Returns list of cashier balances in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/cashierBalance.json","summary":"Download cashier balances as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-cashier-balance/downloadcashierbalancejson","deprecated":false},{"title":"/v2/download/cashierBalance.csv","summary":"Download cashier balances as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-cashier-balance/downloadcashierbalancecsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Customer feedback","link":"/download-customer-feedback","routeSlug":"/download-customer-feedback","items":[{"label":"Download customer feedback as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-customer-feedback/downloadcustomerfeedbackjson","routeSlug":"/download-customer-feedback/downloadcustomerfeedbackjson","metadata":{"seo":{"title":"Download customer feedback as JSON","description":"GET https://api.zoined.com/v2/download/customerFeedbacks.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCustomerFeedbackJson","name":"Download customer feedback as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1customerFeedbacks.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download customer feedback as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/customerFeedbacks.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1customerFeedbacks.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/customerFeedbacks.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/customerFeedbacks.json","href":"/download-customer-feedback/downloadcustomerfeedbackjson","openApiOperationId":"downloadCustomerFeedbackJson","summary":"Download customer feedback as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_56","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1customerFeedbacks.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_56","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-customer-feedback/downloadcustomerfeedbackjson"}],"panels":[]}]},"httpPath":"/v2/download/customerFeedbacks.json"},{"label":"Download customer feedback as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-customer-feedback/downloadcustomerfeedbackcsv","routeSlug":"/download-customer-feedback/downloadcustomerfeedbackcsv","metadata":{"seo":{"title":"Download customer feedback as CSV","description":"GET https://api.zoined.com/v2/download/customerFeedbacks.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCustomerFeedbackCsv","name":"Download customer feedback as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1customerFeedbacks.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download customer feedback as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/customerFeedbacks.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1customerFeedbacks.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/customerFeedbacks.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/customerFeedbacks.csv","href":"/download-customer-feedback/downloadcustomerfeedbackcsv","openApiOperationId":"downloadCustomerFeedbackCsv","summary":"Download customer feedback as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1customerFeedbacks.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customerFeedbacks.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-customer-feedback/downloadcustomerfeedbackcsv"}],"panels":[]}]},"httpPath":"/v2/download/customerFeedbacks.csv"}],"content":{"contentType":"group","meta":{"name":"download-customer-feedback"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer feedback","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":"Returns list of customer feedback in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/customerFeedbacks.json","summary":"Download customer feedback as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-customer-feedback/downloadcustomerfeedbackjson","deprecated":false},{"title":"/v2/download/customerFeedbacks.csv","summary":"Download customer feedback as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-customer-feedback/downloadcustomerfeedbackcsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Inventory transactions","link":"/download-inventory-transactions","routeSlug":"/download-inventory-transactions","items":[{"label":"Download inventory transactions as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-inventory-transactions/downloadinventorytransactionsjson","routeSlug":"/download-inventory-transactions/downloadinventorytransactionsjson","metadata":{"seo":{"title":"Download inventory transactions as JSON","description":"GET https://api.zoined.com/v2/download/inventoryTransactions.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&movement_type=waste"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadInventoryTransactionsJson","name":"Download inventory transactions as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1inventoryTransactions.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download inventory transactions as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/inventoryTransactions.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&movement_type=waste"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"},{"name":"movement_type","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return data for given movement types only (any of purchase, waste, transfer, stock_take, adjustment)"},"children":[]}]}]}],"example":"waste"}],"pointer":"/paths/~1v2~1download~1inventoryTransactions.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/inventoryTransactions.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"},{"name":"movement_type","in":"query","required":false,"example":"waste","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/inventoryTransactions.json","href":"/download-inventory-transactions/downloadinventorytransactionsjson","openApiOperationId":"downloadInventoryTransactionsJson","summary":"Download inventory transactions as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_57","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1inventoryTransactions.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_57","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-inventory-transactions/downloadinventorytransactionsjson"}],"panels":[]}]},"httpPath":"/v2/download/inventoryTransactions.json"},{"label":"Download inventory transactions as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-inventory-transactions/downloadinventorytransactionscsv","routeSlug":"/download-inventory-transactions/downloadinventorytransactionscsv","metadata":{"seo":{"title":"Download inventory transactions as CSV","description":"GET https://api.zoined.com/v2/download/inventoryTransactions.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&movement_type=waste"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadInventoryTransactionsCsv","name":"Download inventory transactions as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1inventoryTransactions.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download inventory transactions as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/inventoryTransactions.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31&movement_type=waste"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"},{"name":"movement_type","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Return data for given movement types only (any of purchase, waste, transfer, stock_take, adjustment)"},"children":[]}]}]}],"example":"waste"}],"pointer":"/paths/~1v2~1download~1inventoryTransactions.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/inventoryTransactions.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"},{"name":"movement_type","in":"query","required":false,"example":"waste","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/inventoryTransactions.csv","href":"/download-inventory-transactions/downloadinventorytransactionscsv","openApiOperationId":"downloadInventoryTransactionsCsv","summary":"Download inventory transactions as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1inventoryTransactions.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventoryTransactions.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-inventory-transactions/downloadinventorytransactionscsv"}],"panels":[]}]},"httpPath":"/v2/download/inventoryTransactions.csv"}],"content":{"contentType":"group","meta":{"name":"download-inventory-transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory transactions","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":"Returns list of inventory transactions in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/inventoryTransactions.json","summary":"Download inventory transactions as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-inventory-transactions/downloadinventorytransactionsjson","deprecated":false},{"title":"/v2/download/inventoryTransactions.csv","summary":"Download inventory transactions as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-inventory-transactions/downloadinventorytransactionscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Inventory snapshots","link":"/download-inventory-snapshots","routeSlug":"/download-inventory-snapshots","items":[{"label":"Download inventory snapshots as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-inventory-snapshots/downloadinventorysnapshotsjson","routeSlug":"/download-inventory-snapshots/downloadinventorysnapshotsjson","metadata":{"seo":{"title":"Download inventory snapshots as JSON","description":"GET https://api.zoined.com/v2/download/inventorySnapshots.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadInventorySnapshotsJson","name":"Download inventory snapshots as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1inventorySnapshots.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download inventory snapshots as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/inventorySnapshots.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1inventorySnapshots.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/inventorySnapshots.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/inventorySnapshots.json","href":"/download-inventory-snapshots/downloadinventorysnapshotsjson","openApiOperationId":"downloadInventorySnapshotsJson","summary":"Download inventory snapshots as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_58","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1inventorySnapshots.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_58","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-inventory-snapshots/downloadinventorysnapshotsjson"}],"panels":[]}]},"httpPath":"/v2/download/inventorySnapshots.json"},{"label":"Download inventory snapshots as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-inventory-snapshots/downloadinventorysnapshotscsv","routeSlug":"/download-inventory-snapshots/downloadinventorysnapshotscsv","metadata":{"seo":{"title":"Download inventory snapshots as CSV","description":"GET https://api.zoined.com/v2/download/inventorySnapshots.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadInventorySnapshotsCsv","name":"Download inventory snapshots as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1inventorySnapshots.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download inventory snapshots as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/inventorySnapshots.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1inventorySnapshots.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/inventorySnapshots.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/inventorySnapshots.csv","href":"/download-inventory-snapshots/downloadinventorysnapshotscsv","openApiOperationId":"downloadInventorySnapshotsCsv","summary":"Download inventory snapshots as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1inventorySnapshots.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1inventorySnapshots.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-inventory-snapshots/downloadinventorysnapshotscsv"}],"panels":[]}]},"httpPath":"/v2/download/inventorySnapshots.csv"}],"content":{"contentType":"group","meta":{"name":"download-inventory-snapshots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory snapshots","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":"Returns list of inventory snapshots in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/inventorySnapshots.json","summary":"Download inventory snapshots as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-inventory-snapshots/downloadinventorysnapshotsjson","deprecated":false},{"title":"/v2/download/inventorySnapshots.csv","summary":"Download inventory snapshots as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-inventory-snapshots/downloadinventorysnapshotscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Capacity","link":"/download-capacity","routeSlug":"/download-capacity","items":[{"label":"Download capacities as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-capacity/downloadcapacityjson","routeSlug":"/download-capacity/downloadcapacityjson","metadata":{"seo":{"title":"Download capacities as JSON","description":"GET https://api.zoined.com/v2/download/capacity.json?limit=1000&offset=0&start=2021-01-01&end=2021-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCapacityJson","name":"Download capacities as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1capacity.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download capacities as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/capacity.json?limit=1000&offset=0&start=2021-01-01&end=2021-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2021-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2021-01-31"}],"pointer":"/paths/~1v2~1download~1capacity.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/capacity.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2021-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2021-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/capacity.json","href":"/download-capacity/downloadcapacityjson","openApiOperationId":"downloadCapacityJson","summary":"Download capacities as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_59","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1capacity.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_59","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-capacity/downloadcapacityjson"}],"panels":[]}]},"httpPath":"/v2/download/capacity.json"},{"label":"Download capacities as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-capacity/downloadcapacitycsv","routeSlug":"/download-capacity/downloadcapacitycsv","metadata":{"seo":{"title":"Download capacities as CSV","description":"GET https://api.zoined.com/v2/download/capacity.csv?limit=1000&offset=0&start=2021-01-01&end=2021-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCapacityCsv","name":"Download capacities as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1capacity.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download capacities as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/capacity.csv?limit=1000&offset=0&start=2021-01-01&end=2021-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2021-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2021-01-31"}],"pointer":"/paths/~1v2~1download~1capacity.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/capacity.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2021-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2021-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/capacity.csv","href":"/download-capacity/downloadcapacitycsv","openApiOperationId":"downloadCapacityCsv","summary":"Download capacities as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1capacity.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1capacity.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-capacity/downloadcapacitycsv"}],"panels":[]}]},"httpPath":"/v2/download/capacity.csv"}],"content":{"contentType":"group","meta":{"name":"download-capacity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capacity","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":"Returns list of resource capacities in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/capacity.json","summary":"Download capacities as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-capacity/downloadcapacityjson","deprecated":false},{"title":"/v2/download/capacity.csv","summary":"Download capacities as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-capacity/downloadcapacitycsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Visitors","link":"/download-visitors","routeSlug":"/download-visitors","items":[{"label":"Download visitors as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-visitors/downloadvisitorsjson","routeSlug":"/download-visitors/downloadvisitorsjson","metadata":{"seo":{"title":"Download visitors as JSON","description":"GET https://api.zoined.com/v2/download/visitors.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadVisitorsJson","name":"Download visitors as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1visitors.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download visitors as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/visitors.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1visitors.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/visitors.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/visitors.json","href":"/download-visitors/downloadvisitorsjson","openApiOperationId":"downloadVisitorsJson","summary":"Download visitors as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_60","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1visitors.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_60","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-visitors/downloadvisitorsjson"}],"panels":[]}]},"httpPath":"/v2/download/visitors.json"},{"label":"Download visitors as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-visitors/downloadvisitorscsv","routeSlug":"/download-visitors/downloadvisitorscsv","metadata":{"seo":{"title":"Download visitors as CSV","description":"GET https://api.zoined.com/v2/download/visitors.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadVisitorsCsv","name":"Download visitors as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1visitors.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download visitors as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/visitors.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1visitors.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/visitors.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/visitors.csv","href":"/download-visitors/downloadvisitorscsv","openApiOperationId":"downloadVisitorsCsv","summary":"Download visitors as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1visitors.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitors.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-visitors/downloadvisitorscsv"}],"panels":[]}]},"httpPath":"/v2/download/visitors.csv"}],"content":{"contentType":"group","meta":{"name":"download-visitors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Visitors","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":"Returns list of visitors in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/visitors.json","summary":"Download visitors as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-visitors/downloadvisitorsjson","deprecated":false},{"title":"/v2/download/visitors.csv","summary":"Download visitors as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-visitors/downloadvisitorscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Visitor demographics","link":"/download-visitor-demographics","routeSlug":"/download-visitor-demographics","items":[{"label":"Download visitor demographics as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-visitor-demographics/downloadvisitordemographicsjson","routeSlug":"/download-visitor-demographics/downloadvisitordemographicsjson","metadata":{"seo":{"title":"Download visitor demographics as JSON","description":"GET https://api.zoined.com/v2/download/visitorDemographics.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadVisitorDemographicsJson","name":"Download visitor demographics as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1visitorDemographics.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download visitor demographics as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/visitorDemographics.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1visitorDemographics.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/visitorDemographics.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/visitorDemographics.json","href":"/download-visitor-demographics/downloadvisitordemographicsjson","openApiOperationId":"downloadVisitorDemographicsJson","summary":"Download visitor demographics as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_61","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1visitorDemographics.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_61","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-visitor-demographics/downloadvisitordemographicsjson"}],"panels":[]}]},"httpPath":"/v2/download/visitorDemographics.json"},{"label":"Download visitor demographics as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-visitor-demographics/downloadvisitordemographicscsv","routeSlug":"/download-visitor-demographics/downloadvisitordemographicscsv","metadata":{"seo":{"title":"Download visitor demographics as CSV","description":"GET https://api.zoined.com/v2/download/visitorDemographics.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadVisitorDemographicsCsv","name":"Download visitor demographics as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1visitorDemographics.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download visitor demographics as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/visitorDemographics.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1visitorDemographics.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/visitorDemographics.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/visitorDemographics.csv","href":"/download-visitor-demographics/downloadvisitordemographicscsv","openApiOperationId":"downloadVisitorDemographicsCsv","summary":"Download visitor demographics as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1visitorDemographics.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1visitorDemographics.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-visitor-demographics/downloadvisitordemographicscsv"}],"panels":[]}]},"httpPath":"/v2/download/visitorDemographics.csv"}],"content":{"contentType":"group","meta":{"name":"download-visitor-demographics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Visitor demographics","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":"Returns list of visitor demographics in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/visitorDemographics.json","summary":"Download visitor demographics as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-visitor-demographics/downloadvisitordemographicsjson","deprecated":false},{"title":"/v2/download/visitorDemographics.csv","summary":"Download visitor demographics as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-visitor-demographics/downloadvisitordemographicscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Work shifts","link":"/download-work-shifts","routeSlug":"/download-work-shifts","items":[{"label":"Download work shifts as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-work-shifts/downloadworkshiftsjson","routeSlug":"/download-work-shifts/downloadworkshiftsjson","metadata":{"seo":{"title":"Download work shifts as JSON","description":"GET https://api.zoined.com/v2/download/workShifts.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadWorkShiftsJson","name":"Download work shifts as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1workShifts.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download work shifts as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/workShifts.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1workShifts.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/workShifts.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/workShifts.json","href":"/download-work-shifts/downloadworkshiftsjson","openApiOperationId":"downloadWorkShiftsJson","summary":"Download work shifts as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_62","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1workShifts.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-work-shifts/downloadworkshiftsjson"}],"panels":[]}]},"httpPath":"/v2/download/workShifts.json"},{"label":"Download work shifts as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-work-shifts/downloadworkshiftscsv","routeSlug":"/download-work-shifts/downloadworkshiftscsv","metadata":{"seo":{"title":"Download work shifts as CSV","description":"GET https://api.zoined.com/v2/download/workShifts.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadWorkShiftsCsv","name":"Download work shifts as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1workShifts.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download work shifts as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/workShifts.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1workShifts.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/workShifts.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/workShifts.csv","href":"/download-work-shifts/downloadworkshiftscsv","openApiOperationId":"downloadWorkShiftsCsv","summary":"Download work shifts as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1workShifts.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1workShifts.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-work-shifts/downloadworkshiftscsv"}],"panels":[]}]},"httpPath":"/v2/download/workShifts.csv"}],"content":{"contentType":"group","meta":{"name":"download-work-shifts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Work shifts","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":"Returns list of worked shifts in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/workShifts.json","summary":"Download work shifts as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-work-shifts/downloadworkshiftsjson","deprecated":false},{"title":"/v2/download/workShifts.csv","summary":"Download work shifts as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-work-shifts/downloadworkshiftscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Employee hours","link":"/download-employee-hours","routeSlug":"/download-employee-hours","items":[{"label":"Download employee hours as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-employee-hours/downloademployeehoursjson","routeSlug":"/download-employee-hours/downloademployeehoursjson","metadata":{"seo":{"title":"Download employee hours as JSON","description":"GET https://api.zoined.com/v2/download/employeeHours.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadEmployeeHoursJson","name":"Download employee hours as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1employeeHours.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download employee hours as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/employeeHours.json?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1employeeHours.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/employeeHours.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/employeeHours.json","href":"/download-employee-hours/downloademployeehoursjson","openApiOperationId":"downloadEmployeeHoursJson","summary":"Download employee hours as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_63","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1employeeHours.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_63","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-employee-hours/downloademployeehoursjson"}],"panels":[]}]},"httpPath":"/v2/download/employeeHours.json"},{"label":"Download employee hours as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-employee-hours/downloademployeehourscsv","routeSlug":"/download-employee-hours/downloademployeehourscsv","metadata":{"seo":{"title":"Download employee hours as CSV","description":"GET https://api.zoined.com/v2/download/employeeHours.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadEmployeeHoursCsv","name":"Download employee hours as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1employeeHours.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download employee hours as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/employeeHours.csv?limit=1000&offset=0&start=2017-01-01&end=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1employeeHours.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/employeeHours.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/employeeHours.csv","href":"/download-employee-hours/downloademployeehourscsv","openApiOperationId":"downloadEmployeeHoursCsv","summary":"Download employee hours as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1employeeHours.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1employeeHours.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-employee-hours/downloademployeehourscsv"}],"panels":[]}]},"httpPath":"/v2/download/employeeHours.csv"}],"content":{"contentType":"group","meta":{"name":"download-employee-hours"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employee hours","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":"Returns list of employee hours in the system (simpler form of work shifts without shift). Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/employeeHours.json","summary":"Download employee hours as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-employee-hours/downloademployeehoursjson","deprecated":false},{"title":"/v2/download/employeeHours.csv","summary":"Download employee hours as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-employee-hours/downloademployeehourscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Hourly staff costs","link":"/download-hourly-staff-costs","routeSlug":"/download-hourly-staff-costs","items":[{"label":"Download staff costs as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-hourly-staff-costs/downloadhourlystaffcostsjson","routeSlug":"/download-hourly-staff-costs/downloadhourlystaffcostsjson","metadata":{"seo":{"title":"Download staff costs as JSON","description":"GET https://api.zoined.com/v2/download/staffCosts.json?limit=1000&offset=0&start=2024-01-01&end=2024-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadHourlyStaffCostsJson","name":"Download staff costs as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1staffCosts.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download staff costs as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/staffCosts.json?limit=1000&offset=0&start=2024-01-01&end=2024-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2024-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2024-01-31"}],"pointer":"/paths/~1v2~1download~1staffCosts.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/staffCosts.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2024-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2024-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/staffCosts.json","href":"/download-hourly-staff-costs/downloadhourlystaffcostsjson","openApiOperationId":"downloadHourlyStaffCostsJson","summary":"Download staff costs as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_64","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1staffCosts.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_64","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-hourly-staff-costs/downloadhourlystaffcostsjson"}],"panels":[]}]},"httpPath":"/v2/download/staffCosts.json"},{"label":"Download staff costs as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-hourly-staff-costs/downloadhourlystaffcostscsv","routeSlug":"/download-hourly-staff-costs/downloadhourlystaffcostscsv","metadata":{"seo":{"title":"Download staff costs as CSV","description":"GET https://api.zoined.com/v2/download/staffCosts.csv?limit=1000&offset=0&start=2024-01-01&end=2024-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadHourlyStaffCostsCsv","name":"Download staff costs as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1staffCosts.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download staff costs as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/staffCosts.csv?limit=1000&offset=0&start=2024-01-01&end=2024-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2024-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2024-01-31"}],"pointer":"/paths/~1v2~1download~1staffCosts.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/staffCosts.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2024-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2024-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/staffCosts.csv","href":"/download-hourly-staff-costs/downloadhourlystaffcostscsv","openApiOperationId":"downloadHourlyStaffCostsCsv","summary":"Download staff costs as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1staffCosts.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1staffCosts.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-hourly-staff-costs/downloadhourlystaffcostscsv"}],"panels":[]}]},"httpPath":"/v2/download/staffCosts.csv"}],"content":{"contentType":"group","meta":{"name":"download-hourly-staff-costs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hourly staff costs","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":"Returns list of hourly store, department and employee level hourly salary data in the system."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned data can be limited with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/staffCosts.json","summary":"Download staff costs as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-hourly-staff-costs/downloadhourlystaffcostsjson","deprecated":false},{"title":"/v2/download/staffCosts.csv","summary":"Download staff costs as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-hourly-staff-costs/downloadhourlystaffcostscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/download-products","routeSlug":"/download-products","items":[{"label":"Download products as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-products/downloadproductsjson","routeSlug":"/download-products/downloadproductsjson","metadata":{"seo":{"title":"Download products as JSON","description":"GET https://api.zoined.com/v2/download/products.json?limit=1000&offset=0&product_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadProductsJson","name":"Download products as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1products.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download products as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/products.json?limit=1000&offset=0&product_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"product_id","in":"query","schemaId":"schema_1","description":"Return data of a product based on given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1products.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/products.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"product_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/products.json","href":"/download-products/downloadproductsjson","openApiOperationId":"downloadProductsJson","summary":"Download products as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1v2~1download~1products.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_65","exampleIds":["paths/~1v2~1download~1products.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1products.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1products.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1products.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","exampleIds":["paths/~1v2~1download~1products.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1v2~1download~1products.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1products.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1products.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-products/downloadproductsjson"}],"panels":[]}]},"httpPath":"/v2/download/products.json"},{"label":"Download products as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-products/downloadproductscsv","routeSlug":"/download-products/downloadproductscsv","metadata":{"seo":{"title":"Download products as CSV","description":"GET https://api.zoined.com/v2/download/products.csv?limit=1000&offset=0&product_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadProductsCsv","name":"Download products as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1products.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download products as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/products.csv?limit=1000&offset=0&product_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"product_id","in":"query","schemaId":"schema_1","description":"Return data of a product based on given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1products.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/products.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"product_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/products.csv","href":"/download-products/downloadproductscsv","openApiOperationId":"downloadProductsCsv","summary":"Download products as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1products.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1products.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1products.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1products.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1products.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-products/downloadproductscsv"}],"panels":[]}]},"httpPath":"/v2/download/products.csv"}],"content":{"contentType":"group","meta":{"name":"download-products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","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":"Returns list of products in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/products.json","summary":"Download products as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-products/downloadproductsjson","deprecated":false},{"title":"/v2/download/products.csv","summary":"Download products as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-products/downloadproductscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/download-customers","routeSlug":"/download-customers","items":[{"label":"Download customers as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-customers/downloadcustomersjson","routeSlug":"/download-customers/downloadcustomersjson","metadata":{"seo":{"title":"Download customers as JSON","description":"GET https://api.zoined.com/v2/download/customers.json?limit=1000&offset=0&customer_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCustomersJson","name":"Download customers as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1customers.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download customers as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/customers.json?limit=1000&offset=0&customer_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"customer_id","in":"query","schemaId":"schema_1","description":"Returns data of customer based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1customers.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/customers.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"customer_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/customers.json","href":"/download-customers/downloadcustomersjson","openApiOperationId":"downloadCustomersJson","summary":"Download customers as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_66","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1customers.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_66","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-customers/downloadcustomersjson"}],"panels":[]}]},"httpPath":"/v2/download/customers.json"},{"label":"Download customers as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-customers/downloadcustomerscsv","routeSlug":"/download-customers/downloadcustomerscsv","metadata":{"seo":{"title":"Download customers as CSV","description":"GET https://api.zoined.com/v2/download/customers.csv?limit=1000&offset=0&customer_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCustomersCsv","name":"Download customers as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1customers.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download customers as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/customers.csv?limit=1000&offset=0&customer_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"customer_id","in":"query","schemaId":"schema_1","description":"Returns data of customer based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1customers.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/customers.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"customer_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/customers.csv","href":"/download-customers/downloadcustomerscsv","openApiOperationId":"downloadCustomersCsv","summary":"Download customers as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1customers.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1customers.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-customers/downloadcustomerscsv"}],"panels":[]}]},"httpPath":"/v2/download/customers.csv"}],"content":{"contentType":"group","meta":{"name":"download-customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","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":"Returns list of customers in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/customers.json","summary":"Download customers as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-customers/downloadcustomersjson","deprecated":false},{"title":"/v2/download/customers.csv","summary":"Download customers as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-customers/downloadcustomerscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Organisations","link":"/download-organisations","routeSlug":"/download-organisations","items":[{"label":"Download organisations as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-organisations/downloadorganisationsjson","routeSlug":"/download-organisations/downloadorganisationsjson","metadata":{"seo":{"title":"Download organisations as JSON","description":"GET https://api.zoined.com/v2/download/organisations.json?limit=1000&offset=0&organisation_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadOrganisationsJson","name":"Download organisations as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1organisations.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download organisations as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/organisations.json?limit=1000&offset=0&organisation_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"organisation_id","in":"query","schemaId":"schema_1","description":"Returns data of organisation based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1organisations.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/organisations.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"organisation_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/organisations.json","href":"/download-organisations/downloadorganisationsjson","openApiOperationId":"downloadOrganisationsJson","summary":"Download organisations as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_67","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_67","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1organisations.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_67","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_67","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-organisations/downloadorganisationsjson"}],"panels":[]}]},"httpPath":"/v2/download/organisations.json"},{"label":"Download organisations as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-organisations/downloadorganisationscsv","routeSlug":"/download-organisations/downloadorganisationscsv","metadata":{"seo":{"title":"Download organisations as CSV","description":"GET https://api.zoined.com/v2/download/organisations.csv?limit=1000&offset=0&organisation_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadOrganisationsCsv","name":"Download organisations as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1organisations.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download organisations as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/organisations.csv?limit=1000&offset=0&organisation_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"organisation_id","in":"query","schemaId":"schema_1","description":"Returns data of organisation based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1organisations.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/organisations.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"organisation_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/organisations.csv","href":"/download-organisations/downloadorganisationscsv","openApiOperationId":"downloadOrganisationsCsv","summary":"Download organisations as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1organisations.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1organisations.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-organisations/downloadorganisationscsv"}],"panels":[]}]},"httpPath":"/v2/download/organisations.csv"}],"content":{"contentType":"group","meta":{"name":"download-organisations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organisations","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":"Returns list of organisations in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"organisation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/organisations.json","summary":"Download organisations as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-organisations/downloadorganisationsjson","deprecated":false},{"title":"/v2/download/organisations.csv","summary":"Download organisations as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-organisations/downloadorganisationscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Departments","link":"/download-departments","routeSlug":"/download-departments","items":[{"label":"Download departments as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-departments/downloaddepartmentsjson","routeSlug":"/download-departments/downloaddepartmentsjson","metadata":{"seo":{"title":"Download departments as JSON","description":"GET https://api.zoined.com/v2/download/departments.json?limit=1000&offset=0&department_id=5401"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadDepartmentsJson","name":"Download departments as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1departments.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download departments as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/departments.json?limit=1000&offset=0&department_id=5401"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"department_id","in":"query","schemaId":"schema_1","description":"Returns data of department based on the given id","example":"5401"}],"pointer":"/paths/~1v2~1download~1departments.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/departments.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"department_id","in":"query","required":false,"example":"5401","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/departments.json","href":"/download-departments/downloaddepartmentsjson","openApiOperationId":"downloadDepartmentsJson","summary":"Download departments as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_68","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_68","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1departments.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_68","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-departments/downloaddepartmentsjson"}],"panels":[]}]},"httpPath":"/v2/download/departments.json"},{"label":"Download departments as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-departments/downloaddepartmentscsv","routeSlug":"/download-departments/downloaddepartmentscsv","metadata":{"seo":{"title":"Download departments as CSV","description":"GET https://api.zoined.com/v2/download/departments.csv?limit=1000&offset=0&department_id=5401"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadDepartmentsCsv","name":"Download departments as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1departments.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download departments as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/departments.csv?limit=1000&offset=0&department_id=5401"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"department_id","in":"query","schemaId":"schema_1","description":"Returns data of department based on the given id","example":"5401"}],"pointer":"/paths/~1v2~1download~1departments.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/departments.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"department_id","in":"query","required":false,"example":"5401","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/departments.csv","href":"/download-departments/downloaddepartmentscsv","openApiOperationId":"downloadDepartmentsCsv","summary":"Download departments as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1departments.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1departments.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-departments/downloaddepartmentscsv"}],"panels":[]}]},"httpPath":"/v2/download/departments.csv"}],"content":{"contentType":"group","meta":{"name":"download-departments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Departments","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":"Returns list of departments in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"department_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/departments.json","summary":"Download departments as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-departments/downloaddepartmentsjson","deprecated":false},{"title":"/v2/download/departments.csv","summary":"Download departments as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-departments/downloaddepartmentscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales persons","link":"/download-sales-persons","routeSlug":"/download-sales-persons","items":[{"label":"Download sales persons as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-persons/downloadsalespersonsjson","routeSlug":"/download-sales-persons/downloadsalespersonsjson","metadata":{"seo":{"title":"Download sales persons as JSON","description":"GET https://api.zoined.com/v2/download/salesPersons.json?limit=1000&offset=0&salesperson_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesPersonsJson","name":"Download sales persons as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesPersons.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales persons as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesPersons.json?limit=1000&offset=0&salesperson_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"salesperson_id","in":"query","schemaId":"schema_1","description":"Returns data for sales person based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1salesPersons.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesPersons.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"salesperson_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesPersons.json","href":"/download-sales-persons/downloadsalespersonsjson","openApiOperationId":"downloadSalesPersonsJson","summary":"Download sales persons as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_69","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesPersons.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_69","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-persons/downloadsalespersonsjson"}],"panels":[]}]},"httpPath":"/v2/download/salesPersons.json"},{"label":"Download sales persons as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-sales-persons/downloadsalespersonscsv","routeSlug":"/download-sales-persons/downloadsalespersonscsv","metadata":{"seo":{"title":"Download sales persons as CSV","description":"GET https://api.zoined.com/v2/download/salesPersons.csv?limit=1000&offset=0&salesperson_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSalesPersonsCsv","name":"Download sales persons as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1salesPersons.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download sales persons as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/salesPersons.csv?limit=1000&offset=0&salesperson_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"salesperson_id","in":"query","schemaId":"schema_1","description":"Returns data for sales person based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1salesPersons.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/salesPersons.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"salesperson_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/salesPersons.csv","href":"/download-sales-persons/downloadsalespersonscsv","openApiOperationId":"downloadSalesPersonsCsv","summary":"Download sales persons as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1salesPersons.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1salesPersons.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-sales-persons/downloadsalespersonscsv"}],"panels":[]}]},"httpPath":"/v2/download/salesPersons.csv"}],"content":{"contentType":"group","meta":{"name":"download-sales-persons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales persons","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":"Returns list of sales persons in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"salesperson_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/salesPersons.json","summary":"Download sales persons as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-persons/downloadsalespersonsjson","deprecated":false},{"title":"/v2/download/salesPersons.csv","summary":"Download sales persons as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-sales-persons/downloadsalespersonscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Cash Registers","link":"/download-cash-registers","routeSlug":"/download-cash-registers","items":[{"label":"Download cash registers as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-cash-registers/downloadcashregistersjson","routeSlug":"/download-cash-registers/downloadcashregistersjson","metadata":{"seo":{"title":"Download cash registers as JSON","description":"GET https://api.zoined.com/v2/download/cashRegisters.json?limit=1000&offset=0&register_id=123-1"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCashRegistersJson","name":"Download cash registers as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1cashRegisters.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download cash registers as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/cashRegisters.json?limit=1000&offset=0&register_id=123-1"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"register_id","in":"query","schemaId":"schema_1","description":"Returns data for cash register based on the given id","example":"123-1"}],"pointer":"/paths/~1v2~1download~1cashRegisters.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/cashRegisters.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"register_id","in":"query","required":false,"example":"123-1","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/cashRegisters.json","href":"/download-cash-registers/downloadcashregistersjson","openApiOperationId":"downloadCashRegistersJson","summary":"Download cash registers as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_70","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_70","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1cashRegisters.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_70","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_70","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-cash-registers/downloadcashregistersjson"}],"panels":[]}]},"httpPath":"/v2/download/cashRegisters.json"},{"label":"Download cash registers as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-cash-registers/downloadcashregisterscsv","routeSlug":"/download-cash-registers/downloadcashregisterscsv","metadata":{"seo":{"title":"Download cash registers as CSV","description":"GET https://api.zoined.com/v2/download/cashRegisters.csv?limit=1000&offset=0&register_id=123-1"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCashRegistersCsv","name":"Download cash registers as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1cashRegisters.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download cash registers as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/cashRegisters.csv?limit=1000&offset=0&register_id=123-1"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"register_id","in":"query","schemaId":"schema_1","description":"Returns data for cash register based on the given id","example":"123-1"}],"pointer":"/paths/~1v2~1download~1cashRegisters.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/cashRegisters.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"register_id","in":"query","required":false,"example":"123-1","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/cashRegisters.csv","href":"/download-cash-registers/downloadcashregisterscsv","openApiOperationId":"downloadCashRegistersCsv","summary":"Download cash registers as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1cashRegisters.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1cashRegisters.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-cash-registers/downloadcashregisterscsv"}],"panels":[]}]},"httpPath":"/v2/download/cashRegisters.csv"}],"content":{"contentType":"group","meta":{"name":"download-cash-registers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cash Registers","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":"Returns list of cash registers in the system. Returned data can be limited with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"register_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/cashRegisters.json","summary":"Download cash registers as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-cash-registers/downloadcashregistersjson","deprecated":false},{"title":"/v2/download/cashRegisters.csv","summary":"Download cash registers as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-cash-registers/downloadcashregisterscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounts","link":"/download-accounts","routeSlug":"/download-accounts","items":[{"label":"Download accounts as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-accounts/downloadaccountsjson","routeSlug":"/download-accounts/downloadaccountsjson","metadata":{"seo":{"title":"Download accounts as JSON","description":"GET https://api.zoined.com/v2/download/accounts.json?limit=1000&offset=0&account_id=1230"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadAccountsJson","name":"Download accounts as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1accounts.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download accounts as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/accounts.json?limit=1000&offset=0&account_id=1230"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"account_id","in":"query","schemaId":"schema_1","description":"Returns data for account based on the given id","example":"1230"}],"pointer":"/paths/~1v2~1download~1accounts.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/accounts.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"account_id","in":"query","required":false,"example":"1230","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/accounts.json","href":"/download-accounts/downloadaccountsjson","openApiOperationId":"downloadAccountsJson","summary":"Download accounts as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_71","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_71","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1accounts.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_71","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_71","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-accounts/downloadaccountsjson"}],"panels":[]}]},"httpPath":"/v2/download/accounts.json"},{"label":"Download accounts as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-accounts/downloadaccountscsv","routeSlug":"/download-accounts/downloadaccountscsv","metadata":{"seo":{"title":"Download accounts as CSV","description":"GET https://api.zoined.com/v2/download/accounts.csv?limit=1000&offset=0&account_id=1230"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadAccountsCsv","name":"Download accounts as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1accounts.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download accounts as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/accounts.csv?limit=1000&offset=0&account_id=1230"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"account_id","in":"query","schemaId":"schema_1","description":"Returns data for account based on the given id","example":"1230"}],"pointer":"/paths/~1v2~1download~1accounts.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/accounts.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"account_id","in":"query","required":false,"example":"1230","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/accounts.csv","href":"/download-accounts/downloadaccountscsv","openApiOperationId":"downloadAccountsCsv","summary":"Download accounts as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1accounts.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1accounts.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-accounts/downloadaccountscsv"}],"panels":[]}]},"httpPath":"/v2/download/accounts.csv"}],"content":{"contentType":"group","meta":{"name":"download-accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","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":"Returns list of bookkeeping accounts in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/accounts.json","summary":"Download accounts as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-accounts/downloadaccountsjson","deprecated":false},{"title":"/v2/download/accounts.csv","summary":"Download accounts as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-accounts/downloadaccountscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/download-events","routeSlug":"/download-events","items":[{"label":"Download events as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-events/downloadeventsjson","routeSlug":"/download-events/downloadeventsjson","metadata":{"seo":{"title":"Download events as JSON","description":"GET https://api.zoined.com/v2/download/events.json?limit=1000&offset=0&event_id=123"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadEventsJson","name":"Download events as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1events.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download events as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/events.json?limit=1000&offset=0&event_id=123"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"event_id","in":"query","schemaId":"schema_1","description":"Returns data for event based on the given id","example":"123"}],"pointer":"/paths/~1v2~1download~1events.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/events.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"event_id","in":"query","required":false,"example":"123","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/events.json","href":"/download-events/downloadeventsjson","openApiOperationId":"downloadEventsJson","summary":"Download events as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72","exampleIds":["paths/~1v2~1download~1events.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_72","exampleIds":["paths/~1v2~1download~1events.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1events.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1events.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1events.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_72","exampleIds":["paths/~1v2~1download~1events.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72","exampleIds":["paths/~1v2~1download~1events.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1events.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1events.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-events/downloadeventsjson"}],"panels":[]}]},"httpPath":"/v2/download/events.json"},{"label":"Download events as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-events/downloadeventscsv","routeSlug":"/download-events/downloadeventscsv","metadata":{"seo":{"title":"Download events as CSV","description":"GET https://api.zoined.com/v2/download/events.csv?limit=1000&offset=0&event_id=123"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadEventsCsv","name":"Download events as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1events.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download events as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/events.csv?limit=1000&offset=0&event_id=123"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"event_id","in":"query","schemaId":"schema_1","description":"Returns data for event based on the given id","example":"123"}],"pointer":"/paths/~1v2~1download~1events.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/events.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"event_id","in":"query","required":false,"example":"123","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/events.csv","href":"/download-events/downloadeventscsv","openApiOperationId":"downloadEventsCsv","summary":"Download events as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1events.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1events.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1events.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1events.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1events.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-events/downloadeventscsv"}],"panels":[]}]},"httpPath":"/v2/download/events.csv"}],"content":{"contentType":"group","meta":{"name":"download-events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","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":"Returns list of booking events in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/events.json","summary":"Download events as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-events/downloadeventsjson","deprecated":false},{"title":"/v2/download/events.csv","summary":"Download events as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-events/downloadeventscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Category hierarchies","link":"/download-category-hierarchies","routeSlug":"/download-category-hierarchies","items":[{"label":"Download hierarchies as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-category-hierarchies/downloadcategoryhierarchiesjson","routeSlug":"/download-category-hierarchies/downloadcategoryhierarchiesjson","metadata":{"seo":{"title":"Download hierarchies as JSON","description":"GET https://api.zoined.com/v2/download/hierarchies.json?limit=1000&offset=0&category_id=5401&hierarchy_key=product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCategoryHierarchiesJson","name":"Download hierarchies as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1hierarchies.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download hierarchies as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/hierarchies.json?limit=1000&offset=0&category_id=5401&hierarchy_key=product"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"category_id","in":"query","schemaId":"schema_1","description":"Returns data of categories based on the given id","example":"5401"},{"name":"hierarchy_key","in":"query","schemaId":"schema_1","description":"Returns data of given hierarchies only","example":"product"}],"pointer":"/paths/~1v2~1download~1hierarchies.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/hierarchies.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"category_id","in":"query","required":false,"example":"5401","schemaId":"schema_1"},{"name":"hierarchy_key","in":"query","required":false,"example":"product","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/hierarchies.json","href":"/download-category-hierarchies/downloadcategoryhierarchiesjson","openApiOperationId":"downloadCategoryHierarchiesJson","summary":"Download hierarchies as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_73","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1hierarchies.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_73","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-category-hierarchies/downloadcategoryhierarchiesjson"}],"panels":[]}]},"httpPath":"/v2/download/hierarchies.json"},{"label":"Download hierarchies as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-category-hierarchies/downloadcategoryhierarchiescsv","routeSlug":"/download-category-hierarchies/downloadcategoryhierarchiescsv","metadata":{"seo":{"title":"Download hierarchies as CSV","description":"GET https://api.zoined.com/v2/download/hierarchies.csv?limit=1000&offset=0&category_id=5401&hierarchy_key=product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCategoryHierarchiesCsv","name":"Download hierarchies as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1hierarchies.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download hierarchies as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/hierarchies.csv?limit=1000&offset=0&category_id=5401&hierarchy_key=product"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"category_id","in":"query","schemaId":"schema_1","description":"Returns data of categories based on the given id","example":"5401"},{"name":"hierarchy_key","in":"query","schemaId":"schema_1","description":"Returns data of given hierarchies only","example":"product"}],"pointer":"/paths/~1v2~1download~1hierarchies.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/hierarchies.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"category_id","in":"query","required":false,"example":"5401","schemaId":"schema_1"},{"name":"hierarchy_key","in":"query","required":false,"example":"product","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/hierarchies.csv","href":"/download-category-hierarchies/downloadcategoryhierarchiescsv","openApiOperationId":"downloadCategoryHierarchiesCsv","summary":"Download hierarchies as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1hierarchies.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1hierarchies.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-category-hierarchies/downloadcategoryhierarchiescsv"}],"panels":[]}]},"httpPath":"/v2/download/hierarchies.csv"}],"content":{"contentType":"group","meta":{"name":"download-category-hierarchies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Category hierarchies","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":"Returns list of all category hierarchies in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hierarchy_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/hierarchies.json","summary":"Download hierarchies as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-category-hierarchies/downloadcategoryhierarchiesjson","deprecated":false},{"title":"/v2/download/hierarchies.csv","summary":"Download hierarchies as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-category-hierarchies/downloadcategoryhierarchiescsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Flat hierarchies","link":"/download-flat-hierarchies","routeSlug":"/download-flat-hierarchies","items":[{"label":"Download flat hierarchies as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-flat-hierarchies/downloadflathierarchiesjson","routeSlug":"/download-flat-hierarchies/downloadflathierarchiesjson","metadata":{"seo":{"title":"Download flat hierarchies as JSON","description":"GET https://api.zoined.com/v2/download/flatHierarchies.json?limit=1000&offset=0&hierarchy_key=product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadFlatHierarchiesJson","name":"Download flat hierarchies as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1flatHierarchies.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download flat hierarchies as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/flatHierarchies.json?limit=1000&offset=0&hierarchy_key=product"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"hierarchy_key","in":"query","schemaId":"schema_1","description":"Returns data of given hierarchies only","example":"product"}],"pointer":"/paths/~1v2~1download~1flatHierarchies.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/flatHierarchies.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"hierarchy_key","in":"query","required":false,"example":"product","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/flatHierarchies.json","href":"/download-flat-hierarchies/downloadflathierarchiesjson","openApiOperationId":"downloadFlatHierarchiesJson","summary":"Download flat hierarchies as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_74","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1flatHierarchies.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_74","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-flat-hierarchies/downloadflathierarchiesjson"}],"panels":[]}]},"httpPath":"/v2/download/flatHierarchies.json"},{"label":"Download flat hierarchies as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-flat-hierarchies/downloadflathierarchiescsv","routeSlug":"/download-flat-hierarchies/downloadflathierarchiescsv","metadata":{"seo":{"title":"Download flat hierarchies as CSV","description":"GET https://api.zoined.com/v2/download/flatHierarchies.csv?limit=1000&offset=0&hierarchy_key=product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadFlatHierarchiesCsv","name":"Download flat hierarchies as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1flatHierarchies.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download flat hierarchies as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/flatHierarchies.csv?limit=1000&offset=0&hierarchy_key=product"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"hierarchy_key","in":"query","schemaId":"schema_1","description":"Returns data of given hierarchies only","example":"product"}],"pointer":"/paths/~1v2~1download~1flatHierarchies.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/flatHierarchies.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"hierarchy_key","in":"query","required":false,"example":"product","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/flatHierarchies.csv","href":"/download-flat-hierarchies/downloadflathierarchiescsv","openApiOperationId":"downloadFlatHierarchiesCsv","summary":"Download flat hierarchies as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1flatHierarchies.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatHierarchies.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-flat-hierarchies/downloadflathierarchiescsv"}],"panels":[]}]},"httpPath":"/v2/download/flatHierarchies.csv"}],"content":{"contentType":"group","meta":{"name":"download-flat-hierarchies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Flat hierarchies","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":"Returns list of all hierarchies in the system in a flat format. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hierarchy_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/flatHierarchies.json","summary":"Download flat hierarchies as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-flat-hierarchies/downloadflathierarchiesjson","deprecated":false},{"title":"/v2/download/flatHierarchies.csv","summary":"Download flat hierarchies as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-flat-hierarchies/downloadflathierarchiescsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Counters","link":"/download-counters","routeSlug":"/download-counters","items":[{"label":"Download counters as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-counters/downloadcountersjson","routeSlug":"/download-counters/downloadcountersjson","metadata":{"seo":{"title":"Download counters as JSON","description":"GET https://api.zoined.com/v2/download/counters.json?limit=1000&offset=0&counter_id=5"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCountersJson","name":"Download counters as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1counters.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download counters as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/counters.json?limit=1000&offset=0&counter_id=5"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"counter_id","in":"query","schemaId":"schema_1","description":"Returns data of counter based on the given id","example":"5"}],"pointer":"/paths/~1v2~1download~1counters.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/counters.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"counter_id","in":"query","required":false,"example":"5","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/counters.json","href":"/download-counters/downloadcountersjson","openApiOperationId":"downloadCountersJson","summary":"Download counters as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_75","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1counters.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_75","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-counters/downloadcountersjson"}],"panels":[]}]},"httpPath":"/v2/download/counters.json"},{"label":"Download counters as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-counters/downloadcounterscsv","routeSlug":"/download-counters/downloadcounterscsv","metadata":{"seo":{"title":"Download counters as CSV","description":"GET https://api.zoined.com/v2/download/counters.csv?limit=1000&offset=0&counter_id=5"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCountersCsv","name":"Download counters as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1counters.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download counters as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/counters.csv?limit=1000&offset=0&counter_id=5"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"counter_id","in":"query","schemaId":"schema_1","description":"Returns data of department based on the given id","example":"5"}],"pointer":"/paths/~1v2~1download~1counters.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/counters.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"counter_id","in":"query","required":false,"example":"5","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/counters.csv","href":"/download-counters/downloadcounterscsv","openApiOperationId":"downloadCountersCsv","summary":"Download counters as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1counters.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1counters.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-counters/downloadcounterscsv"}],"panels":[]}]},"httpPath":"/v2/download/counters.csv"}],"content":{"contentType":"group","meta":{"name":"download-counters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Counters","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":"Returns list of visitor counters in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counter_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/counters.json","summary":"Download counters as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-counters/downloadcountersjson","deprecated":false},{"title":"/v2/download/counters.csv","summary":"Download counters as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-counters/downloadcounterscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Campaigns","link":"/download-campaigns","routeSlug":"/download-campaigns","items":[{"label":"Download campaigns as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-campaigns/downloadcampaignsjson","routeSlug":"/download-campaigns/downloadcampaignsjson","metadata":{"seo":{"title":"Download campaigns as JSON","description":"GET https://api.zoined.com/v2/download/campaigns.json?limit=1000&offset=0&campaign_id=123k&start_date=2017-01-01&end_date=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCampaignsJson","name":"Download campaigns as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1campaigns.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download campaigns as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/campaigns.json?limit=1000&offset=0&campaign_id=123k&start_date=2017-01-01&end_date=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"campaign_id","in":"query","schemaId":"schema_1","description":"Returns data of Campaigns based on the given id","example":"123k"},{"name":"start_date","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end_date","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1campaigns.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/campaigns.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"campaign_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"},{"name":"start_date","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end_date","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/campaigns.json","href":"/download-campaigns/downloadcampaignsjson","openApiOperationId":"downloadCampaignsJson","summary":"Download campaigns as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_76","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1campaigns.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_76","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-campaigns/downloadcampaignsjson"}],"panels":[]}]},"httpPath":"/v2/download/campaigns.json"},{"label":"Download campaigns as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-campaigns/downloadcampaignscsv","routeSlug":"/download-campaigns/downloadcampaignscsv","metadata":{"seo":{"title":"Download campaigns as CSV","description":"GET https://api.zoined.com/v2/download/campaigns.csv?limit=1000&offset=0&campaign_id=123k&start_date=2017-01-01&end_date=2017-01-31"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCampaignsCsv","name":"Download campaigns as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1campaigns.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download campaigns as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/campaigns.csv?limit=1000&offset=0&campaign_id=123k&start_date=2017-01-01&end_date=2017-01-31"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"campaign_id","in":"query","schemaId":"schema_1","description":"Returns data of Campaigns based on the given id","example":"123k"},{"name":"start_date","in":"query","schemaId":"schema_1","description":"Return data starting from given date","example":"2017-01-01"},{"name":"end_date","in":"query","schemaId":"schema_1","description":"Return data ending to given date","example":"2017-01-31"}],"pointer":"/paths/~1v2~1download~1campaigns.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/campaigns.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"campaign_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"},{"name":"start_date","in":"query","required":false,"example":"2017-01-01","schemaId":"schema_1"},{"name":"end_date","in":"query","required":false,"example":"2017-01-31","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/campaigns.csv","href":"/download-campaigns/downloadcampaignscsv","openApiOperationId":"downloadCampaignsCsv","summary":"Download campaigns as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1campaigns.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1campaigns.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-campaigns/downloadcampaignscsv"}],"panels":[]}]},"httpPath":"/v2/download/campaigns.csv"}],"content":{"contentType":"group","meta":{"name":"download-campaigns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaigns","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":"Returns list of campaigns in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/campaigns.json","summary":"Download campaigns as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-campaigns/downloadcampaignsjson","deprecated":false},{"title":"/v2/download/campaigns.csv","summary":"Download campaigns as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-campaigns/downloadcampaignscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment types","link":"/download-payment-types","routeSlug":"/download-payment-types","items":[{"label":"Download payment types as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-payment-types/downloadpaymenttypesjson","routeSlug":"/download-payment-types/downloadpaymenttypesjson","metadata":{"seo":{"title":"Download payment types as JSON","description":"GET https://api.zoined.com/v2/download/paymentTypes.json?limit=1000&offset=0&payment_type_id=1"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPaymentTypesJson","name":"Download payment types as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1paymentTypes.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download payment types as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/paymentTypes.json?limit=1000&offset=0&payment_type_id=1"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"payment_type_id","in":"query","schemaId":"schema_1","description":"Returns data of payment type based on the given id","example":"1"}],"pointer":"/paths/~1v2~1download~1paymentTypes.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/paymentTypes.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"payment_type_id","in":"query","required":false,"example":"1","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/paymentTypes.json","href":"/download-payment-types/downloadpaymenttypesjson","openApiOperationId":"downloadPaymentTypesJson","summary":"Download payment types as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_77","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1paymentTypes.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_77","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-payment-types/downloadpaymenttypesjson"}],"panels":[]}]},"httpPath":"/v2/download/paymentTypes.json"},{"label":"Download payment types as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-payment-types/downloadpaymenttypescsv","routeSlug":"/download-payment-types/downloadpaymenttypescsv","metadata":{"seo":{"title":"Download payment types as CSV","description":"GET https://api.zoined.com/v2/download/paymentTypes.csv?limit=1000&offset=0&payment_type_id=1"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPaymentTypesCsv","name":"Download payment types as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1paymentTypes.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download payment types as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/paymentTypes.csv?limit=1000&offset=0&payment_type_id=1"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"payment_type_id","in":"query","schemaId":"schema_1","description":"Returns data of payment type based on the given id","example":"1"}],"pointer":"/paths/~1v2~1download~1paymentTypes.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/paymentTypes.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"payment_type_id","in":"query","required":false,"example":"1","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/paymentTypes.csv","href":"/download-payment-types/downloadpaymenttypescsv","openApiOperationId":"downloadPaymentTypesCsv","summary":"Download payment types as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1paymentTypes.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1paymentTypes.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-payment-types/downloadpaymenttypescsv"}],"panels":[]}]},"httpPath":"/v2/download/paymentTypes.csv"}],"content":{"contentType":"group","meta":{"name":"download-payment-types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment types","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":"Returns list of payment types in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_type_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/paymentTypes.json","summary":"Download payment types as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-payment-types/downloadpaymenttypesjson","deprecated":false},{"title":"/v2/download/paymentTypes.csv","summary":"Download payment types as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-payment-types/downloadpaymenttypescsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Rebate codes","link":"/download-rebate-codes","routeSlug":"/download-rebate-codes","items":[{"label":"Download rebate codes as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-rebate-codes/downloadrebatecodesjson","routeSlug":"/download-rebate-codes/downloadrebatecodesjson","metadata":{"seo":{"title":"Download rebate codes as JSON","description":"GET https://api.zoined.com/v2/download/rebateCodes.json?limit=1000&offset=0&rebate_code_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadRebateCodesJson","name":"Download rebate codes as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1rebateCodes.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download rebate codes as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/rebateCodes.json?limit=1000&offset=0&rebate_code_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"rebate_code_id","in":"query","schemaId":"schema_1","description":"Returns data of rebateCode based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1rebateCodes.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/rebateCodes.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"rebate_code_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/rebateCodes.json","href":"/download-rebate-codes/downloadrebatecodesjson","openApiOperationId":"downloadRebateCodesJson","summary":"Download rebate codes as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_78","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1rebateCodes.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_78","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-rebate-codes/downloadrebatecodesjson"}],"panels":[]}]},"httpPath":"/v2/download/rebateCodes.json"},{"label":"Download rebate codes as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-rebate-codes/downloadrebatecodescsv","routeSlug":"/download-rebate-codes/downloadrebatecodescsv","metadata":{"seo":{"title":"Download rebate codes as CSV","description":"GET https://api.zoined.com/v2/download/rebateCodes.csv?limit=1000&offset=0&rebate_code_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadRebateCodesCsv","name":"Download rebate codes as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1rebateCodes.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download rebate codes as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/rebateCodes.csv?limit=1000&offset=0&rebate_code_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"rebate_code_id","in":"query","schemaId":"schema_1","description":"Returns data of rebateCode based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1rebateCodes.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/rebateCodes.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"rebate_code_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/rebateCodes.csv","href":"/download-rebate-codes/downloadrebatecodescsv","openApiOperationId":"downloadRebateCodesCsv","summary":"Download rebate codes as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1rebateCodes.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1rebateCodes.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-rebate-codes/downloadrebatecodescsv"}],"panels":[]}]},"httpPath":"/v2/download/rebateCodes.csv"}],"content":{"contentType":"group","meta":{"name":"download-rebate-codes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rebate codes","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":"Returns list of rebate codes in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rebate_code_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/rebateCodes.json","summary":"Download rebate codes as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-rebate-codes/downloadrebatecodesjson","deprecated":false},{"title":"/v2/download/rebateCodes.csv","summary":"Download rebate codes as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-rebate-codes/downloadrebatecodescsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Suppliers","link":"/download-suppliers","routeSlug":"/download-suppliers","items":[{"label":"Download suppliers as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-suppliers/downloadsuppliersjson","routeSlug":"/download-suppliers/downloadsuppliersjson","metadata":{"seo":{"title":"Download suppliers as JSON","description":"GET https://api.zoined.com/v2/download/suppliers.json?limit=1000&offset=0&supplier_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSuppliersJson","name":"Download suppliers as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1suppliers.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download suppliers as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/suppliers.json?limit=1000&offset=0&supplier_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"supplier_id","in":"query","schemaId":"schema_1","description":"Returns data of suppliers based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1suppliers.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/suppliers.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"supplier_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/suppliers.json","href":"/download-suppliers/downloadsuppliersjson","openApiOperationId":"downloadSuppliersJson","summary":"Download suppliers as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_79","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1suppliers.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_79","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-suppliers/downloadsuppliersjson"}],"panels":[]}]},"httpPath":"/v2/download/suppliers.json"},{"label":"Download suppliers as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-suppliers/downloadsupplierscsv","routeSlug":"/download-suppliers/downloadsupplierscsv","metadata":{"seo":{"title":"Download suppliers as CSV","description":"GET https://api.zoined.com/v2/download/suppliers.csv?limit=1000&offset=0&supplier_id=123k"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadSuppliersCsv","name":"Download suppliers as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1suppliers.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download suppliers as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/suppliers.csv?limit=1000&offset=0&supplier_id=123k"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"supplier_id","in":"query","schemaId":"schema_1","description":"Returns data of suppliers based on the given id","example":"123k"}],"pointer":"/paths/~1v2~1download~1suppliers.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/suppliers.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"supplier_id","in":"query","required":false,"example":"123k","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/suppliers.csv","href":"/download-suppliers/downloadsupplierscsv","openApiOperationId":"downloadSuppliersCsv","summary":"Download suppliers as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1suppliers.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1suppliers.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-suppliers/downloadsupplierscsv"}],"panels":[]}]},"httpPath":"/v2/download/suppliers.csv"}],"content":{"contentType":"group","meta":{"name":"download-suppliers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Suppliers","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":"Returns list of suppliers in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/suppliers.json","summary":"Download suppliers as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-suppliers/downloadsuppliersjson","deprecated":false},{"title":"/v2/download/suppliers.csv","summary":"Download suppliers as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-suppliers/downloadsupplierscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom calendars","link":"/download-custom-calendars","routeSlug":"/download-custom-calendars","items":[{"label":"Download custom calendar as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-custom-calendars/downloadcustomcalendarsjson","routeSlug":"/download-custom-calendars/downloadcustomcalendarsjson","metadata":{"seo":{"title":"Download custom calendar as JSON","description":"GET https://api.zoined.com/v2/download/calendar.json?limit=1000&offset=0&year=2018&period=season"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCustomCalendarsJson","name":"Download custom calendar as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1calendar.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download custom calendar as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/calendar.json?limit=1000&offset=0&year=2018&period=season"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"year","in":"query","schemaId":"schema_45","description":"Returns calendar period data for given year(s) only","example":"2018"},{"name":"period","in":"query","schemaId":"schema_1","description":"Returns calendar period data for given period type(s) only","example":"season"}],"pointer":"/paths/~1v2~1download~1calendar.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/calendar.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"year","in":"query","required":false,"example":"2018","schemaId":"schema_45"},{"name":"period","in":"query","required":false,"example":"season","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/calendar.json","href":"/download-custom-calendars/downloadcustomcalendarsjson","openApiOperationId":"downloadCustomCalendarsJson","summary":"Download custom calendar as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_80","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1calendar.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_80","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-custom-calendars/downloadcustomcalendarsjson"}],"panels":[]}]},"httpPath":"/v2/download/calendar.json"},{"label":"Download custom calendar as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-custom-calendars/downloadcustomcalendarscsv","routeSlug":"/download-custom-calendars/downloadcustomcalendarscsv","metadata":{"seo":{"title":"Download custom calendar as CSV","description":"GET https://api.zoined.com/v2/download/calendar.csv?limit=1000&offset=0&year=2018&period=season"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCustomCalendarsCsv","name":"Download custom calendar as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1calendar.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download custom calendar as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/calendar.csv?limit=1000&offset=0&year=2018&period=season"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"year","in":"query","schemaId":"schema_45","description":"Returns calendar period data for given year(s) only","example":"2018"},{"name":"period","in":"query","schemaId":"schema_1","description":"Returns calendar period data for given period type(s) only","example":"season"}],"pointer":"/paths/~1v2~1download~1calendar.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/calendar.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"year","in":"query","required":false,"example":"2018","schemaId":"schema_45"},{"name":"period","in":"query","required":false,"example":"season","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/calendar.csv","href":"/download-custom-calendars/downloadcustomcalendarscsv","openApiOperationId":"downloadCustomCalendarsCsv","summary":"Download custom calendar as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1calendar.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1calendar.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-custom-calendars/downloadcustomcalendarscsv"}],"panels":[]}]},"httpPath":"/v2/download/calendar.csv"}],"content":{"contentType":"group","meta":{"name":"download-custom-calendars"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom calendars","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":"Returns custom calendar periods available in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/calendar.json","summary":"Download custom calendar as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-custom-calendars/downloadcustomcalendarsjson","deprecated":false},{"title":"/v2/download/calendar.csv","summary":"Download custom calendar as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-custom-calendars/downloadcustomcalendarscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Flat calendars","link":"/download-flat-calendars","routeSlug":"/download-flat-calendars","items":[{"label":"Download flat calendar as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-flat-calendars/downloadflatcalendarsjson","routeSlug":"/download-flat-calendars/downloadflatcalendarsjson","metadata":{"seo":{"title":"Download flat calendar as JSON","description":"GET https://api.zoined.com/v2/download/flatCalendar.json?limit=1000&offset=0&year=2018"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadFlatCalendarsJson","name":"Download flat calendar as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1flatCalendar.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download flat calendar as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/flatCalendar.json?limit=1000&offset=0&year=2018"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"year","in":"query","schemaId":"schema_45","description":"Returns calendar period data for given year(s) only","example":"2018"}],"pointer":"/paths/~1v2~1download~1flatCalendar.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/flatCalendar.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"year","in":"query","required":false,"example":"2018","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/flatCalendar.json","href":"/download-flat-calendars/downloadflatcalendarsjson","openApiOperationId":"downloadFlatCalendarsJson","summary":"Download flat calendar as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_81","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1flatCalendar.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_81","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-flat-calendars/downloadflatcalendarsjson"}],"panels":[]}]},"httpPath":"/v2/download/flatCalendar.json"},{"label":"Download flat calendar as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-flat-calendars/downloadflatcalendarscsv","routeSlug":"/download-flat-calendars/downloadflatcalendarscsv","metadata":{"seo":{"title":"Download flat calendar as CSV","description":"GET https://api.zoined.com/v2/download/flatCalendar.csv?limit=1000&offset=0&year=2018"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadFlatCalendarsCsv","name":"Download flat calendar as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1flatCalendar.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download flat calendar as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/flatCalendar.csv?limit=1000&offset=0&year=2018"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"year","in":"query","schemaId":"schema_45","description":"Returns calendar period data for given year(s) only","example":"2018"}],"pointer":"/paths/~1v2~1download~1flatCalendar.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/flatCalendar.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"year","in":"query","required":false,"example":"2018","schemaId":"schema_45"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/flatCalendar.csv","href":"/download-flat-calendars/downloadflatcalendarscsv","openApiOperationId":"downloadFlatCalendarsCsv","summary":"Download flat calendar as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1flatCalendar.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1flatCalendar.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-flat-calendars/downloadflatcalendarscsv"}],"panels":[]}]},"httpPath":"/v2/download/flatCalendar.csv"}],"content":{"contentType":"group","meta":{"name":"download-flat-calendars"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Flat calendars","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":"Returns custom calendar periods available in the system in a flat format (one row per day). Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/flatCalendar.json","summary":"Download flat calendar as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-flat-calendars/downloadflatcalendarsjson","deprecated":false},{"title":"/v2/download/flatCalendar.csv","summary":"Download flat calendar as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-flat-calendars/downloadflatcalendarscsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Currency rates","link":"/download-currency-rates","routeSlug":"/download-currency-rates","items":[{"label":"Download currency rates as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-currency-rates/downloadcurrencyratesjson","routeSlug":"/download-currency-rates/downloadcurrencyratesjson","metadata":{"seo":{"title":"Download currency rates as JSON","description":"GET https://api.zoined.com/v2/download/currencyRates.json?limit=1000&offset=0&start=2018-01-01&end=2018-12-31&currency=SEK"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCurrencyRatesJson","name":"Download currency rates as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1currencyRates.json/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download currency rates as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/currencyRates.json?limit=1000&offset=0&start=2018-01-01&end=2018-12-31&currency=SEK"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Returns currency rates from given date onward","example":"2018-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Returns currency rates until given date","example":"2018-12-31"},{"name":"currency","in":"query","schemaId":"schema_1","description":"Return only rates with given currencies as either source or target currency","example":"SEK"}],"pointer":"/paths/~1v2~1download~1currencyRates.json/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/currencyRates.json","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2018-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2018-12-31","schemaId":"schema_1"},{"name":"currency","in":"query","required":false,"example":"SEK","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/currencyRates.json","href":"/download-currency-rates/downloadcurrencyratesjson","openApiOperationId":"downloadCurrencyRatesJson","summary":"Download currency rates as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_82","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1currencyRates.json/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_82","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.json/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-currency-rates/downloadcurrencyratesjson"}],"panels":[]}]},"httpPath":"/v2/download/currencyRates.json"},{"label":"Download currency rates as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-currency-rates/downloadcurrencyratescsv","routeSlug":"/download-currency-rates/downloadcurrencyratescsv","metadata":{"seo":{"title":"Download currency rates as CSV","description":"GET https://api.zoined.com/v2/download/currencyRates.csv?limit=1000&offset=0&start=2018-01-01&end=2018-12-31&currency=SEK"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCurrencyRatesCsv","name":"Download currency rates as CSV","isWebhook":false,"pointer":"/paths/~1v2~1download~1currencyRates.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download currency rates as CSV","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/currencyRates.csv?limit=1000&offset=0&start=2018-01-01&end=2018-12-31&currency=SEK"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"start","in":"query","schemaId":"schema_1","description":"Returns currency rates from given date onward","example":"2018-01-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"Returns currency rates until given date","example":"2018-12-31"},{"name":"currency","in":"query","schemaId":"schema_1","description":"Return only rates with given currencies as either source or target currency","example":"SEK"}],"pointer":"/paths/~1v2~1download~1currencyRates.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/currencyRates.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"start","in":"query","required":false,"example":"2018-01-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2018-12-31","schemaId":"schema_1"},{"name":"currency","in":"query","required":false,"example":"SEK","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/currencyRates.csv","href":"/download-currency-rates/downloadcurrencyratescsv","openApiOperationId":"downloadCurrencyRatesCsv","summary":"Download currency rates as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1currencyRates.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1currencyRates.csv/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-currency-rates/downloadcurrencyratescsv"}],"panels":[]}]},"httpPath":"/v2/download/currencyRates.csv"}],"content":{"contentType":"group","meta":{"name":"download-currency-rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Currency rates","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":"Returns currency rates available in the system. Returned data can be limited with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/currencyRates.json","summary":"Download currency rates as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-currency-rates/downloadcurrencyratesjson","deprecated":false},{"title":"/v2/download/currencyRates.csv","summary":"Download currency rates as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-currency-rates/downloadcurrencyratescsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Budgets","link":"/download-budgets","routeSlug":"/download-budgets","items":[{"label":"Download budgets as JSON","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/download-budgets/downloadbudgetsjson","routeSlug":"/download-budgets/downloadbudgetsjson","metadata":{"seo":{"title":"Download budgets as JSON","description":"GET https://api.zoined.com/v2/download/budgets?limit=1000&offset=0&year=2018&label=forecast&metric=sales"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadBudgetsJson","name":"Download budgets as JSON","isWebhook":false,"pointer":"/paths/~1v2~1download~1budgets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download budgets as JSON","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":"GET"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/download/budgets?limit=1000&offset=0&year=2018&label=forecast&metric=sales"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_45","description":"How many entries to return","example":"1000"},{"name":"offset","in":"query","schemaId":"schema_45","description":"Which offset to return data from","example":"0"},{"name":"year","in":"query","schemaId":"schema_45","description":"Returns budgets for given year(s) only","example":"2018"},{"name":"label","in":"query","schemaId":"schema_1","description":"Returns budgets with given label(s) only","example":"forecast"},{"name":"metric","in":"query","schemaId":"schema_1","description":"Returns budgets for given metric(s) only","example":"sales"}],"pointer":"/paths/~1v2~1download~1budgets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/download/budgets","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":"1000","schemaId":"schema_45"},{"name":"offset","in":"query","required":false,"example":"0","schemaId":"schema_45"},{"name":"year","in":"query","required":false,"example":"2018","schemaId":"schema_45"},{"name":"label","in":"query","required":false,"example":"forecast","schemaId":"schema_1"},{"name":"metric","in":"query","required":false,"example":"sales","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/download/budgets","href":"/download-budgets/downloadbudgetsjson","openApiOperationId":"downloadBudgetsJson","summary":"Download budgets as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1v2~1download~1budgets/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_83","exampleIds":["paths/~1v2~1download~1budgets/get/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1budgets/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1budgets/get/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1budgets/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1budgets/get/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1budgets/get/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1budgets/get/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1download~1budgets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_83","exampleIds":["paths/~1v2~1download~1budgets/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83","exampleIds":["paths/~1v2~1download~1budgets/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1budgets/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1budgets/get/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1budgets/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1download~1budgets/get/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1budgets/get/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1download~1budgets/get/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/download-budgets/downloadbudgetsjson"}],"panels":[]}]},"httpPath":"/v2/download/budgets"}],"content":{"contentType":"group","meta":{"name":"download-budgets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Budgets","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":"Returns budgets available in the system. Returned data can be limited with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/download/budgets","summary":"Download budgets as JSON","prefix":{"name":"get","color":"get"},"badges":[],"link":"/download-budgets/downloadbudgetsjson","deprecated":false}]}]}]}]}},{"type":"separator","label":"Data queries","content":null},{"type":"group","label":"Data queries: Introduction","link":"/overview-data-queries","routeSlug":"/overview-data-queries","items":[],"content":{"contentType":"group","meta":{"name":"overview-data-queries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data queries: Introduction","showPageActions":true},{"nodeType":"markdoc","content":"These end points allow you to retrieve aggregated data from the warehouse.\nResults are provided by analytics back-end and as such very closely match the result sets we provide to end users through our portal and newsletters.\nHence these end points can be most readily used to get such data sets integrated to other customer systems also.\nYou'll minimally need to provide dimensions you want to group data over and metrics you'd like to see.\nYou can also additionally filter results by time, or by dimension values and sort your result set by given fields."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/overview-data-queries"}],"panels":[]}]}},{"type":"group","label":"Query data in tabular format","link":"/query-query-data-in-tabular-format","routeSlug":"/query-query-data-in-tabular-format","items":[{"label":"Query data as JSON","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/query-query-data-in-tabular-format/querydatatablejson","routeSlug":"/query-query-data-in-tabular-format/querydatatablejson","metadata":{"seo":{"title":"Query data as JSON","description":"POST https://api.zoined.com/v2/query/table"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDataTableJson","name":"Query data as JSON","isWebhook":false,"pointer":"/paths/~1v2~1query~1table/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query data as JSON","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/query/table"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve tabular data in JSON format (flat array with one element per group)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84","pointer":"/paths/~1v2~1query~1table/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/query/table","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_84"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/query/table","href":"/query-query-data-in-tabular-format/querydatatablejson","openApiOperationId":"queryDataTableJson","summary":"Query data as JSON"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1v2~1query~1table/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_85","exampleIds":["paths/~1v2~1query~1table/post/responses/200/content/application~1json/examples/response"],"headers":{"X-Zoined-Total-Items":{"schema":{"type":"string"},"example":"30"},"X-Zoined-Limit":{"schema":{"type":"string"},"example":"1000"},"X-Zoined-Offset":{"schema":{"type":"string"},"example":"0"}},"headerSchemaId":"schema_86"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1table/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1table/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1query~1table/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_85","exampleIds":["paths/~1v2~1query~1table/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1v2~1query~1table/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1table/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1table/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-query-data-in-tabular-format/querydatatablejson"}],"panels":[]}]},"httpPath":"/v2/query/table"},{"label":"Query data as CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/query-query-data-in-tabular-format/querydatatablecsv","routeSlug":"/query-query-data-in-tabular-format/querydatatablecsv","metadata":{"seo":{"title":"Query data as CSV","description":"POST https://api.zoined.com/v2/query/table.csv?includeNames=false&namesOnly=false"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDataTableCsv","name":"Query data as CSV","isWebhook":false,"pointer":"/paths/~1v2~1query~1table.csv/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query data as CSV","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/query/table.csv?includeNames=false&namesOnly=false"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve tabular data in CSV format. First row contains headers (field names for dimensions and metrics), and rest of the rows contain data values."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeNames","in":"query","schemaId":"schema_0","description":"If true also include names for dimensions, not just ids","example":"false"},{"name":"namesOnly","in":"query","schemaId":"schema_0","description":"If true only include names for dimensions, omit ids","example":"false"}],"pointer":"/paths/~1v2~1query~1table.csv/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84","pointer":"/paths/~1v2~1query~1table.csv/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/query/table.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"includeNames","in":"query","required":false,"example":"false","schemaId":"schema_0"},{"name":"namesOnly","in":"query","required":false,"example":"false","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_84"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/query/table.csv","href":"/query-query-data-in-tabular-format/querydatatablecsv","openApiOperationId":"queryDataTableCsv","summary":"Query data as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request has been processed successfully.","mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1query~1table.csv/post/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1query~1table.csv/post/responses/200/content/application~1csv/examples/response"],"headers":{"X-Zoined-Total-Items":{"schema":{"type":"string"},"example":"30"},"X-Zoined-Limit":{"schema":{"type":"string"},"example":"1000"},"X-Zoined-Offset":{"schema":{"type":"string"},"example":"0"}},"headerSchemaId":"schema_86"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1query~1table.csv/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1query~1table.csv/post/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1table.csv/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-query-data-in-tabular-format/querydatatablecsv"}],"panels":[]}]},"httpPath":"/v2/query/table.csv"}],"content":{"contentType":"group","meta":{"name":"query-query-data-in-tabular-format"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query data in tabular format","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":"Returns requested dimensions and metrics as either JSON array or CSV table."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is limited by default to 1000 entries and pagination information can be found"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Zoined-*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/query/table","summary":"Query data as JSON","prefix":{"name":"post","color":"post"},"badges":[],"link":"/query-query-data-in-tabular-format/querydatatablejson","deprecated":false},{"title":"/v2/query/table.csv","summary":"Query data as CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/query-query-data-in-tabular-format/querydatatablecsv","deprecated":false}]}]}]}]}},{"type":"group","label":"Query data in stream format","link":"/query-query-data-in-stream-format","routeSlug":"/query-query-data-in-stream-format","items":[{"label":"Query data as JSON stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/query-query-data-in-stream-format/querydatastreamjson","routeSlug":"/query-query-data-in-stream-format/querydatastreamjson","metadata":{"seo":{"title":"Query data as JSON stream","description":"POST https://api.zoined.com/v2/query/stream"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDataStreamJson","name":"Query data as JSON stream","isWebhook":false,"pointer":"/paths/~1v2~1query~1stream/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query data as JSON stream","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/query/stream"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve stream data in JSON format (flat array with one element per group)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84","pointer":"/paths/~1v2~1query~1stream/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/query/stream","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_84"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/query/stream","href":"/query-query-data-in-stream-format/querydatastreamjson","openApiOperationId":"queryDataStreamJson","summary":"Query data as JSON stream"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1v2~1query~1stream/post/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_85","exampleIds":["paths/~1v2~1query~1stream/post/responses/200/content/application~1json/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1stream/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1stream/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1query~1stream/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_85","exampleIds":["paths/~1v2~1query~1stream/post/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1v2~1query~1stream/post/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1stream/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1stream/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-query-data-in-stream-format/querydatastreamjson"}],"panels":[]}]},"httpPath":"/v2/query/stream"},{"label":"Query data as CSV stream","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/query-query-data-in-stream-format/querydatastreamcsv","routeSlug":"/query-query-data-in-stream-format/querydatastreamcsv","metadata":{"seo":{"title":"Query data as CSV stream","description":"POST https://api.zoined.com/v2/query/stream.csv?includeNames=false&namesOnly=false"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryDataStreamCsv","name":"Query data as CSV stream","isWebhook":false,"pointer":"/paths/~1v2~1query~1stream.csv/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query data as CSV stream","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":"POST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/v2/query/stream.csv?includeNames=false&namesOnly=false"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve stream data in CSV format. First row contains headers (field names for dimensions and metrics), and rest of the rows contain data values."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeNames","in":"query","schemaId":"schema_0","description":"If true also include names for dimensions, not just ids","example":"false"},{"name":"namesOnly","in":"query","schemaId":"schema_0","description":"If true only include names for dimensions, omit ids","example":"false"}],"pointer":"/paths/~1v2~1query~1stream.csv/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84","pointer":"/paths/~1v2~1query~1stream.csv/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/query/stream.csv","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"includeNames","in":"query","required":false,"example":"false","schemaId":"schema_0"},{"name":"namesOnly","in":"query","required":false,"example":"false","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_84"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/query/stream.csv","href":"/query-query-data-in-stream-format/querydatastreamcsv","openApiOperationId":"queryDataStreamCsv","summary":"Query data as CSV stream"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request has been processed successfully."},"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":"Headers"},"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":"Content-Type: application/csv"},"children":[]}]}]}]}],"mediaType":"application/csv","mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/200/content/application~1csv/examples/response"]}},"exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/200/content/application~1csv/examples/response"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid or malformed request."},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1v2~1query~1stream.csv/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/200/content/application~1csv/examples/response"],"mediaTypes":["application/csv"],"mediaTypeContent":{"application/csv":{"exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/200/content/application~1csv/examples/response"]}}},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1v2~1query~1stream.csv/post/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-query-data-in-stream-format/querydatastreamcsv"}],"panels":[]}]},"httpPath":"/v2/query/stream.csv"}],"content":{"contentType":"group","meta":{"name":"query-query-data-in-stream-format"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query data in stream format","showPageActions":true},{"nodeType":"markdoc","content":"Returns requested dimensions and metrics as either JSON array or CSV table.\nEntire flat data set returned by request is always fetched as a streamed http response which client should store in one go.\nStreamed requests are ideal for fetching large base data sets quickly but they have certain limitations\nincluding no support for things like custom result set sorting, secondary aggregation or grouped series."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/query/stream","summary":"Query data as JSON stream","prefix":{"name":"post","color":"post"},"badges":[],"link":"/query-query-data-in-stream-format/querydatastreamjson","deprecated":false},{"title":"/v2/query/stream.csv","summary":"Query data as CSV stream","prefix":{"name":"post","color":"post"},"badges":[],"link":"/query-query-data-in-stream-format/querydatastreamcsv","deprecated":false}]}]}]}]}},{"type":"separator","label":"Maintenance","content":null},{"type":"group","label":"Data maintenance: Introduction","link":"/overview-maintenance","routeSlug":"/overview-maintenance","items":[],"content":{"contentType":"group","meta":{"name":"overview-maintenance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data maintenance: Introduction","showPageActions":true},{"nodeType":"markdoc","content":"These endpoints allow you to do maintenance operations for warehouse."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/overview-maintenance"}],"panels":[]}]}},{"type":"group","label":"Data","link":"/maintenance-data","routeSlug":"/maintenance-data","items":[{"label":"Reset all data in the warehouse","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/maintenance-data/resetwarehousedata","routeSlug":"/maintenance-data/resetwarehousedata","metadata":{"seo":{"title":"Reset all data in the warehouse","description":"DELETE https://api.zoined.com/data?entity=sales"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resetWarehouseData","name":"Reset all data in the warehouse","isWebhook":false,"pointer":"/paths/~1data/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset all data in the warehouse","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":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/data?entity=sales"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows one to do full or selective reset to data in the warehouse. This will allow one to start from clean state if something goes wrong while working with the integration or alternatively just remove some single/multiple bad data set(s). It is only possible to use this API before transitioning to production. After that you'll need to contact Zoined Support if you have need for full or partial warehouse reset. Entity names for selective reset are end point names in lower case and singular form eg. sales, salespayment, salesorder, organisation, product etc."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entity","in":"query","schemaId":"schema_1","description":"Optional entity/entities to truncate instead of all data.","example":"sales"}],"pointer":"/paths/~1data/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/data","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[],"query":[{"name":"entity","in":"query","required":false,"example":"sales","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["204","400","401","500"],"pointer":"/data","href":"/maintenance-data/resetwarehousedata","openApiOperationId":"resetWarehouseData","summary":"Reset all data in the warehouse"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Warehouse data has been reset successfully."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request (eg. unknown entity 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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data/delete/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data/delete/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data/delete/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1data/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data/delete/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-data/resetwarehousedata"}],"panels":[]}]},"httpPath":"/data"},{"label":"Selectively delete by given list of ids","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/maintenance-data/deleteentitydatabyids","routeSlug":"/maintenance-data/deleteentitydatabyids","metadata":{"seo":{"title":"Selectively delete by given list of ids","description":"DELETE https://api.zoined.com/data/sales/id?ids=12345&sourceSystem=myPos"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntityDataByIds","name":"Selectively delete by given list of ids","isWebhook":false,"pointer":"/paths/~1data~1{entity}~1id/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Selectively delete by given list of ids","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":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/data/sales/id?ids=12345&sourceSystem=myPos"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows deleting existing transaction data by giving a list of transaction or entity id values already existing in the warehouse. Entity name for selective deletion is one of the end point names in lower case and singular form eg. sales, salespayment, salesorder, organisation, product etc."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_1","description":"Entity name to for this delete operation.","required":true,"example":"sales"}],"pointer":"/paths/~1data~1{entity}~1id/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_1","description":"id values to identify transactions to be removed can be repeated for multiple values.","required":true,"example":"12345"},{"name":"sourceSystem","in":"query","schemaId":"schema_1","description":"Optional source system value to limit delete operation to.","example":"myPos"}],"pointer":"/paths/~1data~1{entity}~1id/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/data/{entity}/id","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"example":"sales","schemaId":"schema_1"}],"query":[{"name":"ids","in":"query","required":true,"example":"12345","schemaId":"schema_1"},{"name":"sourceSystem","in":"query","required":false,"example":"myPos","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["204","400","401","500"],"pointer":"/data/{entity}/id","href":"/maintenance-data/deleteentitydatabyids","openApiOperationId":"deleteEntityDataByIds","summary":"Selectively delete by given list of ids"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Data for the provided id values has been removed from warehouse."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request (eg. unknown entity 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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1data~1{entity}~1id/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1id/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-data/deleteentitydatabyids"}],"panels":[]}]},"httpPath":"/data/{entity}/id"},{"label":"Selectively delete by given date range","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/maintenance-data/deleteentitydatabydaterange","routeSlug":"/maintenance-data/deleteentitydatabydaterange","metadata":{"seo":{"title":"Selectively delete by given date range","description":"DELETE https://api.zoined.com/data/sales/daterange?start=2024-10-01&end=2024-10-31&store=1234&sourceSystem=myPos"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntityDataByDateRange","name":"Selectively delete by given date range","isWebhook":false,"pointer":"/paths/~1data~1{entity}~1daterange/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Selectively delete by given date range","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":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/data/sales/daterange?start=2024-10-01&end=2024-10-31&store=1234&sourceSystem=myPos"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint allows deleting existing transaction data by giving a date range (eg. two sales dates) for data already existing in the warehouse. Entity name for selective deletion is one of the end point names in lower case and singular form eg. sales, salespayment, salesorder, organisation, product etc."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_1","description":"Entity name to for this delete operation.","required":true,"example":"sales"}],"pointer":"/paths/~1data~1{entity}~1daterange/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_1","description":"Start date for the date range.","required":true,"example":"2024-10-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"End date for the date range.","required":true,"example":"2024-10-31"},{"name":"store","in":"query","schemaId":"schema_1","description":"Optional store id to limit delete operation to.","example":"1234"},{"name":"sourceSystem","in":"query","schemaId":"schema_1","description":"Optional source system value to limit delete operation to.","example":"myPos"}],"pointer":"/paths/~1data~1{entity}~1daterange/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/data/{entity}/daterange","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"example":"sales","schemaId":"schema_1"}],"query":[{"name":"start","in":"query","required":true,"example":"2024-10-01","schemaId":"schema_1"},{"name":"end","in":"query","required":true,"example":"2024-10-31","schemaId":"schema_1"},{"name":"store","in":"query","required":false,"example":"1234","schemaId":"schema_1"},{"name":"sourceSystem","in":"query","required":false,"example":"myPos","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["204","400","401","500"],"pointer":"/data/{entity}/daterange","href":"/maintenance-data/deleteentitydatabydaterange","openApiOperationId":"deleteEntityDataByDateRange","summary":"Selectively delete by given date range"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Data for the provided date range has been removed from warehouse."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request (eg. unknown entity 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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1data~1{entity}~1daterange/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1daterange/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-data/deleteentitydatabydaterange"}],"panels":[]}]},"httpPath":"/data/{entity}/daterange"},{"label":"Selectively delete by given batch date range","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/maintenance-data/deleteentitydatabybatchdaterange","routeSlug":"/maintenance-data/deleteentitydatabybatchdaterange","metadata":{"seo":{"title":"Selectively delete by given batch date range","description":"DELETE https://api.zoined.com/data/sales/batchdate?start=2024-10-01&end=2024-10-31&store=1234&sourceSystem=myPos"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntityDataByBatchDateRange","name":"Selectively delete by given batch date range","isWebhook":false,"pointer":"/paths/~1data~1{entity}~1batchdate/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Selectively delete by given batch date range","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":"DELETE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.zoined.com/data/sales/batchdate?start=2024-10-01&end=2024-10-31&store=1234&sourceSystem=myPos"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint allows deleting existing transaction data by giving a batch date range (ie. data receipt timestamp) for data already existing in the warehouse. This endpoint is handy if you want to for example delete eg. all data send to Zoined within last 7 days (to resend it later). Entity name for selective deletion is one of the end point names in lower case and singular form eg. sales, salespayment, salesorder, organisation, product etc."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_1","description":"Entity name to for this delete operation.","required":true,"example":"sales"}],"pointer":"/paths/~1data~1{entity}~1batchdate/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_1","description":"Start date for the date range.","required":true,"example":"2024-10-01"},{"name":"end","in":"query","schemaId":"schema_1","description":"End date for the date range. Default today.","example":"2024-10-31"},{"name":"store","in":"query","schemaId":"schema_1","description":"Optional store id to limit delete operation to.","example":"1234"},{"name":"sourceSystem","in":"query","schemaId":"schema_1","description":"Optional source system value to limit delete operation to.","example":"myPos"}],"pointer":"/paths/~1data~1{entity}~1batchdate/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/data/{entity}/batchdate","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"example":"sales","schemaId":"schema_1"}],"query":[{"name":"start","in":"query","required":true,"example":"2024-10-01","schemaId":"schema_1"},{"name":"end","in":"query","required":false,"example":"2024-10-31","schemaId":"schema_1"},{"name":"store","in":"query","required":false,"example":"1234","schemaId":"schema_1"},{"name":"sourceSystem","in":"query","required":false,"example":"myPos","schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token"}],"scopes":[]}],"responseCodes":["204","400","401","500"],"pointer":"/data/{entity}/batchdate","href":"/maintenance-data/deleteentitydatabybatchdaterange","openApiOperationId":"deleteEntityDataByBatchDateRange","summary":"Selectively delete by given batch date range"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.zoined.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Data for the provided batch date range has been removed from warehouse."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request (eg. unknown entity 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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/400/content/application~1json/examples/response"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid authorization token in header"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/401/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/401/content/application~1json/examples/response"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal error or exception"},"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":"Headers"},"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":"Content-Type: application/json"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/500/content/application~1json/examples/response"]}},"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/500/content/application~1json/examples/response"]}],"pointer":"/paths/~1data~1{entity}~1batchdate/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/400/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage401","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/401/content/application~1json/examples/response"]}}},{"code":"500","schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/500/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorMessage","exampleIds":["paths/~1data~1{entity}~1batchdate/delete/responses/500/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-data/deleteentitydatabybatchdaterange"}],"panels":[]}]},"httpPath":"/data/{entity}/batchdate"}],"content":{"contentType":"group","meta":{"name":"maintenance-data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data","summary":"Reset all data in the warehouse","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/maintenance-data/resetwarehousedata","deprecated":false},{"title":"/data/{entity}/id","summary":"Selectively delete by given list of ids","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/maintenance-data/deleteentitydatabyids","deprecated":false},{"title":"/data/{entity}/daterange","summary":"Selectively delete by given date range","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/maintenance-data/deleteentitydatabydaterange","deprecated":false},{"title":"/data/{entity}/batchdate","summary":"Selectively delete by given batch date range","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/maintenance-data/deleteentitydatabybatchdaterange","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Calendar":{"id":"components/schemas/Calendar","kind":"json-schema","title":"Calendar","data":{"type":"object","required":["calendar_date"],"properties":{"calendar_date":{"type":"string","example":"2016-01-01","description":"Calendar date (yyyy-mm-dd)"},"calendar_year":{"type":"string","example":"2016/2017","description":"Calendar year"},"period_name":{"type":"string","example":"January","description":"Period name"},"period_number":{"type":"number","example":1,"description":"Period number"},"week_number":{"type":"number","example":1,"description":"Week number"},"season":{"type":"string","example":"Spring 2016","description":"Season name"},"season_label":{"type":"string","example":"Spring","description":"Season identifier"},"lfl_date":{"type":"string","example":"2014-12-30","description":"Comparable sales date year ago (yyyy-mm-dd)"},"bank_holiday_name":{"type":"string","example":"New year Day","description":"Name of bank holiday if any"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Capacity":{"id":"components/schemas/Capacity","kind":"json-schema","title":"Capacity","data":{"type":"object","required":["organisation_id","capacity_date","capacity_type","max_capacity"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation ID"},"product_id":{"type":"string","example":"123","description":"A (string, required) - Product ID"},"event_id":{"type":"string","example":"221","description":"Event ID"},"capacity_date":{"type":"string","example":"2020-02-01","description":"Date of capacity (yyyy-mm-dd)"},"capacity_time":{"type":"string","example":"15:00:00","description":"Time of capacity (HH:mm:ss)."},"capacity_type":{"type":"string","example":"event","description":"Capacity type. Must be either event, ticket or room."},"max_capacity":{"type":"number","example":100,"description":"Maximum available capacity for this item."},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Accounting":{"id":"components/schemas/Accounting","kind":"json-schema","title":"Accounting","data":{"type":"object","required":["transaction_id","line_item_id","organisation_id","account_id","event_date","receipt_type"],"properties":{"transaction_id":{"type":"string","example":"1234","description":"Unique ID for this accounting receipt"},"line_item_id":{"type":"string","example":"1","description":"Unique ID for this accounting receipt line item"},"organisation_id":{"type":"string","example":"540","description":"Organisation/Store ID"},"department_id":{"type":"string","example":"5401","description":"Store department ID"},"account_id":{"type":"string","example":"1150","description":"Account ID"},"event_date":{"type":"string","example":"2016-01-01","description":"Event date (yyyy-mm-dd)"},"event_time":{"type":"string","example":"15:00:00","description":"Event time (HH:mm:ss)"},"receipt_type":{"type":"string","description":"Receipt type","enum":["income","cost","asset","liability"],"x-enumDescriptions":{"income":"This receipt is income for the company in income statement","cost":"This receipt is cost for the company in income statement","asset":"This receipt is balance sheet asset (eg. property) for the company","liability":"This receipt is balance sheet liability (eg. debt) for the company"},"example":"cost"},"receipt_number":{"type":"string","example":"12345","description":"XZY (string, optional) - Optional bookkeeping receipt number"},"receipt_value":{"type":"number","example":2000,"description":"Total amount of this line item"},"receipt_value_wo_vat":{"type":"number","example":1600,"description":"Total amount of this line item without taxes"},"currency":{"type":"string","example":"EUR","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used."},"cancelled":{"type":"boolean","example":true,"description":"If set then this receipt has been cancelled."},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/DataUploadSuccessMessage":{"id":"components/schemas/DataUploadSuccessMessage","kind":"json-schema","title":"DataUploadSuccessMessage","data":{"type":"object","required":["status","msg"],"properties":{"status":{"type":"string","example":"OK","description":"Status of the operation OK / Not OK"},"msg":{"type":"string","example":"1 entity added","description":"Message describing result of operation"}}}},"components/schemas/BudgetEntry":{"id":"components/schemas/BudgetEntry","kind":"json-schema","title":"BudgetEntry","data":{"type":"object","required":["year","dimensions","metrics"],"properties":{"year":{"type":"number","example":2017,"description":"Year this budget entry refers to"},"month":{"type":"number","example":1,"description":"Month this budget entry refers to. Either month or week must be there."},"week":{"type":"number","example":12,"description":"Week number this budget entry refers to. Either month or week must be there."},"day":{"type":"number","example":1,"description":"Optional day this budget entry refers to"},"hour":{"type":"number","example":1,"description":"Optional hour this budget refers to. Day must be also specified if hour is specified."},"dimensions":{"type":"object","properties":{},"description":"Key-value pairs of dimensions and values for entry"},"metrics":{"type":"object","properties":{},"description":"Key-value pairs of metric values for given time and dimensions"}}}},"components/schemas/CampaignProduct":{"id":"components/schemas/CampaignProduct","kind":"json-schema","title":"CampaignProduct","data":{"type":"object","required":["campaign_id","product_id"],"properties":{"campaign_id":{"type":"string","example":"6453","description":"Campaign ID"},"category_id":{"type":"string","example":"My category ID","description":"Associated Category ID"},"product_id":{"type":"string","example":"My product ID","description":"Associated Product ID"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Campaign":{"id":"components/schemas/Campaign","kind":"json-schema","title":"Campaign","data":{"type":"object","required":["campaign_id","campaign_name"],"properties":{"campaign_id":{"type":"string","example":"6344","description":"Campaign ID"},"campaign_name":{"type":"string","example":"February 2016","description":"Campaign name"},"campaign_type":{"type":"string","example":"Web","description":"Campaign type"},"start_date":{"type":"string","example":"2016-02-01","description":"Campaign Start Date (yyyy-mm-dd)"},"end_date":{"type":"string","example":"2016-02-29","description":"Campaign End Date (yyyy-mm-dd)"},"organisation_id":{"type":"string","example":"540","description":"Organisation ID"},"custom_field_1":{"type":"string","example":"New","description":"Custom Field 1"},"custom_field_2":{"type":"string","example":"New","description":"Custom Field 2"},"custom_field_3":{"type":"string","example":"New","description":"Custom Field 3"},"custom_field_4":{"type":"string","example":"New","description":"Custom Field 4"},"custom_field_5":{"type":"string","example":"New","description":"Custom Field 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/SalesCampaign":{"id":"components/schemas/SalesCampaign","kind":"json-schema","title":"SalesCampaign","data":{"type":"object","required":["transaction_id","line_item_id","campaign_id"],"properties":{"transaction_id":{"type":"string","example":"T1234","description":"ID for transaction this campaign attaches to"},"line_item_id":{"type":"string","example":"1","description":"Line ID in a transaction this campaign attaches to"},"campaign_id":{"type":"string","example":"6344","description":"Campaign ID"},"campaign_type":{"type":"string","example":"sales","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Type (origin) of campaign record ('sales', 'salesorder', 'salesoffer')"},"children":[]}]}]}]},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"type":"object","required":["customer_id"],"properties":{"customer_id":{"type":"string","example":"32","description":"Customer ID"},"customer_name":{"type":"string","example":"John Smith","description":"Customer Name"},"customer_company":{"type":"string","example":"Smith Industries","description":"Customer Company"},"customer_email":{"type":"string","example":"john.smith@customer.customer","description":"Customer Email"},"customer_phone":{"type":"string","example":"+35811111111","description":"Customer Phone"},"customer_address":{"type":"string","example":"Mannerheimintie 1","description":"Customer Street Address"},"customer_zipcode":{"type":"string","example":"00100","description":"Customer's Zip Code"},"customer_city":{"type":"string","example":"Helsinki","description":"Customer City"},"customer_country":{"type":"string","example":"Finland","description":"Customer Country"},"customer_group_id":{"type":"string","example":"2","description":"Customer Group ID"},"customer_group_name":{"type":"string","example":"B2","description":"Customer Group Name"},"account_number":{"type":"string","example":"X5434","description":"Account Number"},"vat_number":{"type":"string","example":"12345678","description":"9 (string, optional) - VAT Number"},"organisation_id":{"type":"string","example":"1","description":"Customer account store ID"},"salesperson_id":{"type":"string","example":"123","description":"Sales person id responsible for this customer account."},"creation_date":{"type":"string","example":"2021-12-15","description":"Date when this customer was added to system (yyyy-mm-dd)."},"subscribe_date":{"type":"string","example":"2022-01-15","description":"Date when this customer subscribed newsletter (yyyy-mm-dd)."},"unsubscribe_date":{"type":"string","example":"2022-02-15","description":"Date when this customer unsubscribed newsletter (yyyy-mm-dd)."},"register_date":{"type":"string","example":"2022-01-10","description":"Date when this customer registered to system (yyyy-mm-dd)."},"unregister_date":{"type":"string","example":"2022-03-15","description":"Date when this customer unregistered from system (yyyy-mm-dd)."},"hierarchy_level_1":{"type":"string","example":"A1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 1. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}]},"hierarchy_level_2":{"type":"string","example":"Family shoppers","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 2. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}]},"hierarchy_level_3":{"type":"string","example":"Families with babies","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 3. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}]},"hierarchy_level_4":{"type":"string","example":"A4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 4. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}]},"hierarchy_level_5":{"type":"string","example":"A5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 5. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}]},"custom_dimension_1":{"type":"string","example":"Class 3","description":"Custom Field 1"},"custom_dimension_2":{"type":"string","example":"Class 2","description":"Custom Field 2"},"custom_dimension_3":{"type":"string","example":"Class 1","description":"Custom Field 3"},"custom_dimension_4":{"type":"string","example":"XYZ","description":"Custom Field 4"},"custom_dimension_5":{"type":"string","example":"XYZ","description":"Custom Field 5"},"custom_dimension_6":{"type":"string","example":"Class 3","description":"Custom Field 6"},"custom_dimension_7":{"type":"string","example":"Class 3","description":"Custom Field 7"},"custom_dimension_8":{"type":"string","example":"Class 3","description":"Custom Field 8"},"custom_dimension_9":{"type":"string","example":"Class 3","description":"Custom Field 9"},"custom_dimension_10":{"type":"string","example":"Class 3","description":"Custom Field 10"},"custom_dimension_11":{"type":"string","example":"Class 3","description":"Custom Field 11"},"custom_dimension_12":{"type":"string","example":"Class 3","description":"Custom Field 12"},"custom_dimension_13":{"type":"string","example":"Class 3","description":"Custom Field 13"},"custom_dimension_14":{"type":"string","example":"Class 3","description":"Custom Field 14"},"custom_dimension_15":{"type":"string","example":"Class 3","description":"Custom Field 15"},"custom_dimension_16":{"type":"string","example":"Class 3","description":"Custom Field 16"},"custom_dimension_17":{"type":"string","example":"Class 3","description":"Custom Field 17"},"custom_dimension_18":{"type":"string","example":"Class 3","description":"Custom Field 18"},"custom_dimension_19":{"type":"string","example":"Class 3","description":"Custom Field 19"},"custom_dimension_20":{"type":"string","example":"Class 3","description":"Custom Field 20"},"custom_dimension_21":{"type":"string","example":"Class 3","description":"Custom Field 21"},"custom_dimension_22":{"type":"string","example":"Class 3","description":"Custom Field 22"},"custom_dimension_23":{"type":"string","example":"Class 3","description":"Custom Field 23"},"custom_dimension_24":{"type":"string","example":"Class 3","description":"Custom Field 24"},"custom_dimension_25":{"type":"string","example":"Class 3","description":"Custom Field 25"},"custom_dimension_26":{"type":"string","example":"Class 3","description":"Custom Field 26"},"custom_dimension_27":{"type":"string","example":"Class 3","description":"Custom Field 27"},"custom_dimension_28":{"type":"string","example":"Class 3","description":"Custom Field 28"},"custom_dimension_29":{"type":"string","example":"Class 3","description":"Custom Field 29"},"custom_dimension_30":{"type":"string","example":"Class 3","description":"Custom Field 30"},"custom_dimension_31":{"type":"string","example":"Class 3","description":"Custom Field 31"},"custom_dimension_32":{"type":"string","example":"Class 3","description":"Custom Field 32"},"custom_dimension_33":{"type":"string","example":"Class 3","description":"Custom Field 33"},"custom_dimension_34":{"type":"string","example":"Class 3","description":"Custom Field 34"},"custom_dimension_35":{"type":"string","example":"Class 3","description":"Custom Field 35"},"custom_dimension_36":{"type":"string","example":"Class 3","description":"Custom Field 36"},"custom_dimension_37":{"type":"string","example":"Class 3","description":"Custom Field 37"},"custom_dimension_38":{"type":"string","example":"Class 3","description":"Custom Field 38"},"custom_dimension_39":{"type":"string","example":"Class 3","description":"Custom Field 39"},"custom_dimension_40":{"type":"string","example":"Class 3","description":"Custom Field 40"},"custom_dimension_41":{"type":"string","example":"Class 3","description":"Custom Field 41"},"custom_dimension_42":{"type":"string","example":"Class 3","description":"Custom Field 42"},"custom_dimension_43":{"type":"string","example":"Class 3","description":"Custom Field 43"},"custom_dimension_44":{"type":"string","example":"Class 3","description":"Custom Field 44"},"custom_dimension_45":{"type":"string","example":"Class 3","description":"Custom Field 45"},"custom_dimension_46":{"type":"string","example":"Class 3","description":"Custom Field 46"},"custom_dimension_47":{"type":"string","example":"Class 3","description":"Custom Field 47"},"custom_dimension_48":{"type":"string","example":"Class 3","description":"Custom Field 48"},"custom_dimension_49":{"type":"string","example":"Class 3","description":"Custom Field 49"},"custom_dimension_50":{"type":"string","example":"Class 3","description":"Custom Field 50"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/CustomerFeedback":{"id":"components/schemas/CustomerFeedback","kind":"json-schema","title":"CustomerFeedback","data":{"type":"object","required":["feedback_id","organisation_id","feedback_date","grade"],"properties":{"feedback_id":{"type":"string","example":"xyz","description":"Unique ID for this feedback entry"},"respondent_id":{"type":"string","example":"1234","description":"Optional ID for survey respondent. Can be used to group all responses by single respondent."},"survey_id":{"type":"string","example":"Survey 1","description":"Optional ID for survey. Can be used to separate responses between different surveys."},"question_id":{"type":"string","example":"Q1","description":"Optional ID for feedback question. Should be used if multiple separate feedback questions are needed."},"organisation_id":{"type":"string","example":"ORG1","description":"Identifier of store this feedback entry refers to"},"department_id":{"type":"string","example":"DEP1","description":"Optional identifier of department this feedback entry refers to"},"feedback_date":{"type":"string","example":"2018-01-01","description":"Date of feedback (yyyy-mm-dd)"},"feedback_time":{"type":"string","example":"15:00:00","description":"Optional time of feedback (hh:mm:ss)"},"feedback_type":{"type":"string","example":"Store survey","description":"Optional type of feedback"},"main_feedback":{"type":"boolean","example":true,"description":"Is this main (overall grade) feedback. Default is true."},"grade":{"type":"number","example":9,"description":"Numerical grade for feedback"},"grade_total":{"type":"number","example":8.5,"description":"Optional numerical total grade calculated by source (eg. Google Review) for feedback"},"comments":{"type":"string","example":"Great service today!","description":"Optional free form feedback"},"comments_en":{"type":"string","example":"Great service today!","description":"Optional free form feedback translated in English"},"review_url":{"type":"string","example":"https://www.google.com/maps/reviews?data=XYZ","description":"Google review URL"},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/CashierBalance":{"id":"components/schemas/CashierBalance","kind":"json-schema","title":"CashierBalance","data":{"type":"object","required":["organisation_id","payment_method","sales_date","transaction_count","shift_amount"],"properties":{"organisation_id":{"type":"string","example":"ORG1","description":"Identifier of store for this balance"},"department_id":{"type":"string","example":"DEP1","description":"Optional identifier of department for this balance"},"register_id":{"type":"string","example":"123","description":"Optional cash register identifier for this balance"},"batch_id":{"type":"string","example":"1","description":"Optional batch or shift identifier for this balance row"},"payment_method":{"type":"string","example":"Cash","description":"Payment method of this balance row"},"sales_date":{"type":"string","example":"2018-01-01","description":"Date of balance (yyyy-mm-dd)"},"sales_time":{"type":"string","example":"15:00:00","description":"Optional time of balance (hh:mm:ss)"},"batch_status":{"type":"string","example":"OK","description":"Optional status of this batch ID"},"transaction_count":{"type":"number","example":9,"description":"Number of transactions for this shift and payment method"},"shift_amount":{"type":"number","example":1000,"description":"Total amount of payments for this shift and payment method"},"over_short":{"type":"number","example":100,"description":"Difference in money between sales and shift amounts"},"cash_dropped":{"type":"number","example":0,"description":"How much cash was dropped from register during this shift"},"cash_paid_out":{"type":"number","example":50,"description":"How much cash was paid out from register during this shift"},"currency":{"type":"string","example":"EUR","description":"Shift currency as ISO 4217 currency code. Required if multiple currencies are used by the customer."},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Department":{"id":"components/schemas/Department","kind":"json-schema","title":"Department","data":{"type":"object","required":["department_id","name"],"properties":{"department_id":{"type":"string","example":"123","description":"Department ID"},"name":{"type":"string","example":"Women's clothing","description":"Human readable name for the deparment"},"floor_area":{"type":"number","example":20,"description":"Floor area of deparment in square meters"},"organisation_id":{"type":"string","example":"234","description":"ID of attached organisation"},"no_customer_seats":{"type":"number","example":50,"description":"Number of customer seats available"},"custom_dimension1":{"type":"string","example":"Class 3","description":"Custom Field 1"},"custom_dimension2":{"type":"string","example":"New","description":"Custom Field 2"},"custom_dimension3":{"type":"string","example":"Old","description":"Custom Field 3"},"custom_dimension4":{"type":"string","example":"New","description":"Custom Field 4"},"custom_dimension5":{"type":"string","example":"New","description":"Custom Field 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/CashRegister":{"id":"components/schemas/CashRegister","kind":"json-schema","title":"CashRegister","data":{"type":"object","required":["register_id","register_name"],"properties":{"register_id":{"type":"string","example":"123-1","description":"Register ID"},"register_name":{"type":"string","example":"Kiosk 1","description":"Register name"},"organisation_id":{"type":"string","example":"540","description":"Organisation / store this register belongs to"},"register_type":{"type":"string","example":"Kiosk","description":"Register type"},"register_group":{"type":"string","example":"Self service","description":"Register group"},"custom_dimension1":{"type":"string","example":"Class 3","description":"Custom Field 1"},"custom_dimension2":{"type":"string","example":"Class 3","description":"Custom Field 2"},"custom_dimension3":{"type":"string","example":"Class 3","description":"Custom Field 3"},"custom_dimension4":{"type":"string","example":"Class 3","description":"Custom Field 4"},"custom_dimension5":{"type":"string","example":"Class 3","description":"Custom Field 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/EmployeeHour":{"id":"components/schemas/EmployeeHour","kind":"json-schema","title":"EmployeeHour","data":{"type":"object","required":["organisation_id","date","time","hours"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation / Store ID"},"department_id":{"type":"string","example":"54021","description":"Store department ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"employee_type":{"type":"string","example":"Permie","description":"Employee Type"},"employeehours_id":{"type":"string","example":"4244","description":"Optional identifier for the entry"},"absence_code":{"type":"string","example":"BREAK","description":"Code for the absense if this entry describes absence."},"date":{"type":"string","example":"2016-01-01","description":"Date of entry (yyyy-mm-dd)"},"time":{"type":"string","example":"15:00:00","description":"Time of entry (HH:mm:ss)"},"scheduled":{"type":"boolean","example":false,"description":"Whether this is scheduled or punched shift, default is false"},"productive":{"type":"boolean","example":true,"description":"Whether this is productive or administrative work, default is true"},"hours":{"type":"number","example":8,"description":"Number of hours to record for this specific time"},"staff_cost":{"type":"number","example":500,"description":"Salary cost associated with this hour"},"breaks":{"type":"number","example":0.5,"description":"Total hours of breaks"},"breaks_cost":{"type":"number","example":40,"description":"Total salary cost associated for paid breaks"},"currency":{"type":"string","example":"EUR","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used."},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/StaffCost":{"id":"components/schemas/StaffCost","kind":"json-schema","title":"StaffCost","data":{"type":"object","required":["organisation_id","start_date","staff_cost"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation / Store ID"},"department_id":{"type":"string","example":"54021","description":"Store department ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"start_date":{"type":"string","example":"2024-01-01","description":"Start date of entry (yyyy-mm-dd)"},"staff_cost":{"type":"number","example":15,"description":"Hourly salary cost"},"currency":{"type":"string","example":"EUR","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used."},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/OpeningHour":{"id":"components/schemas/OpeningHour","kind":"json-schema","title":"OpeningHour","data":{"type":"object","required":["start_date","weekday","open_start","open_end"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation / Store ID. If omitted entry is treated as company default hours."},"start_date":{"type":"string","example":"2024-01-01","description":"Start date of opening hour season (yyyy-mm-dd)"},"end_date":{"type":"string","example":"2025-01-01","description":"End date of opening hour season (yyyy-mm-dd)"},"weekday":{"type":"number","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weekday as integer (1 = Monday, 7 = Sunday)"},"children":[]}]}]}]},"open_start":{"type":"string","example":"08:00:00","description":"Open start time (hh:mm:ss)"},"open_end":{"type":"string","example":"15:00:00","description":"Open end time (hh:mm:ss)"},"special_period":{"type":"boolean","example":false,"description":"Is this a special opening period"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/FlatHierarchy":{"id":"components/schemas/FlatHierarchy","kind":"json-schema","title":"FlatHierarchy","data":{"type":"object","required":["hierarchy_key","entity_id","level1"],"properties":{"hierarchy_key":{"type":"string","description":"Type of hierarchy that is uploaded","enum":["product","model","product_group","organisation","customer","channel","area","account"],"x-enumDescriptions":{"product":"Product category hierarchy","model":"Product model hierarchy","product_group":"Product group hierarchy","organisation":"Organisation hierarchy","customer":"Customer hierarchy","channel":"Channel hierarchy","area":"Area hierarchy","account":"Bookkeeping account hierarchy"},"example":"product"},"entity_id":{"type":"string","example":"XYZ","description":"Identifier for the lowest level entity in the hierarchy"},"level1":{"type":"string","example":"Clothing","description":"Name of root category level"},"level2":{"type":"string","example":"Children's clothing","description":"Name of category level 2"},"level3":{"type":"string","example":"Children's outdoor clothing","description":"Name of category level 3"},"level4":{"type":"string","example":"Children's outdoor headwear","description":"Name of category level 4"},"level5":{"type":"string","example":"Children's caps","description":"Name of category level 5"},"level6":{"type":"string","example":"Children's small caps","description":"Name of category level 6"},"level7":{"type":"string","example":"Children's themed caps","description":"Name of category level 7"},"level8":{"type":"string","example":"Children's disney caps","description":"Name of category level 8"},"level9":{"type":"string","example":"Children's mickey caps","description":"Name of category level 9"},"level10":{"type":"string","example":"Children's ...","description":"Name of category level 10"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/InventorySnapshot":{"id":"components/schemas/InventorySnapshot","kind":"json-schema","title":"InventorySnapshot","data":{"type":"object","required":["organisation_id","snapshot_date","product_id","quantity"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation / Store ID"},"snapshot_date":{"type":"string","example":"2016-01-01","description":"Date of snapshot (yyyy-mm-dd)"},"snapshot_time":{"type":"string","example":"15:00:00","description":"Time of snapshot (HH:mm:ss). Needed if inter-day inventory saldos are tracked."},"product_id":{"type":"string","example":"My product ID","description":"Product ID"},"supplier_id":{"type":"string","example":"221","description":"Supplier ID"},"quantity":{"type":"number","example":100,"description":"On hand quantity in inventory"},"available_quantity":{"type":"number","example":90,"description":"Available quantity in inventory (after pending/reserved orders)"},"reorder_point":{"type":"number","example":5,"description":"Quantity threshold for this item to order more into inventory"},"max_reorder_quantity":{"type":"number","example":10,"description":"Max quantity threshold for this item after reordering"},"unit_purchase_price":{"type":"number","example":12.4,"description":"Unit purchase price"},"unit_purchase_price_wo_vat":{"type":"number","example":10,"description":"Unit purchase price without tax"},"unit_sales_price":{"type":"number","example":22.4,"description":"Unit sales price"},"unit_sales_price_wo_vat":{"type":"number","example":20,"description":"Unit sales price without tax"},"currency":{"type":"string","example":"EUR","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used."},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/InventoryTransaction":{"id":"components/schemas/InventoryTransaction","kind":"json-schema","title":"InventoryTransaction","data":{"type":"object","required":["organisation_id","movement_date","quantity","movement_type"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation / Store ID"},"department_id":{"type":"string","example":"54011","description":"Department ID"},"salesperson_id":{"type":"string","example":"5401","description":"Sales person ID"},"operator_id":{"type":"string","example":"5402","description":"Operator ID"},"movement_date":{"type":"string","example":"2016-02-01","description":"Date of transaction (yyyy-mm-dd)"},"movement_time":{"type":"string","example":"15:00:00","description":"Time of transaction (HH:mm:ss)."},"delivered_date":{"type":"string","example":"2016-02-02","description":"Date of transaction completion (yyyy-mm-dd)"},"delivered_time":{"type":"string","example":"15:00:00","description":"Time of transaction completion (HH:mm:ss)."},"product_id":{"type":"string","example":"123","description":"1 (string, required) - Product ID"},"supplier_id":{"type":"string","example":"221","description":"Supplier ID"},"parent_product_id":{"type":"string","example":"123","description":"Parent Product ID"},"quantity":{"type":"number","example":100,"description":"Quantity moved from/to inventory"},"delivered_quantity":{"type":"number","example":90,"description":"Final quantity moved from/to inventory after completion."},"expected_quantity":{"type":"number","example":110,"description":"Quantity expected in inventory (for stock takes)."},"movement_type":{"type":"string","description":"Movement type","enum":["purchase","waste","transfer","stock_take","adjustment","sale","internal"],"x-enumDescriptions":{"purchase":"Products have been purchased to inventory","waste":"Products have been removed from inventory as waste","transfer":"Products have been transferred to another inventory location","stock_take":"Stock take has been done to correct inventory counts","adjustment":"Adjustments have been done to individual products to correct inventory counts","sale":"Products have been sold from inventory","internal":"Products have been used internally from inventory"},"example":"waste"},"movement_status":{"type":"number","example":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Movement status. 1=Open, 2=Complete, 3=Complete with variances, 4=Cancelled"},"children":[]}]}]}]},"movement_batch_id":{"type":"string","example":"june-stock-take","description":"Optional identifier for batch this movement row is part of."},"movement_batch_line_id":{"type":"string","example":"1","description":"Optional line id within the batch this movement row is part of."},"unit_purchase_price":{"type":"number","example":12.4,"description":"Unit purchase price"},"unit_purchase_price_wo_vat":{"type":"number","example":10,"description":"Unit purchase price without tax"},"unit_retail_price":{"type":"number","example":12.4,"description":"Unit retail (sales) price"},"unit_retail_price_wo_vat":{"type":"number","example":10,"description":"Unit retail (sales) price without tax"},"reason_code":{"type":"string","example":"Theft","description":"Optional reason code or description for this transaction"},"target_organisation_id":{"type":"string","example":"510","description":"Organisation / Store ID for target of inventory transfer. Mandatory for type transfer."},"currency":{"type":"string","example":"EUR","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used."},"purchase_order_id":{"type":"string","example":"1234","description":"Order id for purchase order this purchase movement originates from."},"purchase_order_line_id":{"type":"string","example":"1","description":"Order line item id in purchase order this purchase movement line item originates from."},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"custom_field_6":{"type":"string","example":"EU only","description":"Custom field 6"},"custom_field_7":{"type":"string","example":"EU only","description":"Custom field 7"},"custom_field_8":{"type":"string","example":"EU only","description":"Custom field 8"},"custom_field_9":{"type":"string","example":"EU only","description":"Custom field 9"},"custom_field_10":{"type":"string","example":"EU only","description":"Custom field 10"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/OrganisationUnit":{"id":"components/schemas/OrganisationUnit","kind":"json-schema","title":"OrganisationUnit","data":{"type":"object","required":["organisation_id","organisation_name"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation / Store ID"},"organisation_name":{"type":"string","example":"Web Sales","description":"Organisation name"},"street_address":{"type":"string","example":"Mannerheimintie 1","description":"Street address"},"city":{"type":"string","example":"Helsinki","description":"City"},"post_code":{"type":"string","example":"00100","description":"Postal code"},"state":{"type":"string","example":"Southern Finland","description":"State"},"country":{"type":"string","example":"Finland","description":"Country"},"area":{"type":"string","example":"South","description":"Sales area"},"latitude":{"type":"number","example":60.184014,"description":"Latitude"},"longitude":{"type":"number","example":24.960046,"description":"Longitude"},"channel":{"type":"string","example":"Concession","description":"Sales channel"},"organisation_type":{"type":"string","example":"Outlet","description":"Outlet / Brand / Essential"},"organisation_group":{"type":"string","example":"A","description":"Organisation group"},"floor_area":{"type":"number","example":123.5,"description":"Store floor area eg. in m2"},"no_customer_seats":{"type":"number","example":150,"description":"Number of customer seats in store"},"google_location_url":{"type":"string","example":"https://www.google.com/maps/reviews?data=XYZ","description":"Google review location URL"},"image_url":{"type":"string","example":"http://example.com?product=XYZ","description":"Url for external store image file"},"store_status":{"type":"string","description":"Status of store","enum":["open","closed","temporarily_closed"],"x-enumDescriptions":{"open":"Store is open and active","closed":"Store has been closed down permanently","temporarily_closed":"Store has been closed temporarily"},"example":"open"},"custom_dimension1":{"type":"string","example":"Class 3","description":"Custom Field 1"},"custom_dimension2":{"type":"string","example":"Class 3","description":"Custom Field 2"},"custom_dimension3":{"type":"string","example":"Class 3","description":"Custom Field 3"},"custom_dimension4":{"type":"string","example":"Class 3","description":"Custom Field 4"},"custom_dimension5":{"type":"string","example":"Class 3","description":"Custom Field 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Category":{"id":"components/schemas/Category","kind":"json-schema","title":"Category","data":{"type":"object","required":["category_id","category_name"],"properties":{"category_id":{"type":"string","example":"23","description":"Category ID"},"category_name":{"type":"string","example":"Men's clothing","description":"Category Name"},"parent_id":{"type":"string","example":"0","description":"ID of the parent category, 0 for top level category"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"type":"object","required":["product_id","product_name"],"properties":{"product_id":{"type":"string","example":"XYZ","description":"Product ID"},"product_name":{"type":"string","example":"Widget XYZ","description":"Product Name"},"product_description":{"type":"string","example":"Best performance XYZ on the market","description":"Product description"},"category_id":{"type":"string","example":"23","description":"Product category ID"},"average_price":{"type":"number","example":8,"description":"Running average purchase price for product."},"purchase_price":{"type":"number","example":10,"description":"Default purchase price for product. Used if sales transaction doesn't have purchase price set."},"sales_price":{"type":"number","example":20,"description":"Default retail price for product with taxes."},"sales_price_wo_vat":{"type":"number","example":16,"description":"Default retail price for product without taxes."},"vat_rate":{"type":"number","example":24,"description":"VAT/tax rate"},"unit_of_measure":{"type":"string","example":"PCS","description":"Unit of measure"},"product_size":{"type":"string","example":"XS","description":"Product size"},"product_width":{"type":"string","example":"5\"","description":"Product width"},"product_height":{"type":"string","example":"10\"","description":"Product height"},"product_color":{"type":"string","example":"Dark Blue","description":"Product color"},"product_type":{"type":"string","example":"Type A","description":"Product type"},"product_brand":{"type":"string","example":"Nike","description":"Product brand"},"product_season":{"type":"string","example":"Spring","description":"Product season"},"model":{"type":"string","example":"XYZ B40","description":"a (string, optional) - Product model"},"model_number":{"type":"string","example":"X311","description":"Product model number"},"country_of_origin":{"type":"string","example":"Moldovia","description":"Country of origin"},"freight":{"type":"number","example":5,"description":"Freight"},"duty":{"type":"number","example":0.24,"description":"Duty"},"supplier_id":{"type":"string","example":"221","description":"Supplier ID"},"fabric":{"type":"string","example":"Felt","description":"Product fabric"},"buyer":{"type":"string","example":"Lena Shields","description":"Buyer name"},"ean":{"type":"string","example":"Ean code","description":"Ean code"},"parent_product_id":{"type":"string","example":"XY","description":"Parent Product ID"},"image_url":{"type":"string","example":"http://example.com?product=XYZ","description":"Url for external product image file"},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"custom_field_6":{"type":"string","example":"EU only","description":"Custom field 6"},"custom_field_7":{"type":"string","example":"EU only","description":"Custom field 7"},"custom_field_8":{"type":"string","example":"EU only","description":"Custom field 8"},"custom_field_9":{"type":"string","example":"EU only","description":"Custom field 9"},"custom_field_10":{"type":"string","example":"EU only","description":"Custom field 10"},"custom_field_11":{"type":"string","example":"EU only","description":"Custom field 11"},"custom_field_12":{"type":"string","example":"EU only","description":"Custom field 12"},"custom_field_13":{"type":"string","example":"EU only","description":"Custom field 13"},"custom_field_14":{"type":"string","example":"EU only","description":"Custom field 14"},"custom_field_15":{"type":"string","example":"EU only","description":"Custom field 15"},"custom_field_16":{"type":"string","example":"EU only","description":"Custom field 16"},"custom_field_17":{"type":"string","example":"EU only","description":"Custom field 17"},"custom_field_18":{"type":"string","example":"EU only","description":"Custom field 18"},"custom_field_19":{"type":"string","example":"EU only","description":"Custom field 19"},"custom_field_20":{"type":"string","example":"EU only","description":"Custom field 20"},"custom_field_21":{"type":"string","example":"EU only","description":"Custom field 21"},"custom_field_22":{"type":"string","example":"EU only","description":"Custom field 22"},"custom_field_23":{"type":"string","example":"EU only","description":"Custom field 23"},"custom_field_24":{"type":"string","example":"EU only","description":"Custom field 24"},"custom_field_25":{"type":"string","example":"EU only","description":"Custom field 25"},"custom_field_26":{"type":"string","example":"EU only","description":"Custom field 26"},"custom_field_27":{"type":"string","example":"EU only","description":"Custom field 27"},"custom_field_28":{"type":"string","example":"EU only","description":"Custom field 28"},"custom_field_29":{"type":"string","example":"EU only","description":"Custom field 29"},"custom_field_30":{"type":"string","example":"EU only","description":"Custom field 30"},"custom_field_31":{"type":"string","example":"EU only","description":"Custom field 31"},"custom_field_32":{"type":"string","example":"EU only","description":"Custom field 32"},"custom_field_33":{"type":"string","example":"EU only","description":"Custom field 33"},"custom_field_34":{"type":"string","example":"EU only","description":"Custom field 34"},"custom_field_35":{"type":"string","example":"EU only","description":"Custom field 35"},"custom_field_36":{"type":"string","example":"EU only","description":"Custom field 36"},"custom_field_37":{"type":"string","example":"EU only","description":"Custom field 37"},"custom_field_38":{"type":"string","example":"EU only","description":"Custom field 38"},"custom_field_39":{"type":"string","example":"EU only","description":"Custom field 39"},"custom_field_40":{"type":"string","example":"EU only","description":"Custom field 40"},"custom_field_41":{"type":"string","example":"EU only","description":"Custom field 41"},"custom_field_42":{"type":"string","example":"EU only","description":"Custom field 42"},"custom_field_43":{"type":"string","example":"EU only","description":"Custom field 43"},"custom_field_44":{"type":"string","example":"EU only","description":"Custom field 44"},"custom_field_45":{"type":"string","example":"EU only","description":"Custom field 45"},"custom_field_46":{"type":"string","example":"EU only","description":"Custom field 46"},"custom_field_47":{"type":"string","example":"EU only","description":"Custom field 47"},"custom_field_48":{"type":"string","example":"EU only","description":"Custom field 48"},"custom_field_49":{"type":"string","example":"EU only","description":"Custom field 49"},"custom_field_50":{"type":"string","example":"EU only","description":"Custom field 50"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"custom_metric_6":{"type":"number","example":150,"description":"Custom metric 6"},"custom_metric_7":{"type":"number","example":1000,"description":"Custom metric 7"},"custom_metric_8":{"type":"number","example":2.52,"description":"Custom metric 8"},"custom_metric_9":{"type":"number","example":1.5,"description":"Custom metric 9"},"custom_metric_10":{"type":"number","example":2000,"description":"Custom metric 10"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/SalesTransaction":{"id":"components/schemas/SalesTransaction","kind":"json-schema","title":"SalesTransaction","data":{"type":"object","required":["transaction_id","line_item_id","sales_date","sales_time","product_id","product_quantity","product_unit_price","sales_value","organisation_id"],"properties":{"transaction_id":{"type":"string","example":"242224","description":"Unique ID for the transaction"},"line_item_id":{"type":"string","example":"1","description":"Secondary transaction identifier"},"customer_id":{"type":"string","example":"32","description":"Customer ID for identified customer"},"delivery_customer_id":{"type":"string","example":"32","description":"Delivery Customer ID for identified customer"},"sales_date":{"type":"string","example":"2016-01-01","description":"Sales date (yyyy-mm-dd)"},"sales_time":{"type":"string","example":"15:00:00","description":"Sales time (HH:mm:ss)"},"product_id":{"type":"string","example":"XYZ","description":"Product ID"},"product_quantity":{"type":"number","example":2,"description":"Sold quantity"},"product_unit_price":{"type":"number","example":10,"description":"Unit price for single product"},"sales_value":{"type":"number","example":20,"description":"Total sales amount including tax"},"sales_value_wo_vat":{"type":"number","example":20,"description":"Total sales amount without tax"},"compensation_amount":{"type":"number","example":3,"description":"Optional compensation paid for this sale"},"rebate":{"type":"number","example":0,"description":"Amount of rebate given including tax"},"rebate_wo_vat":{"type":"number","example":0,"description":"Amount of rebate given without tax"},"sales_currency":{"type":"string","example":"EUR","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used."},"payment_method":{"type":"string","example":"Visa","description":"Payment method"},"supplier_id":{"type":"string","example":"13","description":"Supplier ID"},"parent_product_id":{"type":"string","example":"123","description":"Parent Product ID"},"purchase_price":{"type":"number","example":5,"description":"Total purchase price including tax"},"purchase_price_wo_vat":{"type":"number","example":5,"description":"Total purchase price without tax"},"purchase_currency":{"type":"string","example":"EUR","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used."},"piece_good":{"type":"boolean","example":true,"description":"Unit Indicator. true if sold as unit, false if sold as group of items"},"organisation_id":{"type":"string","example":"540","description":"Organisation unit ID"},"department_id":{"type":"string","example":"5401","description":"Store department ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"sales_representative_id":{"type":"string","example":"5402100","description":"Responsible sales person ID"},"campaign_id":{"type":"string","example":"6344","description":"Campaign ID"},"cancel_id":{"type":"string","description":"Transaction ID of cancelled receipt"},"cancelled":{"type":"boolean","example":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. true=cancelled transaction false=not cancelled transaction. Default is false."},"children":[]}]}]}]},"delivery_date":{"type":"string","example":"2016-01-01","description":"Delivery date (yyyy-mm-dd)"},"delivery_time":{"type":"string","example":"15:00:00","description":"Delivery time (HH:mm:ss)"},"order_date":{"type":"string","example":"2016-01-01","description":"Order date (yyyy-mm-dd)"},"order_time":{"type":"string","example":"15:00:00","description":"Order time (HH:mm:ss)"},"invoice_date":{"type":"string","example":"2016-01-01","description":"Invoice date (yyyy-mm-dd)"},"invoice_time":{"type":"string","example":"15:00:00","description":"Invoice time (HH:mm:ss)"},"register_id":{"type":"string","example":"54022","description":"Cash register ID"},"table_number":{"type":"string","example":"54","description":"Table number"},"rebate_code_id":{"type":"string","example":"3313V","description":"Rebate Code ID"},"booking_id":{"type":"string","example":"B1224","description":"12 (string, optional) - Optional reference to booking that generated this sale."},"booking_line_id":{"type":"string","example":"1","description":"Optional booking line that corresponds to this sale."},"event_id":{"type":"string","example":"221","description":"Event ID"},"sales_order_id":{"type":"string","example":"12345","description":"Order id for sales order this sales transaction (invoice) originates from."},"sales_order_line_id":{"type":"string","example":"1","description":"Order line item id in sales order this sales transaction line item (invoice) originates from."},"parent_line_id":{"type":"string","example":"1","description":"Line item id for parent line item in this sales transaction that this line is child to."},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"custom_field_6":{"type":"string","example":"EU only","description":"Custom field 6"},"custom_field_7":{"type":"string","example":"EU only","description":"Custom field 7"},"custom_field_8":{"type":"string","example":"EU only","description":"Custom field 8"},"custom_field_9":{"type":"string","example":"EU only","description":"Custom field 9"},"custom_field_10":{"type":"string","example":"EU only","description":"Custom field 10"},"custom_field_11":{"type":"string","example":"EU only","description":"Custom field 11"},"custom_field_12":{"type":"string","example":"EU only","description":"Custom field 12"},"custom_field_13":{"type":"string","example":"EU only","description":"Custom field 13"},"custom_field_14":{"type":"string","example":"EU only","description":"Custom field 14"},"custom_field_15":{"type":"string","example":"EU only","description":"Custom field 15"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"custom_metric_6":{"type":"number","example":1,"description":"Custom metric 6"},"custom_metric_7":{"type":"number","example":100,"description":"Custom metric 7"},"custom_metric_8":{"type":"number","example":2.2,"description":"Custom metric 8"},"custom_metric_9":{"type":"number","example":1.05,"description":"Custom metric 9"},"custom_metric_10":{"type":"number","example":10000,"description":"Custom metric 10"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/PurchaseOrders":{"id":"components/schemas/PurchaseOrders","kind":"json-schema","title":"PurchaseOrders","data":{"type":"object","required":["transaction_id","line_item_id","product_id","organisation_id","order_date","order_time","ordered_quantity","order_status","cancelled"],"properties":{"transaction_id":{"type":"string","example":"er/232/f31","description":"Unique ID for the transaction"},"line_item_id":{"type":"string","example":"1","description":"Secondary transaction identifier"},"product_id":{"type":"string","example":"XYZ","description":"Product ID"},"organisation_id":{"type":"string","example":"540","description":"Organisation unit ID"},"department_id":{"type":"string","example":"54011","description":"Department ID"},"purchaser_id":{"type":"string","example":"5400","description":"Purchaser ID"},"supplier_id":{"type":"string","example":"221","description":"Supplier ID"},"parent_product_id":{"type":"string","example":"123","description":"Parent Product ID"},"order_date":{"type":"string","example":"2016-01-01","description":"Order date (yyyy-mm-dd)"},"order_time":{"type":"string","example":"15:00:00","description":"Order time (HH:mm:ss)"},"ordered_quantity":{"type":"number","example":2,"description":"order quantity"},"delivery_date":{"type":"string","example":"2016-01-01","description":"Delivery date (yyyy-mm-dd)"},"delivery_time":{"type":"string","example":"15:00:00","description":"Delivery time (HH:mm:ss)"},"delivered_quantity":{"type":"number","example":2,"description":"quantity that is delivered"},"arrival_date":{"type":"string","example":"2016-01-03","description":"Arrival date (yyyy-mm-dd)"},"arrival_time":{"type":"string","example":"15:00:00","description":"Arrival time (HH:mm:ss)"},"order_status":{"type":"number","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}]},"order_type":{"type":"string","example":"Express","description":"Order Type"},"purchase_price":{"type":"number","example":5,"description":"Total purchase price including tax"},"purchase_price_wo_vat":{"type":"number","example":4,"description":"Total purchase price without tax"},"rebate":{"type":"number","example":0,"description":"Amount of rebate given including tax"},"rebate_wo_vat":{"type":"number","example":0,"description":"Amount of rebate given without tax"},"retail_value":{"type":"number","example":10,"description":"Total retail (sales) value including tax"},"retail_value_wo_vat":{"type":"number","example":8,"description":"Total retail (sales) value without tax"},"purchase_currency":{"type":"string","example":"EUR","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used."},"sales_unit":{"type":"string","example":"KPL","description":"Sales unit"},"cancelled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. true=cancelled transaction false=not cancelled transaction"},"children":[]}]}]}],"example":false},"cancel_id":{"type":"string","example":"er/232/f2","description":"Transaction ID of cancelled receipt"},"gross_weight":{"type":"number","example":0,"description":"Gross weight of ordered products."},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"custom_field_6":{"type":"string","example":"EU only","description":"Custom field 6"},"custom_field_7":{"type":"string","example":"EU only","description":"Custom field 7"},"custom_field_8":{"type":"string","example":"EU only","description":"Custom field 8"},"custom_field_9":{"type":"string","example":"EU only","description":"Custom field 9"},"custom_field_10":{"type":"string","example":"EU only","description":"Custom field 10"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/SalesOffers":{"id":"components/schemas/SalesOffers","kind":"json-schema","title":"SalesOffers","data":{"type":"object","required":["transaction_id","line_item_id","product_id","product_quantity","product_unit_price","sales_value","offer_date","offer_time","offer_status"],"properties":{"transaction_id":{"type":"string","example":"er/232/f31","description":"Unique ID for the transaction"},"line_item_id":{"type":"string","example":"1","description":"Secondary transaction identifier"},"customer_id":{"type":"string","example":"32","description":"Customer ID for identified customer"},"product_id":{"type":"string","example":"XYZ","description":"Product ID"},"product_quantity":{"type":"number","example":2,"description":"Sold quantity"},"product_unit_price":{"type":"number","example":10,"description":"Unit price for single product"},"sales_value":{"type":"number","example":20,"description":"Total sales amount including tax"},"sales_value_wo_vat":{"type":"number","example":20,"description":"Total sales amount without tax"},"rebate":{"type":"number","example":0,"description":"Amount of rebate given including tax"},"rebate_wo_vat":{"type":"number","example":0,"description":"Amount of rebate given without tax"},"sales_currency":{"type":"string","example":"EUR","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used."},"payment_method":{"type":"string","example":"Invoice 30","description":"Payment method"},"supplier_id":{"type":"string","example":"221","description":"Supplier ID"},"parent_product_id":{"type":"string","example":"123","description":"Parent Product ID"},"purchase_price":{"type":"number","example":5,"description":"Total purchase price including tax"},"purchase_price_wo_vat":{"type":"number","example":5,"description":"Total purchase price without tax"},"purchase_currency":{"type":"string","example":"EUR","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used."},"organisation_id":{"type":"string","example":"540","description":"Organisation unit ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"offer_date":{"type":"string","example":"2016-01-01","description":"Offer date (yyyy-mm-dd)"},"offer_time":{"type":"string","example":"15:00:00","description":"Offer time (HH:mm:ss)"},"valid_date":{"type":"string","example":"2016-01-01","description":"Offer validity date (yyyy-mm-dd)"},"valid_time":{"type":"string","example":"15:00:00","description":"Offer validity time (HH:mm:ss)"},"offer_status":{"type":"number","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offer status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}]},"offer_type":{"type":"string","example":"wholesale","description":"Offer type."},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"custom_field_6":{"type":"string","example":"EU only","description":"Custom field 6"},"custom_field_7":{"type":"string","example":"EU only","description":"Custom field 7"},"custom_field_8":{"type":"string","example":"EU only","description":"Custom field 8"},"custom_field_9":{"type":"string","example":"EU only","description":"Custom field 9"},"custom_field_10":{"type":"string","example":"EU only","description":"Custom field 10"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/SalesOrders":{"id":"components/schemas/SalesOrders","kind":"json-schema","title":"SalesOrders","data":{"type":"object","required":["transaction_id","line_item_id","product_id","product_quantity","product_unit_price","sales_value","order_date","order_time","order_status"],"properties":{"transaction_id":{"type":"string","example":"er/232/f31","description":"Unique ID for the transaction"},"line_item_id":{"type":"string","example":"1","description":"Secondary transaction identifier"},"customer_id":{"type":"string","example":"32","description":"Customer ID for identified customer"},"delivery_customer_id":{"type":"string","example":"32","description":"Delivery Customer ID for identified customer"},"product_id":{"type":"string","example":"XYZ","description":"Product ID"},"product_quantity":{"type":"number","example":2,"description":"Sold quantity"},"delivered_quantity":{"type":"number","example":1,"description":"Delivered quantity"},"planned_quantity":{"type":"number","example":2,"description":"Planned quantity"},"product_unit_price":{"type":"number","example":10,"description":"Unit price for single product"},"sales_value":{"type":"number","example":20,"description":"Total sales amount including tax"},"sales_value_wo_vat":{"type":"number","example":20,"description":"Total sales amount without tax"},"rebate":{"type":"number","example":0,"description":"Amount of rebate given including tax"},"rebate_wo_vat":{"type":"number","example":0,"description":"Amount of rebate given without tax"},"rebate_code_id":{"type":"string","example":"3313V","description":"Rebate Code ID"},"sales_currency":{"type":"string","example":"EUR","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used."},"payment_method":{"type":"string","example":"Invoice 30","description":"Payment method"},"tender_amount":{"type":"number","example":20,"description":"Amount paid with tender in 'payment method'."},"deposit_amount":{"type":"number","example":10,"description":"Amount of deposit paid for this order item."},"supplier_id":{"type":"string","example":"221","description":"Supplier ID"},"parent_product_id":{"type":"string","example":"123","description":"Parent Product ID"},"purchase_price":{"type":"number","example":5,"description":"Total purchase price including tax"},"purchase_price_wo_vat":{"type":"number","example":5,"description":"Total purchase price without tax"},"purchase_currency":{"type":"string","example":"EUR","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used."},"organisation_id":{"type":"string","example":"540","description":"Organisation unit ID"},"department_id":{"type":"string","example":"54011","description":"Department ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"cancel_id":{"type":"string","example":"er/232/f2","description":"Transaction ID of cancelled receipt"},"delivery_date":{"type":"string","example":"2016-01-01","description":"Delivery date (yyyy-mm-dd)"},"delivery_time":{"type":"string","example":"15:00:00","description":"Delivery time (HH:mm:ss)"},"order_date":{"type":"string","example":"2016-01-01","description":"Order date (yyyy-mm-dd)"},"order_time":{"type":"string","example":"15:00:00","description":"Order time (HH:mm:ss)"},"invoice_date":{"type":"string","example":"2016-01-01","description":"Invoice date (yyyy-mm-dd)"},"invoice_time":{"type":"string","example":"15:00:00","description":"Invoice time (HH:mm:ss)"},"arrival_date":{"type":"string","example":"2016-01-03","description":"Arrival date (yyyy-mm-dd)"},"arrival_time":{"type":"string","example":"15:00:00","description":"Arrival time (HH:mm:ss)"},"order_status":{"type":"number","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}]},"order_type":{"type":"string","example":"Wholesale","description":"Order type."},"customer_order_number":{"type":"string","example":"1234-5","description":"Customer internal order ID"},"sales_offer_id":{"type":"string","example":"1234","description":"ID that refers to respective sales offer if applicable"},"sales_offer_line_id":{"type":"string","example":"1","description":"ID that refers to respective sales offer line if applicable"},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"custom_field_6":{"type":"string","example":"EU only","description":"Custom field 6"},"custom_field_7":{"type":"string","example":"EU only","description":"Custom field 7"},"custom_field_8":{"type":"string","example":"EU only","description":"Custom field 8"},"custom_field_9":{"type":"string","example":"EU only","description":"Custom field 9"},"custom_field_10":{"type":"string","example":"EU only","description":"Custom field 10"},"custom_field_11":{"type":"string","example":"EU only","description":"Custom field 11"},"custom_field_12":{"type":"string","example":"EU only","description":"Custom field 12"},"custom_field_13":{"type":"string","example":"EU only","description":"Custom field 13"},"custom_field_14":{"type":"string","example":"EU only","description":"Custom field 14"},"custom_field_15":{"type":"string","example":"EU only","description":"Custom field 15"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Booking":{"id":"components/schemas/Booking","kind":"json-schema","title":"Booking","data":{"type":"object","required":["booking_id","booking_line_id","product_id","organisation_id","booked_quantity","sales_value","booking_date","event_start_date","booking_type"],"properties":{"booking_id":{"type":"string","example":"er/232/f31","description":"Unique ID for the booking"},"booking_line_id":{"type":"string","example":"1","description":"Secondary booking identifier"},"customer_id":{"type":"string","example":"32","description":"Customer ID for identified customer"},"product_id":{"type":"string","example":"XYZ","description":"Product ID"},"event_id":{"type":"string","example":"123","description":"A (string, optional) - Optional ID for the event this booking is done for."},"organisation_id":{"type":"string","example":"540","description":"Organisation unit ID"},"department_id":{"type":"string","example":"54011","description":"Department ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"booked_quantity":{"type":"number","example":2,"description":"Booked quantity"},"number_of_guests":{"type":"number","example":2,"description":"Number of guests booked"},"number_of_visits":{"type":"number","example":2,"description":"Number of visits allowed per guest within start and end dates."},"sales_value":{"type":"number","example":20,"description":"Total booking sales amount including tax"},"sales_value_wo_vat":{"type":"number","example":20,"description":"Total booking sales amount without tax"},"currency":{"type":"string","example":"EUR","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used."},"canceled":{"type":"boolean","example":false,"description":"True when this booking has been cancelled."},"booking_date":{"type":"string","example":"2020-03-01","description":"Booking date (yyyy-mm-dd)"},"booking_time":{"type":"string","example":"15:00:00","description":"Booking time (HH:mm:ss)"},"event_start_date":{"type":"string","example":"2020-03-10","description":"Event start date (yyyy-mm-dd)"},"event_start_time":{"type":"string","example":"15:00:00","description":"Event start time (HH:mm:ss)"},"event_end_date":{"type":"string","example":"2020-03-11","description":"Event end date (yyyy-mm-dd)"},"event_end_time":{"type":"string","example":"15:00:00","description":"Event end time (HH:mm:ss)"},"booking_type":{"type":"string","example":"event","description":"Booking type. Must be either event, ticket or room."},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","required":["account_id","account_name"],"properties":{"account_id":{"type":"string","example":"1150","description":"Account ID"},"account_name":{"type":"string","example":"Employee Salaries","description":"Account name"},"account_type":{"type":"string","example":"Salaries","description":"Account type"},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Event":{"id":"components/schemas/Event","kind":"json-schema","title":"Event","data":{"type":"object","required":["event_id","event_name"],"properties":{"event_id":{"type":"string","example":"1150","description":"Event ID"},"event_name":{"type":"string","example":"Rock around the clock","description":"Event name"},"event_type":{"type":"string","example":"Concert","description":"Event type"},"venue_name":{"type":"string","example":"Arena 1","description":"Venue name"},"custom_field_1":{"type":"string","example":"EU only","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"EU only","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"EU only","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"EU only","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"EU only","description":"Custom field 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/SalesPerson":{"id":"components/schemas/SalesPerson","kind":"json-schema","title":"SalesPerson","data":{"type":"object","required":["salesperson_id"],"properties":{"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"salesperson_name":{"type":"string","example":"John Smith","description":"Sales person name"},"salesperson_email":{"type":"string","example":"john.smith@store.store","description":"Sales person email"},"salesperson_phone":{"type":"string","example":"+35811111111","description":"Sales person phone number"},"employee_id":{"type":"string","example":"353","description":"Employee id"},"employment_start":{"type":"string","example":"2020-01-01","description":"Employment start date"},"employment_end":{"type":"string","example":"2020-05-31","description":"Employment end date"},"custom_field_1":{"type":"string","example":"Project worker","description":"Custom field 1"},"custom_field_2":{"type":"string","example":"Project worker","description":"Custom field 2"},"custom_field_3":{"type":"string","example":"Project worker","description":"Custom field 3"},"custom_field_4":{"type":"string","example":"Project worker","description":"Custom field 4"},"custom_field_5":{"type":"string","example":"Project worker","description":"Custom field 5"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Supplier":{"id":"components/schemas/Supplier","kind":"json-schema","title":"Supplier","data":{"type":"object","required":["supplier_id"],"properties":{"supplier_id":{"type":"string","example":"221","description":"Supplier ID"},"supplier_name":{"type":"string","example":"WasSuppliers","description":"Supplier name"},"supplier_email":{"type":"string","example":"john.smith@supplier.supplier","description":"Supplier Email"},"supplier_phone":{"type":"string","example":"+3581111111","description":"Supplier phone number"},"supplier_address":{"type":"string","example":"Mannerheimintie 1","description":"Street address"},"supplier_city":{"type":"string","example":"Helsinki","description":"City"},"supplier_zipcode":{"type":"string","example":"00100","description":"Postal code"},"supplier_country":{"type":"string","example":"Finland","description":"Country"},"supplier_group":{"type":"string","example":"Strategic Supplier","description":"Supplier group"},"supplier_type":{"type":"string","example":"Local","description":"Supplier type"},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Counter":{"id":"components/schemas/Counter","kind":"json-schema","title":"Counter","data":{"type":"object","required":["counter_id","counter_name","disabled"],"properties":{"counter_id":{"type":"string","example":"5","description":"Counter ID"},"counter_name":{"type":"string","example":"Front door 1","description":"Counter name"},"folder_id: front_door_1":{"type":"string","description":"Name of identification folder"},"serial":{"type":"string","example":"ABCDE12345","description":"Camera serial number"},"registration_code":{"type":"string","example":"A1B2C3D4E5","description":"Camera registration code"},"disabled":{"type":"boolean","description":"True if the counter is disabled (i.e. is set to not send data)","example":false},"is_queue":{"type":"boolean","example":false,"description":"True if the counter is a queue counter"},"on_store_perimeter":{"type":"boolean","example":true,"description":"True, if this a store perimeter camera"},"organisation_id: my_organisation_id":{"type":"string","description":"Id of the store/organisation where the camera is located"},"department_id: my_department_id":{"type":"string","description":"Id of the department where the camera is located"},"department_reversed_id":{"type":"string","example":"reverse_id","description":"Secondary department id where in and out counts are reversed."},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Visitor":{"id":"components/schemas/Visitor","kind":"json-schema","title":"Visitor","data":{"type":"object","required":["organisation_id","date","time","visitors"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation/Store ID"},"department_id":{"type":"string","example":"540","description":"Department ID"},"counter_id":{"type":"string","example":"540","description":"Counter ID"},"product_id":{"type":"string","example":"ABC-123","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Optional product id associated to this visitor (eg. ticket)"},"children":[]}]}]}]},"customer_id":{"type":"string","example":"1234","description":"Optional customer associated to this visitor (ticket etc.)"},"date":{"type":"string","example":"2016-01-01","description":"Date of visit (yyyy-mm-dd)"},"time":{"type":"string","example":"15:00:00","description":"Time of visit (HH:mm:ss)"},"time_zone":{"type":"string","example":"02:00","description":"Optional location time zone."},"visit_type":{"type":"string","example":"in","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Type of visitor record ('in', 'out', 'pass', 'occupancy', 'visit_time', 'queue')"},"children":[]}]}]}]},"vehicle_type":{"type":"string","example":"car","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional field for vehicle type. Supported values are car & bicycle."},"children":[]}]}]}]},"queue_area_name":{"type":"string","example":"Area 1","description":"Optional area name for queue cameras."},"low_queue":{"type":"number","example":1,"description":"Threshold for low queue."},"high_queue":{"type":"number","example":5,"description":"Threshold for high queue."},"visitors":{"type":"number","example":1000,"description":"Number of visitors at given time"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/VisitorDemographics":{"id":"components/schemas/VisitorDemographics","kind":"json-schema","title":"VisitorDemographics","data":{"type":"object","required":["organisation_id","date","time","visitors"],"properties":{"organisation_id":{"type":"string","example":"540","description":"Organisation/Store ID"},"department_id":{"type":"string","example":"540","description":"Department ID"},"counter_id":{"type":"string","example":"540","description":"Counter ID"},"date":{"type":"string","example":"2016-01-01","description":"Date of visit (yyyy-mm-dd)"},"time":{"type":"string","example":"15:00:00","description":"Time of visit (HH:mm:ss)"},"gender":{"type":"string","example":"m","description":"Gender of visitor. 'm' for male, 'f' for female and 'u' for unknown."},"age":{"type":"number","example":25,"description":"Age of the visitor."},"visitors":{"type":"number","example":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of visitors for given age & gender for time specified."},"children":[]}]}]}]},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/IdMapping":{"id":"components/schemas/IdMapping","kind":"json-schema","title":"IdMapping","data":{"type":"object","required":["entity_type","context"],"properties":{"source_system_id":{"type":"string","example":"abc","description":"store (string, required) - Identifier in the source system"},"master_id":{"type":"string","example":"store","description":"123 (string, required) - Identifier in master data"},"entity_type":{"type":"string","example":"organisation","description":"Entity type this mapping is for (e.g. organisation, product)"},"context":{"type":"string","example":"visitor","description":"Type of data this mapping applies to"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/SalesSummary":{"id":"components/schemas/SalesSummary","kind":"json-schema","title":"SalesSummary","data":{"type":"object","required":["sales_date","organisation_id"],"properties":{"sales_date":{"type":"string","example":"2016-01-01","description":"Sales date (yyyy-mm-dd)"},"sales_time":{"type":"string","example":"15:00:00","description":"Sales time (HH:mm:ss)"},"organisation_id":{"type":"string","example":"540","description":"Organisation/Store ID"},"department_id":{"type":"string","example":"5401","description":"Store department ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"sales_value":{"type":"number","example":2000,"description":"Total sales amount including tax"},"sales_value_wo_vat":{"type":"number","example":1600,"description":"Total sales amount without tax"},"sales_currency":{"type":"string","example":"EUR","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used."},"rebate":{"type":"number","example":0,"description":"Amount of rebate given including tax"},"rebate_wo_vat":{"type":"number","example":0,"description":"Amount of rebate given without tax"},"purchase_price":{"type":"number","example":500,"description":"Total purchase price including tax"},"purchase_price_wo_vat":{"type":"number","example":400,"description":"Total purchase price without tax"},"purchase_currency":{"type":"string","example":"EUR","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used."},"product_quantity":{"type":"number","example":4,"description":"Sold quantity"},"number_of_transactions":{"type":"number","example":2,"description":"Number of receipts"},"product_id":{"type":"string","example":"XYZ","description":"Product ID"},"customer_id":{"type":"string","example":"32","description":"Customer ID for identified customer"},"supplier_id":{"type":"string","example":"221","description":"Supplier ID"},"parent_product_id":{"type":"string","example":"123","description":"Parent Product ID"},"campaign_id":{"type":"string","example":"123","description":"Campaign ID"},"rebate_code_id":{"type":"string","example":"3313V","description":"Rebate Code ID"},"cancelled":{"type":"boolean","example":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. true=cancelled transaction false=not cancelled transaction. Default is false."},"children":[]}]}]}]},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_6":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_7":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_8":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_9":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_10":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/SalesPayment":{"id":"components/schemas/SalesPayment","kind":"json-schema","title":"SalesPayment","data":{"type":"object","required":["transaction_id","line_item_id","sales_date","organisation_id","payment_method"],"properties":{"transaction_id":{"type":"string","example":"er/232/f31","description":"Unique ID for the transaction. Should match with sales receipt transaction id where applicable."},"line_item_id":{"type":"string","example":"1","description":"Transaction line item identifier"},"sales_date":{"type":"string","example":"2016-01-01","description":"Sales date (yyyy-mm-dd)"},"sales_time":{"type":"string","example":"15:00:00","description":"Sales time (HH:mm:ss)"},"organisation_id":{"type":"string","example":"540","description":"Organisation/Store ID"},"department_id":{"type":"string","example":"5401","description":"Store department ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"register_id":{"type":"string","example":"32","description":"Cash register ID"},"table_number":{"type":"string","example":"54","description":"Table number"},"payment_method":{"type":"string","example":"Invoice","description":"Payment method ID"},"giftcard_payment_id":{"type":"string","example":"12345","description":"Id to link to possible giftcard used for this payment."},"sales_value":{"type":"number","example":2000,"description":"Total sales amount including tax"},"sales_value_wo_vat":{"type":"number","example":1600,"description":"Total sales amount without tax"},"currency":{"type":"string","example":"EUR","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used."},"rebate":{"type":"number","example":0,"description":"Amount of rebate given including tax"},"rebate_wo_vat":{"type":"number","example":0,"description":"Amount of rebate given without tax"},"customer_id":{"type":"string","example":"32","description":"Customer ID for identified customer"},"delivery_customer_id":{"type":"string","example":"32","description":"Delivery Customer ID for identified customer"},"cancel_id":{"type":"string","example":"er/232/f2","description":"Transaction ID of cancelled receipt"},"cancelled":{"type":"boolean","example":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. true=cancelled transaction false=not cancelled transaction. Default is false."},"children":[]}]}]}]},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_6":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_7":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_8":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_9":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_10":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"custom_metric_6":{"type":"number","example":1,"description":"Custom metric 6"},"custom_metric_7":{"type":"number","example":100,"description":"Custom metric 7"},"custom_metric_8":{"type":"number","example":2.2,"description":"Custom metric 8"},"custom_metric_9":{"type":"number","example":1.05,"description":"Custom metric 9"},"custom_metric_10":{"type":"number","example":10000,"description":"Custom metric 10"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/GiftcardPayment":{"id":"components/schemas/GiftcardPayment","kind":"json-schema","title":"GiftcardPayment","data":{"type":"object","required":["giftcard_id","giftcard_number","giftcard_status","creation_date","organisation_id","payment_id","payment_type","payment_date","payment_time","payment_value"],"properties":{"giftcard_id":{"type":"string","example":"A67gigMp","description":"Unique ID for the gift card."},"giftcard_number":{"type":"string","example":"7TON39","description":"Gift card number"},"giftcard_status":{"type":"string","example":"Active","description":"Gift card status"},"giftcard_balance":{"type":"number","example":50,"description":"Gift card balance"},"creation_date":{"type":"string","example":"2016-01-01","description":"Gift card creation date (yyyy-mm-dd)"},"creation_time":{"type":"string","example":"15:00:00","description":"Gift card creation time (HH:mm:ss)"},"expiration_date":{"type":"string","example":"2017-01-01","description":"Gift card expiration date (yyyy-mm-dd)"},"expiration_time":{"type":"string","example":"15:00:00","description":"Gift card expiration time (HH:mm:ss)"},"sales_id":{"type":"string","example":"dbeba367","description":"Sales Id"},"organisation_id":{"type":"string","example":"540","description":"Organisation/Store ID"},"department_id":{"type":"string","example":"5401","description":"Store department ID"},"register_id":{"type":"string","example":"32","description":"Cash register ID"},"salesperson_id":{"type":"string","example":"5402101","description":"Sales person ID"},"customer_id":{"type":"string","example":"32","description":"Customer ID for identified customer"},"payment_id":{"type":"string","example":"A65A","description":"Payment method ID"},"payment_type":{"type":"string","example":"Activation","description":"Payment type"},"payment_date":{"type":"string","example":"2016-05-15","description":"Payment date (yyyy-mm-dd)"},"payment_time":{"type":"string","example":"15:00:00","description":"Payment time (HH:mm:ss)"},"payment_value":{"type":"number","example":20,"description":"Payment amount"},"payment_currency":{"type":"string","example":"EUR","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used."},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/PaymentType":{"id":"components/schemas/PaymentType","kind":"json-schema","title":"PaymentType","data":{"type":"object","required":["payment_type_id","payment_type"],"properties":{"payment_type_id":{"type":"string","example":"1","description":"Payment Type ID"},"payment_type":{"type":"string","example":"credit card","description":"Payment type name"},"payment_group":{"type":"string","example":"Store","description":"Payment group"},"custom_field_1":{"type":"string","example":"App","description":"Custom Field 1"},"custom_field_2":{"type":"string","example":"App","description":"Custom Field 2"},"custom_field_3":{"type":"string","example":"App","description":"Custom Field 3"},"custom_field_4":{"type":"string","example":"App","description":"Custom Field 4"},"custom_field_5":{"type":"string","example":"App","description":"Custom Field 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/RebateCode":{"id":"components/schemas/RebateCode","kind":"json-schema","title":"RebateCode","data":{"type":"object","required":["rebate_code_id","rebate_code_name"],"properties":{"rebate_code_id":{"type":"string","example":"3313V","description":"Rebate Code ID"},"rebate_code_name":{"type":"string","example":"Model product","description":"Description of the reason"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/WorkshiftBase":{"id":"components/schemas/WorkshiftBase","kind":"json-schema","title":"WorkshiftBase","data":{"type":"object","required":["shift_id","organisation_id","start_date","start_time"],"properties":{"shift_id":{"type":"string","example":"123","description":"Unique identifier for the workshift"},"organisation_id":{"type":"string","example":"234","description":"Organisation unit where shift will take place"},"salesperson_id":{"type":"string","example":"345","description":"Identifier of sales person / employee working. Required for punched shifts"},"department_id":{"type":"string","example":"5401","description":"Store department ID"},"scheduled":{"type":"boolean","example":false,"description":"Whether this is scheduled or punched shift, default is false"},"productive":{"type":"boolean","example":true,"description":"Whether this is productive or administrative work, default is true"},"active_work_time":{"type":"boolean","example":true,"description":"Whether this shift is calculated in active work time, default is true"},"start_date":{"type":"string","example":"2016-01-01","description":"Shift date (yyyy-mm-dd)"},"start_time":{"type":"string","example":"15:00:00","description":"Shift starting time (HH:mm:ss)"},"shift_type":{"type":"string","example":"Chef","description":"Type of the shift. Freeform, will be available as dimension in portal."},"salary_type":{"type":"string","example":"Evening compensation","description":"Type of compensation for the shift."},"staff_cost":{"type":"number","example":500,"description":"Cost associated with this shift"},"breaks_duration":{"type":"number","example":0.5,"description":"Total hours of breaks during this shift"},"breaks_cost":{"type":"number","example":40,"description":"Total salary cost associated for paid breaks during this shift"},"overtime_duration":{"type":"number","example":2,"description":"Total overtime hours during this shift"},"overtime_cost":{"type":"number","example":120,"description":"Total salary cost associated for overtime hours"},"absence_code":{"type":"string","example":"BREAK","description":"Code for the absence if this entry describes absence."},"currency":{"type":"string","example":"EUR","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used."},"custom_field_1":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_2":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_3":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_4":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_field_5":{"type":"string","example":"XYZ","description":"Field that can be used for custom dimensions"},"custom_metric_1":{"type":"number","example":1,"description":"Custom metric 1"},"custom_metric_2":{"type":"number","example":100,"description":"Custom metric 2"},"custom_metric_3":{"type":"number","example":2.2,"description":"Custom metric 3"},"custom_metric_4":{"type":"number","example":1.05,"description":"Custom metric 4"},"custom_metric_5":{"type":"number","example":10000,"description":"Custom metric 5"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/Workshift":{"id":"components/schemas/Workshift","kind":"json-schema","title":"Workshift","data":{"oneOf":[{"title":"Duration","allOf":[{"$ref":"#/components/schemas/WorkshiftBase"},{"type":"object","required":["duration"],"properties":{"duration":{"type":"number","description":"Duration of the shift in hours.","example":8.15}}}]},{"title":"End date and time","allOf":[{"$ref":"#/components/schemas/WorkshiftBase"},{"type":"object","required":["end_date","end_time"],"properties":{"end_date":{"type":"string","description":"Shift ending date (yyyy-mm-dd)","example":"2016-01-01"},"end_time":{"type":"string","description":"Shift ending time (HH:mm:ss)","example":"20:00:00"}}}]}]}},"components/schemas/CurrencyRate":{"id":"components/schemas/CurrencyRate","kind":"json-schema","title":"CurrencyRate","data":{"type":"object","required":["source_currency","target_currency","valid_from","valid_to","rate"],"properties":{"source_currency":{"type":"string","example":"EUR","description":"Source currency as ISO 4217 currency code."},"target_currency":{"type":"string","example":"GBP","description":"Target currency as ISO 4217 currency code."},"valid_from":{"type":"string","example":"2017-01-01","description":"First day when the exchange rate is valid"},"valid_to":{"type":"string","example":"2017-12-31","description":"Last day when the exchange rate is valid"},"rate":{"type":"number","example":0.89,"description":"Exchange rate to from source to target currency"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/UpdateTime":{"id":"components/schemas/UpdateTime","kind":"json-schema","title":"UpdateTime","data":{"type":"object","required":["entity","last_updated"],"properties":{"entity":{"type":"string","example":"workshifts","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key of entity updated. Generally One of Zapi end point names in lower case eg. workshifts, sales, salessummaries, inventorysnapshots, visitors etc. Special key 'last_updated' can be used to send aggregated update time for all data sets."},"children":[]}]}]}]},"organisation_id":{"type":"string","example":"123","description":"Optional organisation unit this update refers to only"},"last_updated":{"type":"string","example":"2019-08-21T02:25:31","description":"Last time stamp when entity was successfully updated"},"source_system":{"type":"string","example":"ABCDEF","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used."}}}},"components/schemas/ApiErrorMessage":{"id":"components/schemas/ApiErrorMessage","kind":"json-schema","title":"ApiErrorMessage","data":{"type":"object","required":["status","msg"],"properties":{"status":{"type":"string","example":"Not OK","description":"Status of the operation OK / Not OK"},"msg":{"type":"string","example":"Reason for error","description":"Message describing result of operation"}}}},"components/schemas/ApiErrorMessage401":{"id":"components/schemas/ApiErrorMessage401","kind":"json-schema","title":"ApiErrorMessage401","data":{"type":"object","required":["status","msg"],"properties":{"status":{"type":"string","example":"Not OK","description":"Status of the operation OK / Not OK"},"msg":{"type":"string","example":"Unauthorized","description":"Message describing result of operation"}}}},"components/schemas/SalesTransactionUploadPayloadJson":{"id":"components/schemas/SalesTransactionUploadPayloadJson","kind":"json-schema","title":"SalesTransactionUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/SalesTransaction"},{"type":"array","items":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"242224"},"line_item_id":{"type":"string","description":"Secondary transaction identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"delivery_customer_id":{"type":"string","description":"Delivery Customer ID for identified customer","example":"32"},"sales_date":{"type":"string","description":"Sales date (yyyy-mm-dd)","example":"2016-01-01"},"sales_time":{"type":"string","description":"Sales time (HH:mm:ss)","example":"15:00:00"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"product_quantity":{"type":"number","description":"Sold quantity","example":2},"product_unit_price":{"type":"number","description":"Unit price for single product","example":10},"sales_value":{"type":"number","description":"Total sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":20},"compensation_amount":{"type":"number","description":"Optional compensation paid for this sale","example":3},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"sales_currency":{"type":"string","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"payment_method":{"type":"string","description":"Payment method","example":"Visa"},"supplier_id":{"type":"string","description":"Supplier ID","example":"13"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":5},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":5},"purchase_currency":{"type":"string","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"piece_good":{"type":"boolean","description":"Unit Indicator. true if sold as unit, false if sold as group of items","example":true},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"sales_representative_id":{"type":"string","description":"Responsible sales person ID","example":"5402100"},"campaign_id":{"type":"string","description":"Campaign ID","example":"6344"},"cancel_id":{"type":"string","description":"Transaction ID of cancelled receipt"},"cancelled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. true=cancelled transaction false=not cancelled transaction. Default is false."},"children":[]}]}]}],"example":false},"delivery_date":{"type":"string","description":"Delivery date (yyyy-mm-dd)","example":"2016-01-01"},"delivery_time":{"type":"string","description":"Delivery time (HH:mm:ss)","example":"15:00:00"},"order_date":{"type":"string","description":"Order date (yyyy-mm-dd)","example":"2016-01-01"},"order_time":{"type":"string","description":"Order time (HH:mm:ss)","example":"15:00:00"},"invoice_date":{"type":"string","description":"Invoice date (yyyy-mm-dd)","example":"2016-01-01"},"invoice_time":{"type":"string","description":"Invoice time (HH:mm:ss)","example":"15:00:00"},"register_id":{"type":"string","description":"Cash register ID","example":"54022"},"table_number":{"type":"string","description":"Table number","example":"54"},"rebate_code_id":{"type":"string","description":"Rebate Code ID","example":"3313V"},"booking_id":{"type":"string","description":"12 (string, optional) - Optional reference to booking that generated this sale.","example":"B1224"},"booking_line_id":{"type":"string","description":"Optional booking line that corresponds to this sale.","example":"1"},"event_id":{"type":"string","description":"Event ID","example":"221"},"sales_order_id":{"type":"string","description":"Order id for sales order this sales transaction (invoice) originates from.","example":"12345"},"sales_order_line_id":{"type":"string","description":"Order line item id in sales order this sales transaction line item (invoice) originates from.","example":"1"},"parent_line_id":{"type":"string","description":"Line item id for parent line item in this sales transaction that this line is child to.","example":"1"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_field_6":{"type":"string","description":"Custom field 6","example":"EU only"},"custom_field_7":{"type":"string","description":"Custom field 7","example":"EU only"},"custom_field_8":{"type":"string","description":"Custom field 8","example":"EU only"},"custom_field_9":{"type":"string","description":"Custom field 9","example":"EU only"},"custom_field_10":{"type":"string","description":"Custom field 10","example":"EU only"},"custom_field_11":{"type":"string","description":"Custom field 11","example":"EU only"},"custom_field_12":{"type":"string","description":"Custom field 12","example":"EU only"},"custom_field_13":{"type":"string","description":"Custom field 13","example":"EU only"},"custom_field_14":{"type":"string","description":"Custom field 14","example":"EU only"},"custom_field_15":{"type":"string","description":"Custom field 15","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"custom_metric_6":{"type":"number","description":"Custom metric 6","example":1},"custom_metric_7":{"type":"number","description":"Custom metric 7","example":100},"custom_metric_8":{"type":"number","description":"Custom metric 8","example":2.2},"custom_metric_9":{"type":"number","description":"Custom metric 9","example":1.05},"custom_metric_10":{"type":"number","description":"Custom metric 10","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["transaction_id","line_item_id","sales_date","sales_time","product_id","product_quantity","product_unit_price","sales_value","organisation_id","booking_id"],"additionalProperties":false,"example":{"transaction_id":"242224","line_item_id":"1","customer_id":"32","delivery_customer_id":"32","sales_date":"2016-01-01","sales_time":"15:00:00","product_id":"XYZ","product_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"compensation_amount":3,"rebate":0,"rebate_wo_vat":0,"sales_currency":"EUR","payment_method":"Visa","supplier_id":"13","parent_product_id":"123","purchase_price":5,"purchase_price_wo_vat":5,"purchase_currency":"EUR","piece_good":true,"organisation_id":"540","department_id":"5401","salesperson_id":"5402101","sales_representative_id":"5402100","campaign_id":"6344","cancelled":false,"delivery_date":"2016-01-01","delivery_time":"15:00:00","order_date":"2016-01-01","order_time":"15:00:00","invoice_date":"2016-01-01","invoice_time":"15:00:00","register_id":"54022","table_number":"54","rebate_code_id":"3313V","booking_id":"B1224","booking_line_id":"1","event_id":"221","sales_order_id":"12345","sales_order_line_id":"1","parent_line_id":"1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_field_11":"EU only","custom_field_12":"EU only","custom_field_13":"EU only","custom_field_14":"EU only","custom_field_15":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":1,"custom_metric_7":100,"custom_metric_8":2.2,"custom_metric_9":1.05,"custom_metric_10":10000,"source_system":"ABCDEF"}},"example":[{"transaction_id":"242224","line_item_id":"1","customer_id":"32","delivery_customer_id":"32","sales_date":"2016-01-01","sales_time":"15:00:00","product_id":"XYZ","product_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"compensation_amount":3,"rebate":0,"rebate_wo_vat":0,"sales_currency":"EUR","payment_method":"Visa","supplier_id":"13","parent_product_id":"123","purchase_price":5,"purchase_price_wo_vat":5,"purchase_currency":"EUR","piece_good":true,"organisation_id":"540","department_id":"5401","salesperson_id":"5402101","sales_representative_id":"5402100","campaign_id":"6344","cancelled":false,"delivery_date":"2016-01-01","delivery_time":"15:00:00","order_date":"2016-01-01","order_time":"15:00:00","invoice_date":"2016-01-01","invoice_time":"15:00:00","register_id":"54022","table_number":"54","rebate_code_id":"3313V","booking_id":"B1224","booking_line_id":"1","event_id":"221","sales_order_id":"12345","sales_order_line_id":"1","parent_line_id":"1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_field_11":"EU only","custom_field_12":"EU only","custom_field_13":"EU only","custom_field_14":"EU only","custom_field_15":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":1,"custom_metric_7":100,"custom_metric_8":2.2,"custom_metric_9":1.05,"custom_metric_10":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/SalesTransactionUploadPayloadCsv":{"id":"components/schemas/SalesTransactionUploadPayloadCsv","kind":"json-schema","title":"SalesTransactionUploadPayloadCsv","data":{"type":"string","description":"Sales transactions data in CSV format.","example":"transaction_id; line_item_id; customer_id; sales_date; sales_time; product_id; product_quantity; product_unit_price; sales_value; sales_value_wo_vat; rebate; rebate_wo_vat; sales_currency; payment_method; supplier_id; purchase_price; purchase_price_wo_vat; purchase_currency;  organisation_id; salesperson_id; campaign_id; cancel_id; delivery_date; delivery_time; order_date; order_time; invoice_date; invoice_time;  register_id; rebate_code_id\n242224 ; 1 ; 32 ; 2016-01-01 ; 15:00:00 ; XYZ ;2;10;20;20;0;0; EUR ; Visa ; 13 ;5;5; EUR ; 540 ; 5402101 ; 6344 ; null ; 2016-01-01 ; 15:00:00 ; 2016-01-01 ; 15:00:00 ; 2016-01-01 ; 15:00:00 ; 54022 ; 3233V\n"}},"components/schemas/ProductUploadPayloadJson":{"id":"components/schemas/ProductUploadPayloadJson","kind":"json-schema","title":"ProductUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"product_name":{"type":"string","description":"Product Name","example":"Widget XYZ"},"product_description":{"type":"string","description":"Product description","example":"Best performance XYZ on the market"},"category_id":{"type":"string","description":"Product category ID","example":"23"},"average_price":{"type":"number","description":"Running average purchase price for product.","example":8},"purchase_price":{"type":"number","description":"Default purchase price for product. Used if sales transaction doesn't have purchase price set.","example":10},"sales_price":{"type":"number","description":"Default retail price for product with taxes.","example":20},"sales_price_wo_vat":{"type":"number","description":"Default retail price for product without taxes.","example":16},"vat_rate":{"type":"number","description":"VAT/tax rate","example":24},"unit_of_measure":{"type":"string","description":"Unit of measure","example":"PCS"},"product_size":{"type":"string","description":"Product size","example":"XS"},"product_width":{"type":"string","description":"Product width","example":"5\""},"product_height":{"type":"string","description":"Product height","example":"10\""},"product_color":{"type":"string","description":"Product color","example":"Dark Blue"},"product_type":{"type":"string","description":"Product type","example":"Type A"},"product_brand":{"type":"string","description":"Product brand","example":"Nike"},"product_season":{"type":"string","description":"Product season","example":"Spring"},"model":{"type":"string","description":"a (string, optional) - Product model","example":"XYZ B40"},"model_number":{"type":"string","description":"Product model number","example":"X311"},"country_of_origin":{"type":"string","description":"Country of origin","example":"Moldovia"},"freight":{"type":"number","description":"Freight","example":5},"duty":{"type":"number","description":"Duty","example":0.24},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"fabric":{"type":"string","description":"Product fabric","example":"Felt"},"buyer":{"type":"string","description":"Buyer name","example":"Lena Shields"},"ean":{"type":"string","description":"Ean code","example":"Ean code"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"XY"},"image_url":{"type":"string","description":"Url for external product image file","example":"http://example.com?product=XYZ"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_field_6":{"type":"string","description":"Custom field 6","example":"EU only"},"custom_field_7":{"type":"string","description":"Custom field 7","example":"EU only"},"custom_field_8":{"type":"string","description":"Custom field 8","example":"EU only"},"custom_field_9":{"type":"string","description":"Custom field 9","example":"EU only"},"custom_field_10":{"type":"string","description":"Custom field 10","example":"EU only"},"custom_field_11":{"type":"string","description":"Custom field 11","example":"EU only"},"custom_field_12":{"type":"string","description":"Custom field 12","example":"EU only"},"custom_field_13":{"type":"string","description":"Custom field 13","example":"EU only"},"custom_field_14":{"type":"string","description":"Custom field 14","example":"EU only"},"custom_field_15":{"type":"string","description":"Custom field 15","example":"EU only"},"custom_field_16":{"type":"string","description":"Custom field 16","example":"EU only"},"custom_field_17":{"type":"string","description":"Custom field 17","example":"EU only"},"custom_field_18":{"type":"string","description":"Custom field 18","example":"EU only"},"custom_field_19":{"type":"string","description":"Custom field 19","example":"EU only"},"custom_field_20":{"type":"string","description":"Custom field 20","example":"EU only"},"custom_field_21":{"type":"string","description":"Custom field 21","example":"EU only"},"custom_field_22":{"type":"string","description":"Custom field 22","example":"EU only"},"custom_field_23":{"type":"string","description":"Custom field 23","example":"EU only"},"custom_field_24":{"type":"string","description":"Custom field 24","example":"EU only"},"custom_field_25":{"type":"string","description":"Custom field 25","example":"EU only"},"custom_field_26":{"type":"string","description":"Custom field 26","example":"EU only"},"custom_field_27":{"type":"string","description":"Custom field 27","example":"EU only"},"custom_field_28":{"type":"string","description":"Custom field 28","example":"EU only"},"custom_field_29":{"type":"string","description":"Custom field 29","example":"EU only"},"custom_field_30":{"type":"string","description":"Custom field 30","example":"EU only"},"custom_field_31":{"type":"string","description":"Custom field 31","example":"EU only"},"custom_field_32":{"type":"string","description":"Custom field 32","example":"EU only"},"custom_field_33":{"type":"string","description":"Custom field 33","example":"EU only"},"custom_field_34":{"type":"string","description":"Custom field 34","example":"EU only"},"custom_field_35":{"type":"string","description":"Custom field 35","example":"EU only"},"custom_field_36":{"type":"string","description":"Custom field 36","example":"EU only"},"custom_field_37":{"type":"string","description":"Custom field 37","example":"EU only"},"custom_field_38":{"type":"string","description":"Custom field 38","example":"EU only"},"custom_field_39":{"type":"string","description":"Custom field 39","example":"EU only"},"custom_field_40":{"type":"string","description":"Custom field 40","example":"EU only"},"custom_field_41":{"type":"string","description":"Custom field 41","example":"EU only"},"custom_field_42":{"type":"string","description":"Custom field 42","example":"EU only"},"custom_field_43":{"type":"string","description":"Custom field 43","example":"EU only"},"custom_field_44":{"type":"string","description":"Custom field 44","example":"EU only"},"custom_field_45":{"type":"string","description":"Custom field 45","example":"EU only"},"custom_field_46":{"type":"string","description":"Custom field 46","example":"EU only"},"custom_field_47":{"type":"string","description":"Custom field 47","example":"EU only"},"custom_field_48":{"type":"string","description":"Custom field 48","example":"EU only"},"custom_field_49":{"type":"string","description":"Custom field 49","example":"EU only"},"custom_field_50":{"type":"string","description":"Custom field 50","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"custom_metric_6":{"type":"number","description":"Custom metric 6","example":150},"custom_metric_7":{"type":"number","description":"Custom metric 7","example":1000},"custom_metric_8":{"type":"number","description":"Custom metric 8","example":2.52},"custom_metric_9":{"type":"number","description":"Custom metric 9","example":1.5},"custom_metric_10":{"type":"number","description":"Custom metric 10","example":2000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["product_id","product_name","model"],"additionalProperties":false,"example":{"product_id":"XYZ","product_name":"Widget XYZ","product_description":"Best performance XYZ on the market","category_id":"23","average_price":8,"purchase_price":10,"sales_price":20,"sales_price_wo_vat":16,"vat_rate":24,"unit_of_measure":"PCS","product_size":"XS","product_width":"5\"","product_height":"10\"","product_color":"Dark Blue","product_type":"Type A","product_brand":"Nike","product_season":"Spring","model":"XYZ B40","model_number":"X311","country_of_origin":"Moldovia","freight":5,"duty":0.24,"supplier_id":"221","fabric":"Felt","buyer":"Lena Shields","ean":"Ean code","parent_product_id":"XY","image_url":"http://example.com?product=XYZ","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_field_11":"EU only","custom_field_12":"EU only","custom_field_13":"EU only","custom_field_14":"EU only","custom_field_15":"EU only","custom_field_16":"EU only","custom_field_17":"EU only","custom_field_18":"EU only","custom_field_19":"EU only","custom_field_20":"EU only","custom_field_21":"EU only","custom_field_22":"EU only","custom_field_23":"EU only","custom_field_24":"EU only","custom_field_25":"EU only","custom_field_26":"EU only","custom_field_27":"EU only","custom_field_28":"EU only","custom_field_29":"EU only","custom_field_30":"EU only","custom_field_31":"EU only","custom_field_32":"EU only","custom_field_33":"EU only","custom_field_34":"EU only","custom_field_35":"EU only","custom_field_36":"EU only","custom_field_37":"EU only","custom_field_38":"EU only","custom_field_39":"EU only","custom_field_40":"EU only","custom_field_41":"EU only","custom_field_42":"EU only","custom_field_43":"EU only","custom_field_44":"EU only","custom_field_45":"EU only","custom_field_46":"EU only","custom_field_47":"EU only","custom_field_48":"EU only","custom_field_49":"EU only","custom_field_50":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":150,"custom_metric_7":1000,"custom_metric_8":2.52,"custom_metric_9":1.5,"custom_metric_10":2000,"source_system":"ABCDEF"}},"example":[{"product_id":"XYZ","product_name":"Widget XYZ","product_description":"Best performance XYZ on the market","category_id":"23","average_price":8,"purchase_price":10,"sales_price":20,"sales_price_wo_vat":16,"vat_rate":24,"unit_of_measure":"PCS","product_size":"XS","product_width":"5\"","product_height":"10\"","product_color":"Dark Blue","product_type":"Type A","product_brand":"Nike","product_season":"Spring","model":"XYZ B40","model_number":"X311","country_of_origin":"Moldovia","freight":5,"duty":0.24,"supplier_id":"221","fabric":"Felt","buyer":"Lena Shields","ean":"Ean code","parent_product_id":"XY","image_url":"http://example.com?product=XYZ","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_field_11":"EU only","custom_field_12":"EU only","custom_field_13":"EU only","custom_field_14":"EU only","custom_field_15":"EU only","custom_field_16":"EU only","custom_field_17":"EU only","custom_field_18":"EU only","custom_field_19":"EU only","custom_field_20":"EU only","custom_field_21":"EU only","custom_field_22":"EU only","custom_field_23":"EU only","custom_field_24":"EU only","custom_field_25":"EU only","custom_field_26":"EU only","custom_field_27":"EU only","custom_field_28":"EU only","custom_field_29":"EU only","custom_field_30":"EU only","custom_field_31":"EU only","custom_field_32":"EU only","custom_field_33":"EU only","custom_field_34":"EU only","custom_field_35":"EU only","custom_field_36":"EU only","custom_field_37":"EU only","custom_field_38":"EU only","custom_field_39":"EU only","custom_field_40":"EU only","custom_field_41":"EU only","custom_field_42":"EU only","custom_field_43":"EU only","custom_field_44":"EU only","custom_field_45":"EU only","custom_field_46":"EU only","custom_field_47":"EU only","custom_field_48":"EU only","custom_field_49":"EU only","custom_field_50":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":150,"custom_metric_7":1000,"custom_metric_8":2.52,"custom_metric_9":1.5,"custom_metric_10":2000,"source_system":"ABCDEF"}]}]}},"components/schemas/CustomerUploadPayloadJson":{"id":"components/schemas/CustomerUploadPayloadJson","kind":"json-schema","title":"CustomerUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Customer"},{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string","description":"Customer ID","example":"32"},"customer_name":{"type":"string","description":"Customer Name","example":"John Smith"},"customer_company":{"type":"string","description":"Customer Company","example":"Smith Industries"},"customer_email":{"type":"string","description":"Customer Email","example":"john.smith@customer.customer"},"customer_phone":{"type":"string","description":"Customer Phone","example":"+35811111111"},"customer_address":{"type":"string","description":"Customer Street Address","example":"Mannerheimintie 1"},"customer_zipcode":{"type":"string","description":"Customer's Zip Code","example":"00100"},"customer_city":{"type":"string","description":"Customer City","example":"Helsinki"},"customer_country":{"type":"string","description":"Customer Country","example":"Finland"},"customer_group_id":{"type":"string","description":"Customer Group ID","example":"2"},"customer_group_name":{"type":"string","description":"Customer Group Name","example":"B2"},"account_number":{"type":"string","description":"Account Number","example":"X5434"},"vat_number":{"type":"string","description":"9 (string, optional) - VAT Number","example":"12345678"},"organisation_id":{"type":"string","description":"Customer account store ID","example":"1"},"salesperson_id":{"type":"string","description":"Sales person id responsible for this customer account.","example":"123"},"creation_date":{"type":"string","description":"Date when this customer was added to system (yyyy-mm-dd).","example":"2021-12-15"},"subscribe_date":{"type":"string","description":"Date when this customer subscribed newsletter (yyyy-mm-dd).","example":"2022-01-15"},"unsubscribe_date":{"type":"string","description":"Date when this customer unsubscribed newsletter (yyyy-mm-dd).","example":"2022-02-15"},"register_date":{"type":"string","description":"Date when this customer registered to system (yyyy-mm-dd).","example":"2022-01-10"},"unregister_date":{"type":"string","description":"Date when this customer unregistered from system (yyyy-mm-dd).","example":"2022-03-15"},"hierarchy_level_1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 1. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}],"example":"A1"},"hierarchy_level_2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 2. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}],"example":"Family shoppers"},"hierarchy_level_3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 3. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}],"example":"Families with babies"},"hierarchy_level_4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 4. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}],"example":"A4"},"hierarchy_level_5":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hierarchy Level 5. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please use FlatHierarchy endpoint."},"children":[]}]}]}],"example":"A5"},"custom_dimension_1":{"type":"string","description":"Custom Field 1","example":"Class 3"},"custom_dimension_2":{"type":"string","description":"Custom Field 2","example":"Class 2"},"custom_dimension_3":{"type":"string","description":"Custom Field 3","example":"Class 1"},"custom_dimension_4":{"type":"string","description":"Custom Field 4","example":"XYZ"},"custom_dimension_5":{"type":"string","description":"Custom Field 5","example":"XYZ"},"custom_dimension_6":{"type":"string","description":"Custom Field 6","example":"Class 3"},"custom_dimension_7":{"type":"string","description":"Custom Field 7","example":"Class 3"},"custom_dimension_8":{"type":"string","description":"Custom Field 8","example":"Class 3"},"custom_dimension_9":{"type":"string","description":"Custom Field 9","example":"Class 3"},"custom_dimension_10":{"type":"string","description":"Custom Field 10","example":"Class 3"},"custom_dimension_11":{"type":"string","description":"Custom Field 11","example":"Class 3"},"custom_dimension_12":{"type":"string","description":"Custom Field 12","example":"Class 3"},"custom_dimension_13":{"type":"string","description":"Custom Field 13","example":"Class 3"},"custom_dimension_14":{"type":"string","description":"Custom Field 14","example":"Class 3"},"custom_dimension_15":{"type":"string","description":"Custom Field 15","example":"Class 3"},"custom_dimension_16":{"type":"string","description":"Custom Field 16","example":"Class 3"},"custom_dimension_17":{"type":"string","description":"Custom Field 17","example":"Class 3"},"custom_dimension_18":{"type":"string","description":"Custom Field 18","example":"Class 3"},"custom_dimension_19":{"type":"string","description":"Custom Field 19","example":"Class 3"},"custom_dimension_20":{"type":"string","description":"Custom Field 20","example":"Class 3"},"custom_dimension_21":{"type":"string","description":"Custom Field 21","example":"Class 3"},"custom_dimension_22":{"type":"string","description":"Custom Field 22","example":"Class 3"},"custom_dimension_23":{"type":"string","description":"Custom Field 23","example":"Class 3"},"custom_dimension_24":{"type":"string","description":"Custom Field 24","example":"Class 3"},"custom_dimension_25":{"type":"string","description":"Custom Field 25","example":"Class 3"},"custom_dimension_26":{"type":"string","description":"Custom Field 26","example":"Class 3"},"custom_dimension_27":{"type":"string","description":"Custom Field 27","example":"Class 3"},"custom_dimension_28":{"type":"string","description":"Custom Field 28","example":"Class 3"},"custom_dimension_29":{"type":"string","description":"Custom Field 29","example":"Class 3"},"custom_dimension_30":{"type":"string","description":"Custom Field 30","example":"Class 3"},"custom_dimension_31":{"type":"string","description":"Custom Field 31","example":"Class 3"},"custom_dimension_32":{"type":"string","description":"Custom Field 32","example":"Class 3"},"custom_dimension_33":{"type":"string","description":"Custom Field 33","example":"Class 3"},"custom_dimension_34":{"type":"string","description":"Custom Field 34","example":"Class 3"},"custom_dimension_35":{"type":"string","description":"Custom Field 35","example":"Class 3"},"custom_dimension_36":{"type":"string","description":"Custom Field 36","example":"Class 3"},"custom_dimension_37":{"type":"string","description":"Custom Field 37","example":"Class 3"},"custom_dimension_38":{"type":"string","description":"Custom Field 38","example":"Class 3"},"custom_dimension_39":{"type":"string","description":"Custom Field 39","example":"Class 3"},"custom_dimension_40":{"type":"string","description":"Custom Field 40","example":"Class 3"},"custom_dimension_41":{"type":"string","description":"Custom Field 41","example":"Class 3"},"custom_dimension_42":{"type":"string","description":"Custom Field 42","example":"Class 3"},"custom_dimension_43":{"type":"string","description":"Custom Field 43","example":"Class 3"},"custom_dimension_44":{"type":"string","description":"Custom Field 44","example":"Class 3"},"custom_dimension_45":{"type":"string","description":"Custom Field 45","example":"Class 3"},"custom_dimension_46":{"type":"string","description":"Custom Field 46","example":"Class 3"},"custom_dimension_47":{"type":"string","description":"Custom Field 47","example":"Class 3"},"custom_dimension_48":{"type":"string","description":"Custom Field 48","example":"Class 3"},"custom_dimension_49":{"type":"string","description":"Custom Field 49","example":"Class 3"},"custom_dimension_50":{"type":"string","description":"Custom Field 50","example":"Class 3"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["customer_id","vat_number"],"additionalProperties":false,"example":{"customer_id":"32","customer_name":"John Smith","customer_company":"Smith Industries","customer_email":"john.smith@customer.customer","customer_phone":"+35811111111","customer_address":"Mannerheimintie 1","customer_zipcode":"00100","customer_city":"Helsinki","customer_country":"Finland","customer_group_id":"2","customer_group_name":"B2","account_number":"X5434","vat_number":"12345678","organisation_id":"1","salesperson_id":"123","creation_date":"2021-12-15","subscribe_date":"2022-01-15","unsubscribe_date":"2022-02-15","register_date":"2022-01-10","unregister_date":"2022-03-15","hierarchy_level_1":"A1","hierarchy_level_2":"Family shoppers","hierarchy_level_3":"Families with babies","hierarchy_level_4":"A4","hierarchy_level_5":"A5","custom_dimension_1":"Class 3","custom_dimension_2":"Class 2","custom_dimension_3":"Class 1","custom_dimension_4":"XYZ","custom_dimension_5":"XYZ","custom_dimension_6":"Class 3","custom_dimension_7":"Class 3","custom_dimension_8":"Class 3","custom_dimension_9":"Class 3","custom_dimension_10":"Class 3","custom_dimension_11":"Class 3","custom_dimension_12":"Class 3","custom_dimension_13":"Class 3","custom_dimension_14":"Class 3","custom_dimension_15":"Class 3","custom_dimension_16":"Class 3","custom_dimension_17":"Class 3","custom_dimension_18":"Class 3","custom_dimension_19":"Class 3","custom_dimension_20":"Class 3","custom_dimension_21":"Class 3","custom_dimension_22":"Class 3","custom_dimension_23":"Class 3","custom_dimension_24":"Class 3","custom_dimension_25":"Class 3","custom_dimension_26":"Class 3","custom_dimension_27":"Class 3","custom_dimension_28":"Class 3","custom_dimension_29":"Class 3","custom_dimension_30":"Class 3","custom_dimension_31":"Class 3","custom_dimension_32":"Class 3","custom_dimension_33":"Class 3","custom_dimension_34":"Class 3","custom_dimension_35":"Class 3","custom_dimension_36":"Class 3","custom_dimension_37":"Class 3","custom_dimension_38":"Class 3","custom_dimension_39":"Class 3","custom_dimension_40":"Class 3","custom_dimension_41":"Class 3","custom_dimension_42":"Class 3","custom_dimension_43":"Class 3","custom_dimension_44":"Class 3","custom_dimension_45":"Class 3","custom_dimension_46":"Class 3","custom_dimension_47":"Class 3","custom_dimension_48":"Class 3","custom_dimension_49":"Class 3","custom_dimension_50":"Class 3","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"customer_id":"32","customer_name":"John Smith","customer_company":"Smith Industries","customer_email":"john.smith@customer.customer","customer_phone":"+35811111111","customer_address":"Mannerheimintie 1","customer_zipcode":"00100","customer_city":"Helsinki","customer_country":"Finland","customer_group_id":"2","customer_group_name":"B2","account_number":"X5434","vat_number":"12345678","organisation_id":"1","salesperson_id":"123","creation_date":"2021-12-15","subscribe_date":"2022-01-15","unsubscribe_date":"2022-02-15","register_date":"2022-01-10","unregister_date":"2022-03-15","hierarchy_level_1":"A1","hierarchy_level_2":"Family shoppers","hierarchy_level_3":"Families with babies","hierarchy_level_4":"A4","hierarchy_level_5":"A5","custom_dimension_1":"Class 3","custom_dimension_2":"Class 2","custom_dimension_3":"Class 1","custom_dimension_4":"XYZ","custom_dimension_5":"XYZ","custom_dimension_6":"Class 3","custom_dimension_7":"Class 3","custom_dimension_8":"Class 3","custom_dimension_9":"Class 3","custom_dimension_10":"Class 3","custom_dimension_11":"Class 3","custom_dimension_12":"Class 3","custom_dimension_13":"Class 3","custom_dimension_14":"Class 3","custom_dimension_15":"Class 3","custom_dimension_16":"Class 3","custom_dimension_17":"Class 3","custom_dimension_18":"Class 3","custom_dimension_19":"Class 3","custom_dimension_20":"Class 3","custom_dimension_21":"Class 3","custom_dimension_22":"Class 3","custom_dimension_23":"Class 3","custom_dimension_24":"Class 3","custom_dimension_25":"Class 3","custom_dimension_26":"Class 3","custom_dimension_27":"Class 3","custom_dimension_28":"Class 3","custom_dimension_29":"Class 3","custom_dimension_30":"Class 3","custom_dimension_31":"Class 3","custom_dimension_32":"Class 3","custom_dimension_33":"Class 3","custom_dimension_34":"Class 3","custom_dimension_35":"Class 3","custom_dimension_36":"Class 3","custom_dimension_37":"Class 3","custom_dimension_38":"Class 3","custom_dimension_39":"Class 3","custom_dimension_40":"Class 3","custom_dimension_41":"Class 3","custom_dimension_42":"Class 3","custom_dimension_43":"Class 3","custom_dimension_44":"Class 3","custom_dimension_45":"Class 3","custom_dimension_46":"Class 3","custom_dimension_47":"Class 3","custom_dimension_48":"Class 3","custom_dimension_49":"Class 3","custom_dimension_50":"Class 3","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/CustomerUploadPayloadCsv":{"id":"components/schemas/CustomerUploadPayloadCsv","kind":"json-schema","title":"CustomerUploadPayloadCsv","data":{"type":"string","description":"Customers data in CSV format.","example":"customer_id;customer_name;customer_company;customer_email;customer_phone;customer_address;customer_zipcode;customer_city;customer_country;customer_group_id;customer_group_name\n32; John Smith; Smith Industries; john.smith@customer.customer;+35811111111; Mannerheimintie 1;00100; Helsinki; Finland; ;\n"}},"components/schemas/CustomerFeedbackUploadPayloadJson":{"id":"components/schemas/CustomerFeedbackUploadPayloadJson","kind":"json-schema","title":"CustomerFeedbackUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/CustomerFeedback"},{"type":"array","items":{"type":"object","properties":{"feedback_id":{"type":"string","description":"Unique ID for this feedback entry","example":"xyz"},"respondent_id":{"type":"string","description":"Optional ID for survey respondent. Can be used to group all responses by single respondent.","example":"1234"},"survey_id":{"type":"string","description":"Optional ID for survey. Can be used to separate responses between different surveys.","example":"Survey 1"},"question_id":{"type":"string","description":"Optional ID for feedback question. Should be used if multiple separate feedback questions are needed.","example":"Q1"},"organisation_id":{"type":"string","description":"Identifier of store this feedback entry refers to","example":"ORG1"},"department_id":{"type":"string","description":"Optional identifier of department this feedback entry refers to","example":"DEP1"},"feedback_date":{"type":"string","description":"Date of feedback (yyyy-mm-dd)","example":"2018-01-01"},"feedback_time":{"type":"string","description":"Optional time of feedback (hh:mm:ss)","example":"15:00:00"},"feedback_type":{"type":"string","description":"Optional type of feedback","example":"Store survey"},"main_feedback":{"type":"boolean","description":"Is this main (overall grade) feedback. Default is true.","example":true},"grade":{"type":"number","description":"Numerical grade for feedback","example":9},"grade_total":{"type":"number","description":"Optional numerical total grade calculated by source (eg. Google Review) for feedback","example":8.5},"comments":{"type":"string","description":"Optional free form feedback","example":"Great service today!"},"comments_en":{"type":"string","description":"Optional free form feedback translated in English","example":"Great service today!"},"review_url":{"type":"string","description":"Google review URL","example":"https://www.google.com/maps/reviews?data=XYZ"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["feedback_id","organisation_id","feedback_date","grade"],"additionalProperties":false,"example":{"feedback_id":"xyz","respondent_id":"1234","survey_id":"Survey 1","question_id":"Q1","organisation_id":"ORG1","department_id":"DEP1","feedback_date":"2018-01-01","feedback_time":"15:00:00","feedback_type":"Store survey","main_feedback":true,"grade":9,"grade_total":8.5,"comments":"Great service today!","comments_en":"Great service today!","review_url":"https://www.google.com/maps/reviews?data=XYZ","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}},"example":[{"feedback_id":"xyz","respondent_id":"1234","survey_id":"Survey 1","question_id":"Q1","organisation_id":"ORG1","department_id":"DEP1","feedback_date":"2018-01-01","feedback_time":"15:00:00","feedback_type":"Store survey","main_feedback":true,"grade":9,"grade_total":8.5,"comments":"Great service today!","comments_en":"Great service today!","review_url":"https://www.google.com/maps/reviews?data=XYZ","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}]}]}},"components/schemas/CustomerFeedbackUploadPayloadCsv":{"id":"components/schemas/CustomerFeedbackUploadPayloadCsv","kind":"json-schema","title":"CustomerFeedbackUploadPayloadCsv","data":{"type":"string","description":"Customer feedback data in CSV format.","example":"feedback_id;organisation_id;department_id;feedback_date;feedback_time;feedback_type;grade;comments\nxyz;ORG1;DEP1;2018-01-01;15:00:00;\"Store survey\";9;\"Great service today!\"\n"}},"components/schemas/CashierBalanceUploadPayloadJson":{"id":"components/schemas/CashierBalanceUploadPayloadJson","kind":"json-schema","title":"CashierBalanceUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/CashierBalance"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Identifier of store for this balance","example":"ORG1"},"department_id":{"type":"string","description":"Optional identifier of department for this balance","example":"DEP1"},"register_id":{"type":"string","description":"Optional cash register identifier for this balance","example":"123"},"batch_id":{"type":"string","description":"Optional batch or shift identifier for this balance row","example":"1"},"payment_method":{"type":"string","description":"Payment method of this balance row","example":"Cash"},"sales_date":{"type":"string","description":"Date of balance (yyyy-mm-dd)","example":"2018-01-01"},"sales_time":{"type":"string","description":"Optional time of balance (hh:mm:ss)","example":"15:00:00"},"batch_status":{"type":"string","description":"Optional status of this batch ID","example":"OK"},"transaction_count":{"type":"number","description":"Number of transactions for this shift and payment method","example":9},"shift_amount":{"type":"number","description":"Total amount of payments for this shift and payment method","example":1000},"over_short":{"type":"number","description":"Difference in money between sales and shift amounts","example":100},"cash_dropped":{"type":"number","description":"How much cash was dropped from register during this shift","example":0},"cash_paid_out":{"type":"number","description":"How much cash was paid out from register during this shift","example":50},"currency":{"type":"string","description":"Shift currency as ISO 4217 currency code. Required if multiple currencies are used by the customer.","example":"EUR"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","payment_method","sales_date","transaction_count","shift_amount"],"additionalProperties":false,"example":{"organisation_id":"ORG1","department_id":"DEP1","register_id":"123","batch_id":"1","payment_method":"Cash","sales_date":"2018-01-01","sales_time":"15:00:00","batch_status":"OK","transaction_count":9,"shift_amount":1000,"over_short":100,"cash_dropped":0,"cash_paid_out":50,"currency":"EUR","source_system":"ABCDEF"}},"example":[{"organisation_id":"ORG1","department_id":"DEP1","register_id":"123","batch_id":"1","payment_method":"Cash","sales_date":"2018-01-01","sales_time":"15:00:00","batch_status":"OK","transaction_count":9,"shift_amount":1000,"over_short":100,"cash_dropped":0,"cash_paid_out":50,"currency":"EUR","source_system":"ABCDEF"}]}]}},"components/schemas/CashierBalanceUploadPayloadCsv":{"id":"components/schemas/CashierBalanceUploadPayloadCsv","kind":"json-schema","title":"CashierBalanceUploadPayloadCsv","data":{"type":"string","description":"Cashier balance data in CSV format.","example":"organisation_id;department_id;batch_id;sales_date;sales_time;batch_status;payment_type;transaction_count;shift_amount;over_short;cash_dropped;cash_paid_out\nORG1;DEP1;1;2018-01-01;15:00:00;OK;Cash;9;1000.00;100.00;0.00;50.00\n"}},"components/schemas/OrganisationUnitUploadPayloadJson":{"id":"components/schemas/OrganisationUnitUploadPayloadJson","kind":"json-schema","title":"OrganisationUnitUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/OrganisationUnit"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"organisation_name":{"type":"string","description":"Organisation name","example":"Web Sales"},"street_address":{"type":"string","description":"Street address","example":"Mannerheimintie 1"},"city":{"type":"string","description":"City","example":"Helsinki"},"post_code":{"type":"string","description":"Postal code","example":"00100"},"state":{"type":"string","description":"State","example":"Southern Finland"},"country":{"type":"string","description":"Country","example":"Finland"},"area":{"type":"string","description":"Sales area","example":"South"},"latitude":{"type":"number","description":"Latitude","example":60.184014},"longitude":{"type":"number","description":"Longitude","example":24.960046},"channel":{"type":"string","description":"Sales channel","example":"Concession"},"organisation_type":{"type":"string","description":"Outlet / Brand / Essential","example":"Outlet"},"organisation_group":{"type":"string","description":"Organisation group","example":"A"},"floor_area":{"type":"number","description":"Store floor area eg. in m2","example":123.5},"no_customer_seats":{"type":"number","description":"Number of customer seats in store","example":150},"google_location_url":{"type":"string","description":"Google review location URL","example":"https://www.google.com/maps/reviews?data=XYZ"},"image_url":{"type":"string","description":"Url for external store image file","example":"http://example.com?product=XYZ"},"store_status":{"type":"string","enum":["open","closed","temporarily_closed"],"description":"Status of store","example":"closed"},"custom_dimension1":{"type":"string","description":"Custom Field 1","example":"Class 3"},"custom_dimension2":{"type":"string","description":"Custom Field 2","example":"Class 3"},"custom_dimension3":{"type":"string","description":"Custom Field 3","example":"Class 3"},"custom_dimension4":{"type":"string","description":"Custom Field 4","example":"Class 3"},"custom_dimension5":{"type":"string","description":"Custom Field 5","example":"Class 3"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","organisation_name"],"additionalProperties":false,"example":{"organisation_id":"540","organisation_name":"Web Sales","street_address":"Mannerheimintie 1","city":"Helsinki","post_code":"00100","state":"Southern Finland","country":"Finland","area":"South","latitude":60.184014,"longitude":24.960046,"channel":"Concession","organisation_type":"Outlet","organisation_group":"A","floor_area":123.5,"no_customer_seats":150,"google_location_url":"https://www.google.com/maps/reviews?data=XYZ","image_url":"http://example.com?product=XYZ","store_status":"closed","custom_dimension1":"Class 3","custom_dimension2":"Class 3","custom_dimension3":"Class 3","custom_dimension4":"Class 3","custom_dimension5":"Class 3","source_system":"ABCDEF"}},"example":[{"organisation_id":"540","organisation_name":"Web Sales","street_address":"Mannerheimintie 1","city":"Helsinki","post_code":"00100","state":"Southern Finland","country":"Finland","area":"South","latitude":60.184014,"longitude":24.960046,"channel":"Concession","organisation_type":"Outlet","organisation_group":"A","floor_area":123.5,"no_customer_seats":150,"google_location_url":"https://www.google.com/maps/reviews?data=XYZ","image_url":"http://example.com?product=XYZ","store_status":"closed","custom_dimension1":"Class 3","custom_dimension2":"Class 3","custom_dimension3":"Class 3","custom_dimension4":"Class 3","custom_dimension5":"Class 3","source_system":"ABCDEF"}]}]}},"components/schemas/OrganisationUnitUploadPayloadCsv":{"id":"components/schemas/OrganisationUnitUploadPayloadCsv","kind":"json-schema","title":"OrganisationUnitUploadPayloadCsv","data":{"type":"string","description":"Organisations data in CSV format.","example":"organisation_id;organisation_name;street_address;city;post_code;state;country;area;channel;store_type\n540; Web Sales; Mannerheimintie 1; Helsinki;00100; Southern Finland; Finland; South; Concession;Outlet\n"}},"components/schemas/DepartmentUploadPayloadJson":{"id":"components/schemas/DepartmentUploadPayloadJson","kind":"json-schema","title":"DepartmentUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Department"},{"type":"array","items":{"type":"object","properties":{"department_id":{"type":"string","description":"Department ID","example":"123"},"name":{"type":"string","description":"Human readable name for the deparment","example":"Women's clothing"},"floor_area":{"type":"number","description":"Floor area of deparment in square meters","example":20},"organisation_id":{"type":"string","description":"ID of attached organisation","example":"234"},"no_customer_seats":{"type":"number","description":"Number of customer seats available","example":50},"custom_dimension1":{"type":"string","description":"Custom Field 1","example":"Class 3"},"custom_dimension2":{"type":"string","description":"Custom Field 2","example":"New"},"custom_dimension3":{"type":"string","description":"Custom Field 3","example":"Old"},"custom_dimension4":{"type":"string","description":"Custom Field 4","example":"New"},"custom_dimension5":{"type":"string","description":"Custom Field 5","example":"New"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["department_id","name"],"additionalProperties":false,"example":{"department_id":"123","name":"Women's clothing","floor_area":20,"organisation_id":"234","no_customer_seats":50,"custom_dimension1":"Class 3","custom_dimension2":"New","custom_dimension3":"Old","custom_dimension4":"New","custom_dimension5":"New","source_system":"ABCDEF"}},"example":[{"department_id":"123","name":"Women's clothing","floor_area":20,"organisation_id":"234","no_customer_seats":50,"custom_dimension1":"Class 3","custom_dimension2":"New","custom_dimension3":"Old","custom_dimension4":"New","custom_dimension5":"New","source_system":"ABCDEF"}]}]}},"components/schemas/DepartmentUploadPayloadCsv":{"id":"components/schemas/DepartmentUploadPayloadCsv","kind":"json-schema","title":"DepartmentUploadPayloadCsv","data":{"type":"string","description":"Departments data in CSV format.","example":"department_id;name;floor_area;organisation_id\n123;Women's clothing;20;234\n"}},"components/schemas/SalesPersonUploadPayloadJson":{"id":"components/schemas/SalesPersonUploadPayloadJson","kind":"json-schema","title":"SalesPersonUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/SalesPerson"},{"type":"array","items":{"type":"object","properties":{"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"salesperson_name":{"type":"string","description":"Sales person name","example":"John Smith"},"salesperson_email":{"type":"string","description":"Sales person email","example":"john.smith@store.store"},"salesperson_phone":{"type":"string","description":"Sales person phone number","example":"+35811111111"},"employee_id":{"type":"string","description":"Employee id","example":"353"},"employment_start":{"type":"string","description":"Employment start date","example":"2020-01-01"},"employment_end":{"type":"string","description":"Employment end date","example":"2020-05-31"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"Project worker"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"Project worker"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"Project worker"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"Project worker"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"Project worker"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["salesperson_id"],"additionalProperties":false,"example":{"salesperson_id":"5402101","salesperson_name":"John Smith","salesperson_email":"john.smith@store.store","salesperson_phone":"+35811111111","employee_id":"353","employment_start":"2020-01-01","employment_end":"2020-05-31","custom_field_1":"Project worker","custom_field_2":"Project worker","custom_field_3":"Project worker","custom_field_4":"Project worker","custom_field_5":"Project worker","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"salesperson_id":"5402101","salesperson_name":"John Smith","salesperson_email":"john.smith@store.store","salesperson_phone":"+35811111111","employee_id":"353","employment_start":"2020-01-01","employment_end":"2020-05-31","custom_field_1":"Project worker","custom_field_2":"Project worker","custom_field_3":"Project worker","custom_field_4":"Project worker","custom_field_5":"Project worker","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/SalesPersonUploadPayloadCsv":{"id":"components/schemas/SalesPersonUploadPayloadCsv","kind":"json-schema","title":"SalesPersonUploadPayloadCsv","data":{"type":"string","description":"Sales persons data in CSV format.","example":"salesperson_id;salesperson_name;salesperson_email;salesperson_phone;employment_start;employment_end;custom_field_1\n5402101;John Smith;john.smith@store.store;+35811111111;2020-01-01;2020-05-31;Project worker\n"}},"components/schemas/CashRegisterUploadPayloadJson":{"id":"components/schemas/CashRegisterUploadPayloadJson","kind":"json-schema","title":"CashRegisterUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/CashRegister"},{"type":"array","items":{"type":"object","properties":{"register_id":{"type":"string","description":"Register ID","example":"123-1"},"register_name":{"type":"string","description":"Register name","example":"Kiosk 1"},"organisation_id":{"type":"string","description":"Organisation / store this register belongs to","example":"540"},"register_type":{"type":"string","description":"Register type","example":"Kiosk"},"register_group":{"type":"string","description":"Register group","example":"Self service"},"custom_dimension1":{"type":"string","description":"Custom Field 1","example":"Class 3"},"custom_dimension2":{"type":"string","description":"Custom Field 2","example":"Class 3"},"custom_dimension3":{"type":"string","description":"Custom Field 3","example":"Class 3"},"custom_dimension4":{"type":"string","description":"Custom Field 4","example":"Class 3"},"custom_dimension5":{"type":"string","description":"Custom Field 5","example":"Class 3"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["register_id","register_name"],"additionalProperties":false,"example":{"register_id":"123-1","register_name":"Kiosk 1","organisation_id":"540","register_type":"Kiosk","register_group":"Self service","custom_dimension1":"Class 3","custom_dimension2":"Class 3","custom_dimension3":"Class 3","custom_dimension4":"Class 3","custom_dimension5":"Class 3","source_system":"ABCDEF"}},"example":[{"register_id":"123-1","register_name":"Kiosk 1","organisation_id":"540","register_type":"Kiosk","register_group":"Self service","custom_dimension1":"Class 3","custom_dimension2":"Class 3","custom_dimension3":"Class 3","custom_dimension4":"Class 3","custom_dimension5":"Class 3","source_system":"ABCDEF"}]}]}},"components/schemas/CashRegisterUploadPayloadCsv":{"id":"components/schemas/CashRegisterUploadPayloadCsv","kind":"json-schema","title":"CashRegisterUploadPayloadCsv","data":{"type":"string","description":"Cash registers data in CSV format.","example":"register_id;register_name;register_type;register_group;custom_field_1\n123-1;Kiosk 1;Kiosk;Self service;My Pos 1\n"}},"components/schemas/OpeningHourUploadPayloadJson":{"id":"components/schemas/OpeningHourUploadPayloadJson","kind":"json-schema","title":"OpeningHourUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/OpeningHour"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID. If omitted entry is treated as company default hours.","example":"540"},"start_date":{"type":"string","description":"Start date of opening hour season (yyyy-mm-dd)","example":"2024-01-01"},"end_date":{"type":"string","description":"End date of opening hour season (yyyy-mm-dd)","example":"2025-01-01"},"weekday":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weekday as integer (1 = Monday, 7 = Sunday)"},"children":[]}]}]}],"example":1},"open_start":{"type":"string","description":"Open start time (hh:mm:ss)","example":"08:00:00"},"open_end":{"type":"string","description":"Open end time (hh:mm:ss)","example":"15:00:00"},"special_period":{"type":"boolean","description":"Is this a special opening period","example":false},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["start_date","weekday","open_start","open_end"],"additionalProperties":false,"example":{"organisation_id":"540","start_date":"2024-01-01","end_date":"2025-01-01","weekday":1,"open_start":"08:00:00","open_end":"15:00:00","special_period":false,"source_system":"ABCDEF"}},"example":[{"organisation_id":"540","start_date":"2024-01-01","end_date":"2025-01-01","weekday":1,"open_start":"08:00:00","open_end":"15:00:00","special_period":false,"source_system":"ABCDEF"}]}]}},"components/schemas/OpeningHourUploadPayloadCsv":{"id":"components/schemas/OpeningHourUploadPayloadCsv","kind":"json-schema","title":"OpeningHourUploadPayloadCsv","data":{"type":"string","description":"Store open hours data in CSV format.","example":"organisation_id;start_date;end_date;weekday;open_start;open_end\nORG1;2025-01-01;2025-12-31;1;08:00:00;18:00:00\n"}},"components/schemas/CounterUploadPayloadJson":{"id":"components/schemas/CounterUploadPayloadJson","kind":"json-schema","title":"CounterUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Counter"},{"type":"array","items":{"type":"object","properties":{"counter_id":{"type":"string","description":"Counter ID","example":"5"},"counter_name":{"type":"string","description":"Counter name","example":"Front door 1"},"folder_id: front_door_1":{"type":"string","description":"Name of identification folder","example":""},"serial":{"type":"string","description":"Camera serial number","example":"ABCDE12345"},"registration_code":{"type":"string","description":"Camera registration code","example":"A1B2C3D4E5"},"disabled":{"type":"boolean","description":"True if the counter is disabled (i.e. is set to not send data)","example":false},"is_queue":{"type":"boolean","description":"True if the counter is a queue counter","example":false},"on_store_perimeter":{"type":"boolean","description":"True, if this a store perimeter camera","example":true},"organisation_id: my_organisation_id":{"type":"string","description":"Id of the store/organisation where the camera is located","example":""},"department_id: my_department_id":{"type":"string","description":"Id of the department where the camera is located","example":""},"department_reversed_id":{"type":"string","description":"Secondary department id where in and out counts are reversed.","example":"reverse_id"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["counter_id","counter_name","folder_id: front_door_1","disabled"],"additionalProperties":false,"example":{"counter_id":"5","counter_name":"Front door 1","folder_id: front_door_1":"","serial":"ABCDE12345","registration_code":"A1B2C3D4E5","disabled":false,"is_queue":false,"on_store_perimeter":true,"department_reversed_id":"reverse_id","source_system":"ABCDEF"}},"example":[{"counter_id":"5","counter_name":"Front door 1","folder_id: front_door_1":"","serial":"ABCDE12345","registration_code":"A1B2C3D4E5","disabled":false,"is_queue":false,"on_store_perimeter":true,"department_reversed_id":"reverse_id","source_system":"ABCDEF"}]}]}},"components/schemas/CounterUploadPayloadCsv":{"id":"components/schemas/CounterUploadPayloadCsv","kind":"json-schema","title":"CounterUploadPayloadCsv","data":{"type":"string","description":"Counters data in CSV format.","example":"counter_id;counter_name;department_id;disabled;folder_id;is_queue;last_update_time;on_store_perimeter;organisation_id;registration_code;serial;time_zone;first_connected_date;last_connected_date\nmy_counter;My counter name;my_department_id;false;my_folder_id;false;2023-06-20 11:15:00;true;my_organisation_id;A1B2C3D4E5;ABCDE12345;Europe/Helsinki;2022-11-20 15:04:37;2023-10-21 16:14:07\n"}},"components/schemas/AccountUploadPayloadJson":{"id":"components/schemas/AccountUploadPayloadJson","kind":"json-schema","title":"AccountUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Account"},{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","description":"Account ID","example":"1150"},"account_name":{"type":"string","description":"Account name","example":"Employee Salaries"},"account_type":{"type":"string","description":"Account type","example":"Salaries"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["account_id","account_name"],"additionalProperties":false,"example":{"account_id":"1150","account_name":"Employee Salaries","account_type":"Salaries","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","source_system":"ABCDEF"}},"example":[{"account_id":"1150","account_name":"Employee Salaries","account_type":"Salaries","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","source_system":"ABCDEF"}]}]}},"components/schemas/AccountUploadPayloadCsv":{"id":"components/schemas/AccountUploadPayloadCsv","kind":"json-schema","title":"AccountUploadPayloadCsv","data":{"type":"string","description":"Accounts data in CSV format.","example":"account_id;account_name;account_type;custom_field_1\n1015;Employee Salaries;Salaries;Cost Account\n"}},"components/schemas/EventUploadPayloadJson":{"id":"components/schemas/EventUploadPayloadJson","kind":"json-schema","title":"EventUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Event"},{"type":"array","items":{"type":"object","properties":{"event_id":{"type":"string","description":"Event ID","example":"1150"},"event_name":{"type":"string","description":"Event name","example":"Rock around the clock"},"event_type":{"type":"string","description":"Event type","example":"Concert"},"venue_name":{"type":"string","description":"Venue name","example":"Arena 1"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["event_id","event_name"],"additionalProperties":false,"example":{"event_id":"1150","event_name":"Rock around the clock","event_type":"Concert","venue_name":"Arena 1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","source_system":"ABCDEF"}},"example":[{"event_id":"1150","event_name":"Rock around the clock","event_type":"Concert","venue_name":"Arena 1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","source_system":"ABCDEF"}]}]}},"components/schemas/EventUploadPayloadCsv":{"id":"components/schemas/EventUploadPayloadCsv","kind":"json-schema","title":"EventUploadPayloadCsv","data":{"type":"string","description":"Events data in CSV format.","example":"event_id;event_name;event_type;custom_field_1\n101;Rock concert;Concert;Main Arena\n"}},"components/schemas/CalendarUploadPayloadJson":{"id":"components/schemas/CalendarUploadPayloadJson","kind":"json-schema","title":"CalendarUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Calendar"},{"type":"array","items":{"type":"object","properties":{"calendar_date":{"type":"string","description":"Calendar date (yyyy-mm-dd)","example":"2016-01-01"},"calendar_year":{"type":"string","description":"Calendar year","example":"2016/2017"},"period_name":{"type":"string","description":"Period name","example":"January"},"period_number":{"type":"number","description":"Period number","example":1},"week_number":{"type":"number","description":"Week number","example":1},"season":{"type":"string","description":"Season name","example":"Spring 2016"},"season_label":{"type":"string","description":"Season identifier","example":"Spring"},"lfl_date":{"type":"string","description":"Comparable sales date year ago (yyyy-mm-dd)","example":"2014-12-30"},"bank_holiday_name":{"type":"string","description":"Name of bank holiday if any","example":"New year Day"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["calendar_date"],"additionalProperties":false,"example":{"calendar_date":"2016-01-01","calendar_year":"2016/2017","period_name":"January","period_number":1,"week_number":1,"season":"Spring 2016","season_label":"Spring","lfl_date":"2014-12-30","bank_holiday_name":"New year Day","source_system":"ABCDEF"}},"example":[{"calendar_date":"2016-01-01","calendar_year":"2016/2017","period_name":"January","period_number":1,"week_number":1,"season":"Spring 2016","season_label":"Spring","lfl_date":"2014-12-30","bank_holiday_name":"New year Day","source_system":"ABCDEF"}]}]}},"components/schemas/CalendarUploadPayloadCsv":{"id":"components/schemas/CalendarUploadPayloadCsv","kind":"json-schema","title":"CalendarUploadPayloadCsv","data":{"type":"string","description":"Calendar data in CSV format.","example":"calendar_date;calendar_year;period_name;period_number;week_number;season;season_label;lfl_date;bank_holiday_name\n2018-01-01;2017/2018;January;1;1;Spring 2018;Spring;2016-12-30;New year day\n"}},"components/schemas/CampaignUploadPayloadJson":{"id":"components/schemas/CampaignUploadPayloadJson","kind":"json-schema","title":"CampaignUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Campaign"},{"type":"array","items":{"type":"object","properties":{"campaign_id":{"type":"string","description":"Campaign ID","example":"6344"},"campaign_name":{"type":"string","description":"Campaign name","example":"February 2016"},"campaign_type":{"type":"string","description":"Campaign type","example":"Web"},"start_date":{"type":"string","description":"Campaign Start Date (yyyy-mm-dd)","example":"2016-02-01"},"end_date":{"type":"string","description":"Campaign End Date (yyyy-mm-dd)","example":"2016-02-29"},"organisation_id":{"type":"string","description":"Organisation ID","example":"540"},"custom_field_1":{"type":"string","description":"Custom Field 1","example":"New"},"custom_field_2":{"type":"string","description":"Custom Field 2","example":"New"},"custom_field_3":{"type":"string","description":"Custom Field 3","example":"New"},"custom_field_4":{"type":"string","description":"Custom Field 4","example":"New"},"custom_field_5":{"type":"string","description":"Custom Field 5","example":"New"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["campaign_id","campaign_name"],"additionalProperties":false,"example":{"campaign_id":"6344","campaign_name":"February 2016","campaign_type":"Web","start_date":"2016-02-01","end_date":"2016-02-29","organisation_id":"540","custom_field_1":"New","custom_field_2":"New","custom_field_3":"New","custom_field_4":"New","custom_field_5":"New","source_system":"ABCDEF"}},"example":[{"campaign_id":"6344","campaign_name":"February 2016","campaign_type":"Web","start_date":"2016-02-01","end_date":"2016-02-29","organisation_id":"540","custom_field_1":"New","custom_field_2":"New","custom_field_3":"New","custom_field_4":"New","custom_field_5":"New","source_system":"ABCDEF"}]}]}},"components/schemas/CampaignUploadPayloadCsv":{"id":"components/schemas/CampaignUploadPayloadCsv","kind":"json-schema","title":"CampaignUploadPayloadCsv","data":{"type":"string","description":"Campaigns data in CSV format.","example":"campaign_id;campaign_name;start_date;end_date\n6344;February 2016;2016-02-01;2016-02-29\n"}},"components/schemas/CampaignProductUploadPayloadJson":{"id":"components/schemas/CampaignProductUploadPayloadJson","kind":"json-schema","title":"CampaignProductUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/CampaignProduct"},{"type":"array","items":{"type":"object","properties":{"campaign_id":{"type":"string","description":"Campaign ID","example":"6453"},"category_id":{"type":"string","description":"Associated Category ID","example":"My category ID"},"product_id":{"type":"string","description":"Associated Product ID","example":"My product ID"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["campaign_id","product_id"],"additionalProperties":false,"example":{"campaign_id":"6453","category_id":"My category ID","product_id":"My product ID","source_system":"ABCDEF"}},"example":[{"campaign_id":"6453","category_id":"My category ID","product_id":"My product ID","source_system":"ABCDEF"}]}]}},"components/schemas/CampaignProductUploadPayloadCsv":{"id":"components/schemas/CampaignProductUploadPayloadCsv","kind":"json-schema","title":"CampaignProductUploadPayloadCsv","data":{"type":"string","description":"Campaign products data in CSV format.","example":"campaign_id;category_id;product_id\nMy campaign ID;My category ID;My product ID\n"}},"components/schemas/SalesCampaignUploadPayloadJson":{"id":"components/schemas/SalesCampaignUploadPayloadJson","kind":"json-schema","title":"SalesCampaignUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/SalesCampaign"},{"type":"array","items":{"type":"object","properties":{"transaction_id":{"type":"string","description":"ID for transaction this campaign attaches to","example":"T1234"},"line_item_id":{"type":"string","description":"Line ID in a transaction this campaign attaches to","example":"1"},"campaign_id":{"type":"string","description":"Campaign ID","example":"6344"},"campaign_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Type (origin) of campaign record ('sales', 'salesorder', 'salesoffer')"},"children":[]}]}]}],"example":"sales"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["transaction_id","line_item_id","campaign_id"],"additionalProperties":false,"example":{"transaction_id":"T1234","line_item_id":"1","campaign_id":"6344","campaign_type":"sales","source_system":"ABCDEF"}},"example":[{"transaction_id":"T1234","line_item_id":"1","campaign_id":"6344","campaign_type":"sales","source_system":"ABCDEF"}]}]}},"components/schemas/SalesCampaignUploadPayloadCsv":{"id":"components/schemas/SalesCampaignUploadPayloadCsv","kind":"json-schema","title":"SalesCampaignUploadPayloadCsv","data":{"type":"string","description":"Campaign Sales data in CSV format.","example":"transaction_id;line_item_id;campaign_id;campaign_type\nT6344;1;1233;sales\n"}},"components/schemas/CurrencyRateUploadPayloadJson":{"id":"components/schemas/CurrencyRateUploadPayloadJson","kind":"json-schema","title":"CurrencyRateUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/CurrencyRate"},{"type":"array","items":{"type":"object","properties":{"source_currency":{"type":"string","description":"Source currency as ISO 4217 currency code.","example":"EUR"},"target_currency":{"type":"string","description":"Target currency as ISO 4217 currency code.","example":"GBP"},"valid_from":{"type":"string","description":"First day when the exchange rate is valid","example":"2017-01-01"},"valid_to":{"type":"string","description":"Last day when the exchange rate is valid","example":"2017-12-31"},"rate":{"type":"number","description":"Exchange rate to from source to target currency","example":0.89},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["source_currency","target_currency","valid_from","valid_to","rate"],"additionalProperties":false,"example":{"source_currency":"EUR","target_currency":"GBP","valid_from":"2017-01-01","valid_to":"2017-12-31","rate":0.89,"source_system":"ABCDEF"}},"example":[{"source_currency":"EUR","target_currency":"GBP","valid_from":"2017-01-01","valid_to":"2017-12-31","rate":0.89,"source_system":"ABCDEF"}]}]}},"components/schemas/CurrencyRateUploadPayloadCsv":{"id":"components/schemas/CurrencyRateUploadPayloadCsv","kind":"json-schema","title":"CurrencyRateUploadPayloadCsv","data":{"type":"string","description":"Currency rates data in CSV format.","example":"source_currency;target_currency;valid_from;valid_to;rate\nEUR;GBP;2017-01-01;2017-12-31;0.89\n"}},"components/schemas/WorkshiftUploadPayloadJson":{"id":"components/schemas/WorkshiftUploadPayloadJson","kind":"json-schema","title":"WorkshiftUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Workshift"},{"type":"array","items":{"type":"object","properties":{"shift_id":{"type":"string","description":"Unique identifier for the workshift","example":"123"},"organisation_id":{"type":"string","description":"Organisation unit where shift will take place","example":"234"},"salesperson_id":{"type":"string","description":"Identifier of sales person / employee working. Required for punched shifts","example":"345"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"scheduled":{"type":"boolean","description":"Whether this is scheduled or punched shift, default is false","example":false},"productive":{"type":"boolean","description":"Whether this is productive or administrative work, default is true","example":true},"active_work_time":{"type":"boolean","description":"Whether this shift is calculated in active work time, default is true","example":true},"start_date":{"type":"string","description":"Shift date (yyyy-mm-dd)","example":"2016-01-01"},"start_time":{"type":"string","description":"Shift starting time (HH:mm:ss)","example":"15:00:00"},"shift_type":{"type":"string","description":"Type of the shift. Freeform, will be available as dimension in portal.","example":"Chef"},"salary_type":{"type":"string","description":"Type of compensation for the shift.","example":"Evening compensation"},"staff_cost":{"type":"number","description":"Cost associated with this shift","example":500},"duration":{"type":"number","description":"Duration of the shift in hours.","example":8.15},"breaks_duration":{"type":"number","description":"Total hours of breaks during this shift","example":0.5},"breaks_cost":{"type":"number","description":"Total salary cost associated for paid breaks during this shift","example":40},"overtime_duration":{"type":"number","description":"Total overtime hours during this shift","example":2},"overtime_cost":{"type":"number","description":"Total salary cost associated for overtime hours","example":120},"absence_code":{"type":"string","description":"Code for the absense if this entry describes absence.","example":"BREAK"},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["shift_id","organisation_id","start_date","start_time"],"oneOf":[{"properties":{"duration":{"type":"number","description":"Duration of the shift in hours.","example":8.15}},"required":["duration"]},{"properties":{"end_date":{"type":"string","description":"Shift ending date (yyyy-mm-dd)","example":"2025-01-01"},"end_time":{"type":"string","description":"Shift ending time (HH:mm:ss)","example":"2017-03-31"}},"required":["end_date","end_time"]}],"additionalProperties":false,"example":{"shift_id":"123","organisation_id":"234","salesperson_id":"345","department_id":"5401","scheduled":false,"productive":true,"active_work_time":true,"start_date":"2016-01-01","start_time":"15:00:00","duration":8.15,"shift_type":"Chef","salary_type":"Evening compensation","staff_cost":500,"breaks_duration":0.5,"breaks_cost":40,"overtime_duration":2,"overtime_cost":120,"absence_code":"BREAK","currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"shift_id":"123","organisation_id":"234","salesperson_id":"345","department_id":"5401","scheduled":false,"productive":true,"active_work_time":true,"start_date":"2016-01-01","start_time":"15:00:00","duration":8.15,"shift_type":"Chef","salary_type":"Evening compensation","staff_cost":500,"breaks_duration":0.5,"breaks_cost":40,"overtime_duration":2,"overtime_cost":120,"absence_code":"BREAK","currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/WorkshiftUploadPayloadCsv":{"id":"components/schemas/WorkshiftUploadPayloadCsv","kind":"json-schema","title":"WorkshiftUploadPayloadCsv","data":{"type":"string","description":"Work shifts data in CSV format.","example":"shift_id;organisation_id;salesperson_id;start_date;time;duration;\n123;234;345;2016-01-01;\"15:00:00\";8\n"}},"components/schemas/EmployeeHourUploadPayloadJson":{"id":"components/schemas/EmployeeHourUploadPayloadJson","kind":"json-schema","title":"EmployeeHourUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/EmployeeHour"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"54021"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"employee_type":{"type":"string","description":"Employee Type","example":"Permie"},"employeehours_id":{"type":"string","description":"Optional identifier for the entry","example":"4244"},"absence_code":{"type":"string","description":"Code for the absense if this entry describes absence.","example":"BREAK"},"date":{"type":"string","description":"Date of entry (yyyy-mm-dd)","example":"2016-01-01"},"time":{"type":"string","description":"Time of entry (HH:mm:ss)","example":"15:00:00"},"scheduled":{"type":"boolean","description":"Whether this is scheduled or punched shift, default is false","example":false},"productive":{"type":"boolean","description":"Whether this is productive or administrative work, default is true","example":true},"hours":{"type":"number","description":"Number of hours to record for this specific time","example":8},"staff_cost":{"type":"number","description":"Salary cost associated with this hour","example":500},"breaks":{"type":"number","description":"Total hours of breaks","example":0.5},"breaks_cost":{"type":"number","description":"Total salary cost associated for paid breaks","example":40},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","date","time","hours"],"additionalProperties":false,"example":{"organisation_id":"540","department_id":"54021","salesperson_id":"5402101","employee_type":"Permie","employeehours_id":"4244","absence_code":"BREAK","date":"2016-01-01","time":"15:00:00","scheduled":false,"productive":true,"hours":8,"staff_cost":500,"breaks":0.5,"breaks_cost":40,"currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}},"example":[{"organisation_id":"540","department_id":"54021","salesperson_id":"5402101","employee_type":"Permie","employeehours_id":"4244","absence_code":"BREAK","date":"2016-01-01","time":"15:00:00","scheduled":false,"productive":true,"hours":8,"staff_cost":500,"breaks":0.5,"breaks_cost":40,"currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}]}]}},"components/schemas/EmployeeHourUploadPayloadCsv":{"id":"components/schemas/EmployeeHourUploadPayloadCsv","kind":"json-schema","title":"EmployeeHourUploadPayloadCsv","data":{"type":"string","description":"Employee hour entries data in CSV format.","example":"organisation_id;date;time;hours;salesperson_id;employee_type;employeehours_id\n540;2016-01-01;15:00:00;8;5402101;Permie;4244\n"}},"components/schemas/StaffCostUploadPayloadJson":{"id":"components/schemas/StaffCostUploadPayloadJson","kind":"json-schema","title":"StaffCostUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/StaffCost"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"54021"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"start_date":{"type":"string","description":"Start date of entry (yyyy-mm-dd)","example":"2024-01-01"},"staff_cost":{"type":"number","description":"Hourly salary cost","example":15},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","start_date","staff_cost"],"additionalProperties":false,"example":{"organisation_id":"540","department_id":"54021","salesperson_id":"5402101","start_date":"2024-01-01","staff_cost":15,"currency":"EUR","source_system":"ABCDEF"}},"example":[{"organisation_id":"540","department_id":"54021","salesperson_id":"5402101","start_date":"2024-01-01","staff_cost":15,"currency":"EUR","source_system":"ABCDEF"}]}]}},"components/schemas/StaffCostUploadPayloadCsv":{"id":"components/schemas/StaffCostUploadPayloadCsv","kind":"json-schema","title":"StaffCostUploadPayloadCsv","data":{"type":"string","description":"Hourly staff costs data in CSV format.","example":"organisation_id;start_date;staff_cost;currency\n540;2024-01-01;12.50;EUR\n"}},"components/schemas/InventorySnapshotUploadPayloadJson":{"id":"components/schemas/InventorySnapshotUploadPayloadJson","kind":"json-schema","title":"InventorySnapshotUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/InventorySnapshot"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"snapshot_date":{"type":"string","description":"Date of snapshot (yyyy-mm-dd)","example":"2016-01-01"},"snapshot_time":{"type":"string","description":"Time of snapshot (HH:mm:ss). Needed if inter-day inventory saldos are tracked.","example":"15:00:00"},"product_id":{"type":"string","description":"Product ID","example":"My product ID"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"quantity":{"type":"number","description":"On hand quantity in inventory","example":100},"available_quantity":{"type":"number","description":"Available quantity in inventory (after pending/reserved orders)","example":90},"reorder_point":{"type":"number","description":"Quantity threshold for this item to order more into inventory","example":5},"max_reorder_quantity":{"type":"number","description":"Max quantity threshold for this item after reordering","example":10},"unit_purchase_price":{"type":"number","description":"Unit purchase price","example":12.4},"unit_purchase_price_wo_vat":{"type":"number","description":"Unit purchase price without tax","example":10},"unit_sales_price":{"type":"number","description":"Unit sales price","example":22.4},"unit_sales_price_wo_vat":{"type":"number","description":"Unit sales price without tax","example":20},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","snapshot_date","product_id","quantity"],"additionalProperties":false,"example":{"organisation_id":"540","snapshot_date":"2016-01-01","snapshot_time":"15:00:00","product_id":"My product ID","supplier_id":"221","quantity":100,"available_quantity":90,"reorder_point":5,"max_reorder_quantity":10,"unit_purchase_price":12.4,"unit_purchase_price_wo_vat":10,"unit_sales_price":22.4,"unit_sales_price_wo_vat":20,"currency":"EUR","source_system":"ABCDEF"}},"example":[{"organisation_id":"540","snapshot_date":"2016-01-01","snapshot_time":"15:00:00","product_id":"My product ID","supplier_id":"221","quantity":100,"available_quantity":90,"reorder_point":5,"max_reorder_quantity":10,"unit_purchase_price":12.4,"unit_purchase_price_wo_vat":10,"unit_sales_price":22.4,"unit_sales_price_wo_vat":20,"currency":"EUR","source_system":"ABCDEF"}]}]}},"components/schemas/InventorySnapshotUploadPayloadCsv":{"id":"components/schemas/InventorySnapshotUploadPayloadCsv","kind":"json-schema","title":"InventorySnapshotUploadPayloadCsv","data":{"type":"string","description":"Inventory snapshots data in CSV format.","example":"organisation_id;snapshot_date;snapshot_time;product_id;quantity;unit_purchase_price;unit_purchase_price_wo_vat;currency\n540;2016-01-01;10:00:00;My product ID;100;12.40;10.00;EUR\n"}},"components/schemas/InventoryTransactionUploadPayloadJson":{"id":"components/schemas/InventoryTransactionUploadPayloadJson","kind":"json-schema","title":"InventoryTransactionUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/InventoryTransaction"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"54011"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5401"},"operator_id":{"type":"string","description":"Operator ID","example":"5402"},"movement_date":{"type":"string","description":"Date of transaction (yyyy-mm-dd)","example":"2016-02-01"},"movement_time":{"type":"string","description":"Time of transaction (HH:mm:ss).","example":"15:00:00"},"delivered_date":{"type":"string","description":"Date of transaction completion (yyyy-mm-dd)","example":"2016-02-02"},"delivered_time":{"type":"string","description":"Time of transaction completion (HH:mm:ss).","example":"15:00:00"},"product_id":{"type":"string","description":"1 (string, required) - Product ID","example":"123"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"quantity":{"type":"number","description":"Quantity moved from/to inventory","example":100},"delivered_quantity":{"type":"number","description":"Final quantity moved from/to inventory after completion.","example":90},"expected_quantity":{"type":"number","description":"Quantity expected in inventory (for stock takes).","example":110},"movement_type":{"type":"string","description":"Movement type","enum":["purchase","waste","transfer","stock_take","adjustment","sale","internal"],"x-enumDescriptions":{"purchase":"Products have been purchased to inventory","waste":"Products have been removed from inventory as waste","transfer":"Products have been transferred to another inventory location","stock_take":"Stock take has been done to correct inventory counts","adjustment":"Adjustments have been done to individual products to correct inventory counts","sale":"Products have been sold from inventory","internal":"Products have been used internally from inventory"},"example":"waste"},"movement_status":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Movement status. 1=Open, 2=Complete, 3=Complete with variances, 4=Cancelled"},"children":[]}]}]}],"example":2},"movement_batch_id":{"type":"string","description":"Optional identifier for batch this movement row is part of.","example":"june-stock-take"},"movement_batch_line_id":{"type":"string","description":"Optional line id within the batch this movement row is part of.","example":"1"},"unit_purchase_price":{"type":"number","description":"Unit purchase price","example":12.4},"unit_purchase_price_wo_vat":{"type":"number","description":"Unit purchase price without tax","example":10},"unit_retail_price":{"type":"number","description":"Unit retail (sales) price","example":12.4},"unit_retail_price_wo_vat":{"type":"number","description":"Unit retail (sales) price without tax","example":10},"reason_code":{"type":"string","description":"Optional reason code or description for this transaction","example":"Theft"},"target_organisation_id":{"type":"string","description":"Organisation / Store ID for target of inventory transfer. Mandatory for type transfer.","example":"510"},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"purchase_order_id":{"type":"string","description":"Order id for purchase order this purchase movement originates from.","example":"1234"},"purchase_order_line_id":{"type":"string","description":"Order line item id in purchase order this purchase movement line item originates from.","example":"1"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_field_6":{"type":"string","description":"Custom field 6","example":"EU only"},"custom_field_7":{"type":"string","description":"Custom field 7","example":"EU only"},"custom_field_8":{"type":"string","description":"Custom field 8","example":"EU only"},"custom_field_9":{"type":"string","description":"Custom field 9","example":"EU only"},"custom_field_10":{"type":"string","description":"Custom field 10","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","movement_date","product_id","quantity","movement_type"],"additionalProperties":false,"example":{"organisation_id":"540","department_id":"54011","salesperson_id":"5401","operator_id":"5402","movement_date":"2016-02-01","movement_time":"15:00:00","delivered_date":"2016-02-02","delivered_time":"15:00:00","product_id":"123","supplier_id":"221","parent_product_id":"123","quantity":100,"delivered_quantity":90,"expected_quantity":110,"movement_type":"waste","movement_status":2,"movement_batch_id":"june-stock-take","movement_batch_line_id":"1","unit_purchase_price":12.4,"unit_purchase_price_wo_vat":10,"unit_retail_price":12.4,"unit_retail_price_wo_vat":10,"reason_code":"Theft","target_organisation_id":"510","currency":"EUR","purchase_order_id":"1234","purchase_order_line_id":"1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"organisation_id":"540","department_id":"54011","salesperson_id":"5401","operator_id":"5402","movement_date":"2016-02-01","movement_time":"15:00:00","delivered_date":"2016-02-02","delivered_time":"15:00:00","product_id":"123","supplier_id":"221","parent_product_id":"123","quantity":100,"delivered_quantity":90,"expected_quantity":110,"movement_type":"waste","movement_status":2,"movement_batch_id":"june-stock-take","movement_batch_line_id":"1","unit_purchase_price":12.4,"unit_purchase_price_wo_vat":10,"unit_retail_price":12.4,"unit_retail_price_wo_vat":10,"reason_code":"Theft","target_organisation_id":"510","currency":"EUR","purchase_order_id":"1234","purchase_order_line_id":"1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/InventoryTransactionUploadPayloadCsv":{"id":"components/schemas/InventoryTransactionUploadPayloadCsv","kind":"json-schema","title":"InventoryTransactionUploadPayloadCsv","data":{"type":"string","description":"Inventory transactions data in CSV format.","example":"organisation_id;movement_date;movement_time;movement_type;product_id;quantity;unit_purchase_price;unit_purchase_price_wo_vat;currency\n540;2016-01-01;10:00:00;waste;My product ID;100;12.40;10.00;EUR\n"}},"components/schemas/CapacityUploadPayloadJson":{"id":"components/schemas/CapacityUploadPayloadJson","kind":"json-schema","title":"CapacityUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Capacity"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation ID","example":"540"},"product_id":{"type":"string","description":"A (string, required) - Product ID","example":"123"},"event_id":{"type":"string","description":"Event ID","example":"221"},"capacity_date":{"type":"string","description":"Date of capacity (yyyy-mm-dd)","example":"2020-02-01"},"capacity_time":{"type":"string","description":"Time of capacity (HH:mm:ss).","example":"15:00:00"},"capacity_type":{"type":"string","description":"Capacity type. Must be either event, ticket or room.","example":"event"},"max_capacity":{"type":"number","description":"Maximum available capacity for this item.","example":100},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","product_id","capacity_date","capacity_type","max_capacity"],"additionalProperties":false,"example":{"organisation_id":"540","product_id":"123","event_id":"221","capacity_date":"2020-02-01","capacity_time":"15:00:00","capacity_type":"event","max_capacity":100,"source_system":"ABCDEF"}},"example":[{"organisation_id":"540","product_id":"123","event_id":"221","capacity_date":"2020-02-01","capacity_time":"15:00:00","capacity_type":"event","max_capacity":100,"source_system":"ABCDEF"}]}]}},"components/schemas/CapacityUploadPayloadCsv":{"id":"components/schemas/CapacityUploadPayloadCsv","kind":"json-schema","title":"CapacityUploadPayloadCsv","data":{"type":"string","description":"Capacity data in CSV format.","example":"organisation_id;capacity_date;capacity_time;product_id;event_id;max_capacity\n540;2021-02-01;10:00:00;123-X;567;100\n"}},"components/schemas/FlatHierarchyUploadPayloadJson":{"id":"components/schemas/FlatHierarchyUploadPayloadJson","kind":"json-schema","title":"FlatHierarchyUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/FlatHierarchy"},{"type":"array","items":{"type":"object","properties":{"hierarchy_key":{"type":"string","enum":["product","model","product_group","organisation","customer","channel","area","account"],"description":"Type of hierarchy that is uploaded","example":"product"},"entity_id":{"type":"string","description":"Identifier for the lowest level entity in the hierarchy","example":"XYZ"},"level1":{"type":"string","description":"Name of root category level","example":"Clothing"},"level2":{"type":"string","description":"Name of category level 2","example":"Children's clothing"},"level3":{"type":"string","description":"Name of category level 3","example":"Children's outdoor clothing"},"level4":{"type":"string","description":"Name of category level 4","example":"Children's outdoor headwear"},"level5":{"type":"string","description":"Name of category level 5","example":"Children's caps"},"level6":{"type":"string","description":"Name of category level 6","example":"Children's small caps"},"level7":{"type":"string","description":"Name of category level 7","example":"Children's themed caps"},"level8":{"type":"string","description":"Name of category level 8","example":"Children's disney caps"},"level9":{"type":"string","description":"Name of category level 9","example":"Children's mickey caps"},"level10":{"type":"string","description":"Name of category level 10","example":"Children's ..."},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["hierarchy_key","entity_id","level1"],"additionalProperties":false,"example":{"hierarchy_key":"product","entity_id":"XYZ","level1":"Clothing","level2":"Children's clothing","level3":"Children's outdoor clothing","level4":"Children's outdoor headwear","level5":"Children's caps","level6":"Children's small caps","level7":"Children's themed caps","level8":"Children's disney caps","level9":"Children's mickey caps","level10":"Children's ...","source_system":"ABCDEF"}},"example":[{"hierarchy_key":"product","entity_id":"XYZ","level1":"Clothing","level2":"Children's clothing","level3":"Children's outdoor clothing","level4":"Children's outdoor headwear","level5":"Children's caps","level6":"Children's small caps","level7":"Children's themed caps","level8":"Children's disney caps","level9":"Children's mickey caps","level10":"Children's ...","source_system":"ABCDEF"}]}]}},"components/schemas/FlatHierarchyUploadPayloadCsv":{"id":"components/schemas/FlatHierarchyUploadPayloadCsv","kind":"json-schema","title":"FlatHierarchyUploadPayloadCsv","data":{"type":"string","description":"Flat hierarchies data in CSV format.","example":"hierarchy_key;entity_id;level1;level2;level3;level4;level5\nproduct;XYZ;Clothing;Children's clothing;Children's outdoor clothing;Children's outdoor headwear;Children's caps\n"}},"components/schemas/CategoryUploadPayloadJson":{"id":"components/schemas/CategoryUploadPayloadJson","kind":"json-schema","title":"CategoryUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Category"},{"type":"array","items":{"type":"object","properties":{"category_id":{"type":"string","description":"Category ID","example":"23"},"category_name":{"type":"string","description":"Category Name","example":"Men's clothing"},"parent_id":{"type":"string","description":"ID of the parent category, 0 for top level category","example":"0"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["category_id","category_name"],"additionalProperties":false,"example":{"category_id":"23","category_name":"Men's clothing","parent_id":"0","source_system":"ABCDEF"}},"example":[{"category_id":"23","category_name":"Men's clothing","parent_id":"0","source_system":"ABCDEF"}]}]}},"components/schemas/CategoryUploadPayloadCsv":{"id":"components/schemas/CategoryUploadPayloadCsv","kind":"json-schema","title":"CategoryUploadPayloadCsv","data":{"type":"string","description":"Product hierarchies data in CSV format.","example":"category_id;category_name;parent_id\n23;Men's clothing;0\n"}},"components/schemas/RebateCodeUploadPayloadJson":{"id":"components/schemas/RebateCodeUploadPayloadJson","kind":"json-schema","title":"RebateCodeUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/RebateCode"},{"type":"array","items":{"type":"object","properties":{"rebate_code_id":{"type":"string","description":"Rebate Code ID","example":"3313V"},"rebate_code_name":{"type":"string","description":"Description of the reason","example":"Model product"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["rebate_code_id","rebate_code_name"],"additionalProperties":false,"example":{"rebate_code_id":"3313V","rebate_code_name":"Model product","source_system":"ABCDEF"}},"example":[{"rebate_code_id":"3313V","rebate_code_name":"Model product","source_system":"ABCDEF"}]}]}},"components/schemas/RebateCodeUploadPayloadCsv":{"id":"components/schemas/RebateCodeUploadPayloadCsv","kind":"json-schema","title":"RebateCodeUploadPayloadCsv","data":{"type":"string","description":"Rebate codes data in CSV format.","example":"rebate_code_id;rebate_code_name\n3313V; Model product\n"}},"components/schemas/PaymentTypeUploadPayloadJson":{"id":"components/schemas/PaymentTypeUploadPayloadJson","kind":"json-schema","title":"PaymentTypeUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/PaymentType"},{"type":"array","items":{"type":"object","properties":{"payment_type_id":{"type":"string","description":"Payment Type ID","example":"1"},"payment_type":{"type":"string","description":"Payment type name","example":"credit card"},"payment_group":{"type":"string","description":"Payment group","example":"Store"},"custom_field_1":{"type":"string","description":"Custom Field 1","example":"App"},"custom_field_2":{"type":"string","description":"Custom Field 2","example":"App"},"custom_field_3":{"type":"string","description":"Custom Field 3","example":"App"},"custom_field_4":{"type":"string","description":"Custom Field 4","example":"App"},"custom_field_5":{"type":"string","description":"Custom Field 5","example":"App"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["payment_type_id","payment_type"],"additionalProperties":false,"example":{"payment_type_id":"1","payment_type":"credit card","payment_group":"Store","custom_field_1":"App","custom_field_2":"App","custom_field_3":"App","custom_field_4":"App","custom_field_5":"App","source_system":"ABCDEF"}},"example":[{"payment_type_id":"1","payment_type":"credit card","payment_group":"Store","custom_field_1":"App","custom_field_2":"App","custom_field_3":"App","custom_field_4":"App","custom_field_5":"App","source_system":"ABCDEF"}]}]}},"components/schemas/PaymentTypeUploadPayloadCsv":{"id":"components/schemas/PaymentTypeUploadPayloadCsv","kind":"json-schema","title":"PaymentTypeUploadPayloadCsv","data":{"type":"string","description":"Payment types data in CSV format.","example":"payment_type_id;payment_type_name\nAPP; App payment\n"}},"components/schemas/PurchaseOrdersUploadPayloadJson":{"id":"components/schemas/PurchaseOrdersUploadPayloadJson","kind":"json-schema","title":"PurchaseOrdersUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/PurchaseOrders"},{"type":"array","items":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"er/232/f31"},"line_item_id":{"type":"string","description":"Secondary transaction identifier","example":"1"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"54011"},"purchaser_id":{"type":"string","description":"Purchaser ID","example":"5400"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"order_date":{"type":"string","description":"Order date (yyyy-mm-dd)","example":"2016-01-01"},"order_time":{"type":"string","description":"Order time (HH:mm:ss)","example":"15:00:00"},"ordered_quantity":{"type":"number","description":"order quantity","example":2},"delivery_date":{"type":"string","description":"Delivery date (yyyy-mm-dd)","example":"2016-01-01"},"delivery_time":{"type":"string","description":"Delivery time (HH:mm:ss)","example":"15:00:00"},"delivered_quantity":{"type":"number","description":"quantity that is delivered","example":2},"arrival_date":{"type":"string","description":"Arrival date (yyyy-mm-dd)","example":"2016-01-03"},"arrival_time":{"type":"string","description":"Arrival time (HH:mm:ss)","example":"15:00:00"},"order_status":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}],"example":1},"order_type":{"type":"string","description":"Order Type","example":"Express"},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":5},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":4},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"retail_value":{"type":"number","description":"Total retail (sales) value including tax","example":10},"retail_value_wo_vat":{"type":"number","description":"Total retail (sales) value without tax","example":8},"purchase_currency":{"type":"string","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"sales_unit":{"type":"string","description":"Sales unit","example":"KPL"},"cancelled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. true=cancelled transaction false=not cancelled transaction"},"children":[]}]}]}],"example":false},"cancel_id":{"type":"string","description":"Transaction ID of cancelled receipt","example":"er/232/f2"},"gross_weight":{"type":"number","description":"Gross weight of ordered products.","example":0},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_field_6":{"type":"string","description":"Custom field 6","example":"EU only"},"custom_field_7":{"type":"string","description":"Custom field 7","example":"EU only"},"custom_field_8":{"type":"string","description":"Custom field 8","example":"EU only"},"custom_field_9":{"type":"string","description":"Custom field 9","example":"EU only"},"custom_field_10":{"type":"string","description":"Custom field 10","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["transaction_id","line_item_id","product_id","organisation_id","order_date","order_time","ordered_quantity","order_status","cancelled"],"additionalProperties":false,"example":{"transaction_id":"er/232/f31","line_item_id":"1","product_id":"XYZ","organisation_id":"540","department_id":"54011","purchaser_id":"5400","supplier_id":"221","parent_product_id":"123","order_date":"2016-01-01","order_time":"15:00:00","ordered_quantity":2,"delivery_date":"2016-01-01","delivery_time":"15:00:00","delivered_quantity":2,"arrival_date":"2016-01-03","arrival_time":"15:00:00","order_status":1,"order_type":"Express","purchase_price":5,"purchase_price_wo_vat":4,"rebate":0,"rebate_wo_vat":0,"retail_value":10,"retail_value_wo_vat":8,"purchase_currency":"EUR","sales_unit":"KPL","cancelled":false,"cancel_id":"er/232/f2","gross_weight":0,"custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"transaction_id":"er/232/f31","line_item_id":"1","product_id":"XYZ","organisation_id":"540","department_id":"54011","purchaser_id":"5400","supplier_id":"221","parent_product_id":"123","order_date":"2016-01-01","order_time":"15:00:00","ordered_quantity":2,"delivery_date":"2016-01-01","delivery_time":"15:00:00","delivered_quantity":2,"arrival_date":"2016-01-03","arrival_time":"15:00:00","order_status":1,"order_type":"Express","purchase_price":5,"purchase_price_wo_vat":4,"rebate":0,"rebate_wo_vat":0,"retail_value":10,"retail_value_wo_vat":8,"purchase_currency":"EUR","sales_unit":"KPL","cancelled":false,"cancel_id":"er/232/f2","gross_weight":0,"custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/PurchaseOrdersUploadPayloadCsv":{"id":"components/schemas/PurchaseOrdersUploadPayloadCsv","kind":"json-schema","title":"PurchaseOrdersUploadPayloadCsv","data":{"type":"string","description":"Purchase orders data in CSV format.","example":"transaction_id,line_item_id,product_id,organisation_id,supplier_id,order_date,order_time,ordered_quantity,delivery_date,delivery_time,delivered_quantity,order_status,purchase_price,purchase_price_wo_vat,purchase_currency,sales_unit,cancelled,cancel_id,gross_weight,custom_field_1,custom_field_2,custom_field_3,custom_field_4,custom_field_5\ner/232/f31; 1; 123; 1000; 12S; 2018-03-19; 15:00:00; 100; 2018-03-20; 15:00:00; 100.0000; 1; 1000.0000; 930.0000; EUR';; 0;; 120.0000; c1; c2; c3; c4; c5;\n"}},"components/schemas/SalesOffersUploadPayloadJson":{"id":"components/schemas/SalesOffersUploadPayloadJson","kind":"json-schema","title":"SalesOffersUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/SalesOffers"},{"type":"array","items":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"er/232/f31"},"line_item_id":{"type":"string","description":"Secondary transaction identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"product_quantity":{"type":"number","description":"Sold quantity","example":2},"product_unit_price":{"type":"number","description":"Unit price for single product","example":10},"sales_value":{"type":"number","description":"Total sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":20},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"sales_currency":{"type":"string","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"payment_method":{"type":"string","description":"Payment method","example":"Invoice 30"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":5},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":5},"purchase_currency":{"type":"string","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"offer_date":{"type":"string","description":"Offer date (yyyy-mm-dd)","example":"2016-01-01"},"offer_time":{"type":"string","description":"Offer time (HH:mm:ss)","example":"15:00:00"},"valid_date":{"type":"string","description":"Offer validity date (yyyy-mm-dd)","example":"2016-01-01"},"valid_time":{"type":"string","description":"Offer validity time (HH:mm:ss)","example":"15:00:00"},"offer_status":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offer status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}],"example":1},"offer_type":{"type":"string","description":"Offer type.","example":"wholesale"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_field_6":{"type":"string","description":"Custom field 6","example":"EU only"},"custom_field_7":{"type":"string","description":"Custom field 7","example":"EU only"},"custom_field_8":{"type":"string","description":"Custom field 8","example":"EU only"},"custom_field_9":{"type":"string","description":"Custom field 9","example":"EU only"},"custom_field_10":{"type":"string","description":"Custom field 10","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["transaction_id","line_item_id","product_id","product_quantity","product_unit_price","sales_value","offer_date","offer_time","offer_status"],"additionalProperties":false,"example":{"transaction_id":"er/232/f31","line_item_id":"1","customer_id":"32","product_id":"XYZ","product_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"rebate":0,"rebate_wo_vat":0,"sales_currency":"EUR","payment_method":"Invoice 30","supplier_id":"221","parent_product_id":"123","purchase_price":5,"purchase_price_wo_vat":5,"purchase_currency":"EUR","organisation_id":"540","salesperson_id":"5402101","offer_date":"2016-01-01","offer_time":"15:00:00","valid_date":"2016-01-01","valid_time":"15:00:00","offer_status":1,"offer_type":"wholesale","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"transaction_id":"er/232/f31","line_item_id":"1","customer_id":"32","product_id":"XYZ","product_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"rebate":0,"rebate_wo_vat":0,"sales_currency":"EUR","payment_method":"Invoice 30","supplier_id":"221","parent_product_id":"123","purchase_price":5,"purchase_price_wo_vat":5,"purchase_currency":"EUR","organisation_id":"540","salesperson_id":"5402101","offer_date":"2016-01-01","offer_time":"15:00:00","valid_date":"2016-01-01","valid_time":"15:00:00","offer_status":1,"offer_type":"wholesale","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/SalesOffersUploadPayloadCsv":{"id":"components/schemas/SalesOffersUploadPayloadCsv","kind":"json-schema","title":"SalesOffersUploadPayloadCsv","data":{"type":"string","description":"Sales offers data in CSV format.","example":"transaction_id;line_item_id;customer_id;product_id;product_quantity;product_unit_price;sales_value;sales_value_wo_vat;rebate;rebate_wo_vat;sales_currency;payment_method;supplier_id;purchase_price;purchase_price_wo_vat;purchase_currency;organisation_id;salesperson_id;offer_date;offer_time;valid_date;valid_time;offer_status\ner/232/f31; 1; 32; XYZ; 2; 10; 20; 20; 0; 0; EUR; Invoice 30; ; 5; 5; EUR; 540; 5402101; 2016-01-01; 15:00:00; 2016-01-01; 15:00:00;\n"}},"components/schemas/SalesOrdersUploadPayloadJson":{"id":"components/schemas/SalesOrdersUploadPayloadJson","kind":"json-schema","title":"SalesOrdersUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/SalesOrders"},{"type":"array","items":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"er/232/f31"},"line_item_id":{"type":"string","description":"Secondary transaction identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"delivery_customer_id":{"type":"string","description":"Delivery Customer ID for identified customer","example":"32"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"product_quantity":{"type":"number","description":"Sold quantity","example":2},"delivered_quantity":{"type":"number","description":"Delivered quantity","example":1},"planned_quantity":{"type":"number","description":"Planned quantity","example":2},"product_unit_price":{"type":"number","description":"Unit price for single product","example":10},"sales_value":{"type":"number","description":"Total sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":20},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"rebate_code_id":{"type":"string","description":"Rebate Code ID","example":"3313V"},"sales_currency":{"type":"string","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"payment_method":{"type":"string","description":"Payment method","example":"Invoice 30"},"tender_amount":{"type":"number","description":"Amount paid with tender in 'payment method'.","example":20},"deposit_amount":{"type":"number","description":"Amount of deposit paid for this order item.","example":10},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":5},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":5},"purchase_currency":{"type":"string","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"54011"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"cancel_id":{"type":"string","description":"Transaction ID of cancelled receipt","example":"er/232/f2"},"delivery_date":{"type":"string","description":"Delivery date (yyyy-mm-dd)","example":"2016-01-01"},"delivery_time":{"type":"string","description":"Delivery time (HH:mm:ss)","example":"15:00:00"},"order_date":{"type":"string","description":"Order date (yyyy-mm-dd)","example":"2016-01-01"},"order_time":{"type":"string","description":"Order time (HH:mm:ss)","example":"15:00:00"},"invoice_date":{"type":"string","description":"Invoice date (yyyy-mm-dd)","example":"2016-01-01"},"invoice_time":{"type":"string","description":"Invoice time (HH:mm:ss)","example":"15:00:00"},"arrival_date":{"type":"string","description":"Arrival date (yyyy-mm-dd)","example":"2016-01-03"},"arrival_time":{"type":"string","description":"Arrival time (HH:mm:ss)","example":"15:00:00"},"order_status":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}],"example":1},"order_type":{"type":"string","description":"Order type.","example":"Wholesale"},"customer_order_number":{"type":"string","description":"Customer internal order ID","example":"1234-5"},"sales_offer_id":{"type":"string","description":"ID that refers to respective sales offer if applicable","example":"1234"},"sales_offer_line_id":{"type":"string","description":"ID that refers to respective sales offer line if applicable","example":"1"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_field_6":{"type":"string","description":"Custom field 6","example":"EU only"},"custom_field_7":{"type":"string","description":"Custom field 7","example":"EU only"},"custom_field_8":{"type":"string","description":"Custom field 8","example":"EU only"},"custom_field_9":{"type":"string","description":"Custom field 9","example":"EU only"},"custom_field_10":{"type":"string","description":"Custom field 10","example":"EU only"},"custom_field_11":{"type":"string","description":"Custom field 11","example":"EU only"},"custom_field_12":{"type":"string","description":"Custom field 12","example":"EU only"},"custom_field_13":{"type":"string","description":"Custom field 13","example":"EU only"},"custom_field_14":{"type":"string","description":"Custom field 14","example":"EU only"},"custom_field_15":{"type":"string","description":"Custom field 15","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["transaction_id","line_item_id","product_id","product_quantity","product_unit_price","sales_value","order_date","order_time","order_status"],"additionalProperties":false,"example":{"transaction_id":"er/232/f31","line_item_id":"1","customer_id":"32","delivery_customer_id":"32","product_id":"XYZ","product_quantity":2,"delivered_quantity":1,"planned_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"rebate":0,"rebate_wo_vat":0,"rebate_code_id":"3313V","sales_currency":"EUR","payment_method":"Invoice 30","tender_amount":20,"deposit_amount":10,"supplier_id":"221","parent_product_id":"123","purchase_price":5,"purchase_price_wo_vat":5,"purchase_currency":"EUR","organisation_id":"540","department_id":"54011","salesperson_id":"5402101","cancel_id":"er/232/f2","delivery_date":"2016-01-01","delivery_time":"15:00:00","order_date":"2016-01-01","order_time":"15:00:00","invoice_date":"2016-01-01","invoice_time":"15:00:00","arrival_date":"2016-01-03","arrival_time":"15:00:00","order_status":1,"order_type":"Wholesale","customer_order_number":"1234-5","sales_offer_id":"1234","sales_offer_line_id":"1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_field_11":"EU only","custom_field_12":"EU only","custom_field_13":"EU only","custom_field_14":"EU only","custom_field_15":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"transaction_id":"er/232/f31","line_item_id":"1","customer_id":"32","delivery_customer_id":"32","product_id":"XYZ","product_quantity":2,"delivered_quantity":1,"planned_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"rebate":0,"rebate_wo_vat":0,"rebate_code_id":"3313V","sales_currency":"EUR","payment_method":"Invoice 30","tender_amount":20,"deposit_amount":10,"supplier_id":"221","parent_product_id":"123","purchase_price":5,"purchase_price_wo_vat":5,"purchase_currency":"EUR","organisation_id":"540","department_id":"54011","salesperson_id":"5402101","cancel_id":"er/232/f2","delivery_date":"2016-01-01","delivery_time":"15:00:00","order_date":"2016-01-01","order_time":"15:00:00","invoice_date":"2016-01-01","invoice_time":"15:00:00","arrival_date":"2016-01-03","arrival_time":"15:00:00","order_status":1,"order_type":"Wholesale","customer_order_number":"1234-5","sales_offer_id":"1234","sales_offer_line_id":"1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_field_11":"EU only","custom_field_12":"EU only","custom_field_13":"EU only","custom_field_14":"EU only","custom_field_15":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/SalesOrdersUploadPayloadCsv":{"id":"components/schemas/SalesOrdersUploadPayloadCsv","kind":"json-schema","title":"SalesOrdersUploadPayloadCsv","data":{"type":"string","description":"Sales orders data in CSV format.","example":"transaction_id;line_item_id;customer_id;product_id;product_quantity;product_unit_price;sales_value;sales_value_wo_vat;rebate;rebate_wo_vat;sales_currency;payment_method;supplier_id;purchase_price;purchase_price_wo_vat;purchase_currency;piece_good;organisation_id;salesperson_id;campaign_id;cancel_id;delivery_date;delivery_time;order_date;order_time;invoice_date;invoice_time;order_status;register_id\ner/232/f31; 1; 32; XYZ; 2; 10; 20; 20; 0; 0; EUR; Invoice 30; ; 5; 5; EUR; true; 540; 5402101; 6344; ; 2016-01-01; 15:00:00; 2016-01-01; 15:00:00; 2016-01-01; 15:00:00; 1;\n"}},"components/schemas/SalesSummaryUploadPayloadJson":{"id":"components/schemas/SalesSummaryUploadPayloadJson","kind":"json-schema","title":"SalesSummaryUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/SalesSummary"},{"type":"array","items":{"type":"object","properties":{"sales_date":{"type":"string","description":"Sales date (yyyy-mm-dd)","example":"2016-01-01"},"sales_time":{"type":"string","description":"Sales time (HH:mm:ss)","example":"15:00:00"},"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"sales_value":{"type":"number","description":"Total sales amount including tax","example":2000},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":1600},"sales_currency":{"type":"string","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":500},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":400},"purchase_currency":{"type":"string","description":"Purchase currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"product_quantity":{"type":"number","description":"Sold quantity","example":4},"number_of_transactions":{"type":"number","description":"Number of receipts","example":2},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"campaign_id":{"type":"string","description":"Campaign ID","example":"123"},"rebate_code_id":{"type":"string","description":"Rebate Code ID","example":"3313V"},"cancelled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. true=cancelled transaction false=not cancelled transaction. Default is false."},"children":[]}]}]}],"example":false},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_6":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_7":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_8":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_9":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_10":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["sales_date","organisation_id"],"additionalProperties":false,"example":{"sales_date":"2016-01-01","sales_time":"15:00:00","organisation_id":"540","department_id":"5401","salesperson_id":"5402101","sales_value":2000,"sales_value_wo_vat":1600,"sales_currency":"EUR","rebate":0,"rebate_wo_vat":0,"purchase_price":500,"purchase_price_wo_vat":400,"purchase_currency":"EUR","product_quantity":4,"number_of_transactions":2,"product_id":"XYZ","customer_id":"32","supplier_id":"221","parent_product_id":"123","campaign_id":"123","rebate_code_id":"3313V","cancelled":false,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_field_6":"XYZ","custom_field_7":"XYZ","custom_field_8":"XYZ","custom_field_9":"XYZ","custom_field_10":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"sales_date":"2016-01-01","sales_time":"15:00:00","organisation_id":"540","department_id":"5401","salesperson_id":"5402101","sales_value":2000,"sales_value_wo_vat":1600,"sales_currency":"EUR","rebate":0,"rebate_wo_vat":0,"purchase_price":500,"purchase_price_wo_vat":400,"purchase_currency":"EUR","product_quantity":4,"number_of_transactions":2,"product_id":"XYZ","customer_id":"32","supplier_id":"221","parent_product_id":"123","campaign_id":"123","rebate_code_id":"3313V","cancelled":false,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_field_6":"XYZ","custom_field_7":"XYZ","custom_field_8":"XYZ","custom_field_9":"XYZ","custom_field_10":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/SalesSummaryUploadPayloadCsv":{"id":"components/schemas/SalesSummaryUploadPayloadCsv","kind":"json-schema","title":"SalesSummaryUploadPayloadCsv","data":{"type":"string","description":"Sales summary data in CSV format.","example":"sales_date; sales_time; organisation_id; department_id; salesperson_id; product_quantity; number_of_transactions; sales_value; sales_value_wo_vat; sales_currency; rebate; rebate_wo_vat; purchase_price; purchase_price_wo_vat; purchase_currency\n2016-01-01 ; 15:00:00 ; 540;5401;540001;4;2;2150.1700.0; EUR ;0;0;1000.0;750.0; EUR\n"}},"components/schemas/SalesPaymentUploadPayloadJson":{"id":"components/schemas/SalesPaymentUploadPayloadJson","kind":"json-schema","title":"SalesPaymentUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/SalesPayment"},{"type":"array","items":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction. Should match with sales receipt transaction id where applicable.","example":"er/232/f31"},"line_item_id":{"type":"string","description":"Transaction line item identifier","example":"1"},"sales_date":{"type":"string","description":"Sales date (yyyy-mm-dd)","example":"2016-01-01"},"sales_time":{"type":"string","description":"Sales time (HH:mm:ss)","example":"15:00:00"},"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"register_id":{"type":"string","description":"Cash register ID","example":"32"},"table_number":{"type":"string","description":"Table number","example":"54"},"payment_method":{"type":"string","description":"Payment method ID","example":"Invoice"},"giftcard_payment_id":{"type":"string","description":"Id to link to possible giftcard used for this payment.","example":"12345"},"sales_value":{"type":"number","description":"Total sales amount including tax","example":2000},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":1600},"currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"delivery_customer_id":{"type":"string","description":"Delivery Customer ID for identified customer","example":"32"},"cancel_id":{"type":"string","description":"Transaction ID of cancelled receipt","example":"er/232/f2"},"cancelled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. true=cancelled transaction false=not cancelled transaction. Default is false."},"children":[]}]}]}],"example":false},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_6":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_7":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_8":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_9":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_10":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"custom_metric_6":{"type":"number","description":"Custom metric 6","example":1},"custom_metric_7":{"type":"number","description":"Custom metric 7","example":100},"custom_metric_8":{"type":"number","description":"Custom metric 8","example":2.2},"custom_metric_9":{"type":"number","description":"Custom metric 9","example":1.05},"custom_metric_10":{"type":"number","description":"Custom metric 10","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["transaction_id","line_item_id","sales_date","organisation_id","payment_method"],"additionalProperties":false,"example":{"transaction_id":"er/232/f31","line_item_id":"1","sales_date":"2016-01-01","sales_time":"15:00:00","organisation_id":"540","department_id":"5401","salesperson_id":"5402101","register_id":"32","table_number":"54","payment_method":"Invoice","giftcard_payment_id":"12345","sales_value":2000,"sales_value_wo_vat":1600,"currency":"EUR","rebate":0,"rebate_wo_vat":0,"customer_id":"32","delivery_customer_id":"32","cancel_id":"er/232/f2","cancelled":false,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_field_6":"XYZ","custom_field_7":"XYZ","custom_field_8":"XYZ","custom_field_9":"XYZ","custom_field_10":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":1,"custom_metric_7":100,"custom_metric_8":2.2,"custom_metric_9":1.05,"custom_metric_10":10000,"source_system":"ABCDEF"}},"example":[{"transaction_id":"er/232/f31","line_item_id":"1","sales_date":"2016-01-01","sales_time":"15:00:00","organisation_id":"540","department_id":"5401","salesperson_id":"5402101","register_id":"32","table_number":"54","payment_method":"Invoice","giftcard_payment_id":"12345","sales_value":2000,"sales_value_wo_vat":1600,"currency":"EUR","rebate":0,"rebate_wo_vat":0,"customer_id":"32","delivery_customer_id":"32","cancel_id":"er/232/f2","cancelled":false,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_field_6":"XYZ","custom_field_7":"XYZ","custom_field_8":"XYZ","custom_field_9":"XYZ","custom_field_10":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":1,"custom_metric_7":100,"custom_metric_8":2.2,"custom_metric_9":1.05,"custom_metric_10":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/SalesPaymentUploadPayloadCsv":{"id":"components/schemas/SalesPaymentUploadPayloadCsv","kind":"json-schema","title":"SalesPaymentUploadPayloadCsv","data":{"type":"string","description":"Sales payment data in CSV format.","example":"transaction_id;line_item_id;customer_id;sales_value;sales_value_wo_vat;rebate;rebate_wo_vat;currency;payment_method;organisation_id;salesperson_id;cancel_id;sales_date;sales_time;register_id;custom_field1;custom_field2\ner/232/f31;1 ; 32; 20; 20; 0; 0; EUR; Invoice; 540; 5402101; ; 2016-01-01; 15:00:00; 1;payment 1 ; extra pay\n"}},"components/schemas/GiftcardPaymentUploadPayloadJson":{"id":"components/schemas/GiftcardPaymentUploadPayloadJson","kind":"json-schema","title":"GiftcardPaymentUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/GiftcardPayment"},{"type":"array","items":{"type":"object","properties":{"giftcard_id":{"type":"string","description":"Unique ID for the gift card.","example":"A67gigMp"},"giftcard_number":{"type":"string","description":"Gift card number","example":"7TON39"},"giftcard_status":{"type":"string","description":"Gift card status","example":"Active"},"giftcard_balance":{"type":"number","description":"Gift card balance","example":50},"creation_date":{"type":"string","description":"Gift card creation date (yyyy-mm-dd)","example":"2016-01-01"},"creation_time":{"type":"string","description":"Gift card creation time (HH:mm:ss)","example":"15:00:00"},"expiration_date":{"type":"string","description":"Gift card expiration date (yyyy-mm-dd)","example":"2017-01-01"},"expiration_time":{"type":"string","description":"Gift card expiration time (HH:mm:ss)","example":"15:00:00"},"sales_id":{"type":"string","description":"Sales Id","example":"dbeba367"},"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"register_id":{"type":"string","description":"Cash register ID","example":"32"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"payment_id":{"type":"string","description":"Payment method ID","example":"A65A"},"payment_type":{"type":"string","description":"Payment type","example":"Activation"},"payment_date":{"type":"string","description":"Payment date (yyyy-mm-dd)","example":"2016-05-15"},"payment_time":{"type":"string","description":"Payment time (HH:mm:ss)","example":"15:00:00"},"payment_value":{"type":"number","description":"Payment amount","example":20},"payment_currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["giftcard_id","giftcard_number","giftcard_status","creation_date","organisation_id","payment_id","payment_type","payment_date","payment_time","payment_value"],"additionalProperties":false,"example":{"giftcard_id":"A67gigMp","giftcard_number":"7TON39","giftcard_status":"Active","giftcard_balance":50,"creation_date":"2016-01-01","creation_time":"15:00:00","expiration_date":"2017-01-01","expiration_time":"15:00:00","sales_id":"dbeba367","organisation_id":"540","department_id":"5401","register_id":"32","salesperson_id":"5402101","customer_id":"32","payment_id":"A65A","payment_type":"Activation","payment_date":"2016-05-15","payment_time":"15:00:00","payment_value":20,"payment_currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"giftcard_id":"A67gigMp","giftcard_number":"7TON39","giftcard_status":"Active","giftcard_balance":50,"creation_date":"2016-01-01","creation_time":"15:00:00","expiration_date":"2017-01-01","expiration_time":"15:00:00","sales_id":"dbeba367","organisation_id":"540","department_id":"5401","register_id":"32","salesperson_id":"5402101","customer_id":"32","payment_id":"A65A","payment_type":"Activation","payment_date":"2016-05-15","payment_time":"15:00:00","payment_value":20,"payment_currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/GiftcardPaymentUploadPayloadCsv":{"id":"components/schemas/GiftcardPaymentUploadPayloadCsv","kind":"json-schema","title":"GiftcardPaymentUploadPayloadCsv","data":{"type":"string","description":"Giftcard Payments data in CSV format.","example":"giftcard_id; giftcard_number; giftcard_status; giftcard_balance; creation_date; organisation_id; payment_id; payment_type; payment_date; payment_time; payment_value; payment_currency; salesperson_id; source_system\nA67gigMp ; 7TON39 ; Active ; 50.00 ; 2016-01-01 ; 540 ; A65A ; Activation ; 2016-05-15 ; 18:00:00 ; 20.00; EUR ; 540001 ; XYZ\n"}},"components/schemas/AccountingUploadPayloadJson":{"id":"components/schemas/AccountingUploadPayloadJson","kind":"json-schema","title":"AccountingUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Accounting"},{"type":"array","items":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for this accounting receipt","example":"1234"},"line_item_id":{"type":"string","description":"Unique ID for this accounting receipt line item","example":"1"},"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"account_id":{"type":"string","description":"Account ID","example":"1150"},"event_date":{"type":"string","description":"Event date (yyyy-mm-dd)","example":"2016-01-01"},"event_time":{"type":"string","description":"Event time (HH:mm:ss)","example":"15:00:00"},"receipt_type":{"type":"string","enum":["income","cost","asset","liability"],"description":"Receipt type","example":"cost"},"receipt_number":{"type":"string","description":"XZY (string, optional) - Optional bookkeeping receipt number","example":"12345"},"receipt_value":{"type":"number","description":"Total amount of this line item","example":2000},"receipt_value_wo_vat":{"type":"number","description":"Total amount of this line item without taxes","example":1600},"currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"cancelled":{"type":"boolean","description":"If set then this receipt has been cancelled.","example":true},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["transaction_id","line_item_id","organisation_id","account_id","event_date","receipt_type","receipt_number"],"additionalProperties":false,"example":{"transaction_id":"1234","line_item_id":"1","organisation_id":"540","department_id":"5401","account_id":"1150","event_date":"2016-01-01","event_time":"15:00:00","receipt_type":"cost","receipt_number":"12345","receipt_value":2000,"receipt_value_wo_vat":1600,"currency":"EUR","cancelled":true,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}},"example":[{"transaction_id":"1234","line_item_id":"1","organisation_id":"540","department_id":"5401","account_id":"1150","event_date":"2016-01-01","event_time":"15:00:00","receipt_type":"cost","receipt_number":"12345","receipt_value":2000,"receipt_value_wo_vat":1600,"currency":"EUR","cancelled":true,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}]}]}},"components/schemas/AccountingUploadPayloadCsv":{"id":"components/schemas/AccountingUploadPayloadCsv","kind":"json-schema","title":"AccountingUploadPayloadCsv","data":{"type":"string","description":"Accounting data in CSV format.","example":"transaction_id;line_item_id;account_id;organisation_id;receipt_type;event_date;event_time;receipt_value;currency;custom_field1;custom_field2\n123; 1; 4567; 540; cost; 2020-01-01; 15:00:00; 100.00; EUR; payment 1; extra pay\n"}},"components/schemas/BookingUploadPayloadJson":{"id":"components/schemas/BookingUploadPayloadJson","kind":"json-schema","title":"BookingUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Booking"},{"type":"array","items":{"type":"object","properties":{"booking_id":{"type":"string","description":"Unique ID for the booking","example":"er/232/f31"},"booking_line_id":{"type":"string","description":"Secondary booking identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"event_id":{"type":"string","description":"A (string, optional) - Optional ID for the event this booking is done for.","example":"123"},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"54011"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"booked_quantity":{"type":"number","description":"Booked quantity","example":2},"number_of_guests":{"type":"number","description":"Number of guests booked","example":2},"number_of_visits":{"type":"number","description":"Number of visits allowed per guest within start and end dates.","example":2},"sales_value":{"type":"number","description":"Total booking sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total booking sales amount without tax","example":20},"currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"canceled":{"type":"boolean","description":"True when this booking has been cancelled.","example":false},"booking_date":{"type":"string","description":"Booking date (yyyy-mm-dd)","example":"2020-03-01"},"booking_time":{"type":"string","description":"Booking time (HH:mm:ss)","example":"15:00:00"},"event_start_date":{"type":"string","description":"Event start date (yyyy-mm-dd)","example":"2020-03-10"},"event_start_time":{"type":"string","description":"Event start time (HH:mm:ss)","example":"15:00:00"},"event_end_date":{"type":"string","description":"Event end date (yyyy-mm-dd)","example":"2020-03-11"},"event_end_time":{"type":"string","description":"Event end time (HH:mm:ss)","example":"15:00:00"},"booking_type":{"type":"string","description":"Booking type. Must be either event, ticket or room.","example":"event"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["booking_id","booking_line_id","product_id","event_id","organisation_id","booked_quantity","sales_value","booking_date","event_start_date","booking_type"],"additionalProperties":false,"example":{"booking_id":"er/232/f31","booking_line_id":"1","customer_id":"32","product_id":"XYZ","event_id":"123","organisation_id":"540","department_id":"54011","salesperson_id":"5402101","booked_quantity":2,"number_of_guests":2,"number_of_visits":2,"sales_value":20,"sales_value_wo_vat":20,"currency":"EUR","canceled":false,"booking_date":"2020-03-01","booking_time":"15:00:00","event_start_date":"2020-03-10","event_start_time":"15:00:00","event_end_date":"2020-03-11","event_end_time":"15:00:00","booking_type":"event","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}},"example":[{"booking_id":"er/232/f31","booking_line_id":"1","customer_id":"32","product_id":"XYZ","event_id":"123","organisation_id":"540","department_id":"54011","salesperson_id":"5402101","booked_quantity":2,"number_of_guests":2,"number_of_visits":2,"sales_value":20,"sales_value_wo_vat":20,"currency":"EUR","canceled":false,"booking_date":"2020-03-01","booking_time":"15:00:00","event_start_date":"2020-03-10","event_start_time":"15:00:00","event_end_date":"2020-03-11","event_end_time":"15:00:00","booking_type":"event","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"source_system":"ABCDEF"}]}]}},"components/schemas/BookingUploadPayloadCsv":{"id":"components/schemas/BookingUploadPayloadCsv","kind":"json-schema","title":"BookingUploadPayloadCsv","data":{"type":"string","description":"Bookings data in CSV format.","example":"booking_id;booking_line_id;customer_id;product_id;booked_quantity;product_unit_price;sales_value;sales_value_wo_vat;currency;organisation_id;salesperson_id;event_id;booking_date;booking_time;event_start_date;event_start_time;event_end_date;event_end_time\ner/232/f31; 1; 32; XYZ; 2; 10; 20; 20; EUR; 540; 5402101; 6344; 2021-02-01; 15:30:00; 2021-03-01; 15:00:00; 2021-03-01; 15:00:00\n"}},"components/schemas/SupplierUploadPayloadJson":{"id":"components/schemas/SupplierUploadPayloadJson","kind":"json-schema","title":"SupplierUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Supplier"},{"type":"array","items":{"type":"object","properties":{"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"supplier_name":{"type":"string","description":"Supplier name","example":"WasSuppliers"},"supplier_email":{"type":"string","description":"Supplier Email","example":"john.smith@supplier.supplier"},"supplier_phone":{"type":"string","description":"Supplier phone number","example":"+3581111111"},"supplier_address":{"type":"string","description":"Street address","example":"Mannerheimintie 1"},"supplier_city":{"type":"string","description":"City","example":"Helsinki"},"supplier_zipcode":{"type":"string","description":"Postal code","example":"00100"},"supplier_country":{"type":"string","description":"Country","example":"Finland"},"supplier_group":{"type":"string","description":"Supplier group","example":"Strategic Supplier"},"supplier_type":{"type":"string","description":"Supplier type","example":"Local"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["supplier_id"],"additionalProperties":false,"example":{"supplier_id":"221","supplier_name":"WasSuppliers","supplier_email":"john.smith@supplier.supplier","supplier_phone":"+3581111111","supplier_address":"Mannerheimintie 1","supplier_city":"Helsinki","supplier_zipcode":"00100","supplier_country":"Finland","supplier_group":"Strategic Supplier","supplier_type":"Local","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}},"example":[{"supplier_id":"221","supplier_name":"WasSuppliers","supplier_email":"john.smith@supplier.supplier","supplier_phone":"+3581111111","supplier_address":"Mannerheimintie 1","supplier_city":"Helsinki","supplier_zipcode":"00100","supplier_country":"Finland","supplier_group":"Strategic Supplier","supplier_type":"Local","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}]}]}},"components/schemas/SupplierUploadPayloadCsv":{"id":"components/schemas/SupplierUploadPayloadCsv","kind":"json-schema","title":"SupplierUploadPayloadCsv","data":{"type":"string","description":"Suppliers data in CSV format.","example":"supplier_id;supplier_name;supplier_email;supplier_phone;supplier_address;supplier_city; supplier_zipcode;supplier_country\n221; WasSuppliers; john.smith@supplier.supplier; +3581111111; Mannerheimintie 1;Helsinki; 00100; Finland\n"}},"components/schemas/VisitorUploadPayloadJson":{"id":"components/schemas/VisitorUploadPayloadJson","kind":"json-schema","title":"VisitorUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/Visitor"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"540"},"counter_id":{"type":"string","description":"Counter ID","example":"540"},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Optional product id associated to this visitor (eg. ticket)"},"children":[]}]}]}],"example":"ABC-123"},"customer_id":{"type":"string","description":"Optional customer associated to this visitor (ticket etc.)","example":"1234"},"date":{"type":"string","description":"Date of visit (yyyy-mm-dd)","example":"2016-01-01"},"time":{"type":"string","description":"Time of visit (HH:mm:ss)","example":"15:00:00"},"time_zone":{"type":"string","description":"Optional location time zone.","example":"02:00"},"visit_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Type of visitor record ('in', 'out', 'pass', 'occupancy', 'visit_time', 'queue')"},"children":[]}]}]}],"example":"in"},"vehicle_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional field for vehicle type. Supported values are car & bicycle."},"children":[]}]}]}],"example":"car"},"queue_area_name":{"type":"string","description":"Optional area name for queue cameras.","example":"Area 1"},"low_queue":{"type":"number","description":"Threshold for low queue.","example":1},"high_queue":{"type":"number","description":"Threshold for high queue.","example":5},"visitors":{"type":"number","description":"Number of visitors at given time","example":1000},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","date","time","visitors"],"additionalProperties":false,"example":{"organisation_id":"540","department_id":"540","counter_id":"540","product_id":"ABC-123","customer_id":"1234","date":"2016-01-01","time":"15:00:00","time_zone":"02:00","visit_type":"in","vehicle_type":"car","queue_area_name":"Area 1","low_queue":1,"high_queue":5,"visitors":1000,"custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}},"example":[{"organisation_id":"540","department_id":"540","counter_id":"540","product_id":"ABC-123","customer_id":"1234","date":"2016-01-01","time":"15:00:00","time_zone":"02:00","visit_type":"in","vehicle_type":"car","queue_area_name":"Area 1","low_queue":1,"high_queue":5,"visitors":1000,"custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","source_system":"ABCDEF"}]}]}},"components/schemas/VisitorUploadPayloadCsv":{"id":"components/schemas/VisitorUploadPayloadCsv","kind":"json-schema","title":"VisitorUploadPayloadCsv","data":{"type":"string","description":"Visitors data in CSV format.","example":"organisation_id;date;time;visitors\n540;2016-01-01;15:00:00;1000\n"}},"components/schemas/VisitorDemographicsUploadPayloadJson":{"id":"components/schemas/VisitorDemographicsUploadPayloadJson","kind":"json-schema","title":"VisitorDemographicsUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/VisitorDemographics"},{"type":"array","items":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"540"},"counter_id":{"type":"string","description":"Counter ID","example":"540"},"date":{"type":"string","description":"Date of visit (yyyy-mm-dd)","example":"2016-01-01"},"time":{"type":"string","description":"Time of visit (HH:mm:ss)","example":"15:00:00"},"gender":{"type":"string","description":"Gender of visitor. 'm' for male, 'f' for female and 'u' for unknown.","example":"m"},"age":{"type":"number","description":"Age of the visitor.","example":25},"visitors":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of visitors for given age & gender for time specified."},"children":[]}]}]}],"example":1000},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["organisation_id","date","time","visitors"],"additionalProperties":false,"example":{"organisation_id":"540","department_id":"540","counter_id":"540","date":"2016-01-01","time":"15:00:00","gender":"m","age":25,"visitors":1000,"source_system":"ABCDEF"}},"example":[{"organisation_id":"540","department_id":"540","counter_id":"540","date":"2016-01-01","time":"15:00:00","gender":"m","age":25,"visitors":1000,"source_system":"ABCDEF"}]}]}},"components/schemas/VisitorDemographicsUploadPayloadCsv":{"id":"components/schemas/VisitorDemographicsUploadPayloadCsv","kind":"json-schema","title":"VisitorDemographicsUploadPayloadCsv","data":{"type":"string","description":"Visitor demographics data in CSV format.","example":"organisation_id;date;time;visitors\n540;2016-01-01;15:00:00;1000\n"}},"components/schemas/IdMappingUploadPayloadJson":{"id":"components/schemas/IdMappingUploadPayloadJson","kind":"json-schema","title":"IdMappingUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/IdMapping"},{"type":"array","items":{"type":"object","properties":{"source_system_id":{"type":"string","description":"store (string, required) - Identifier in the source system","example":"abc"},"master_id":{"type":"string","description":"123 (string, required) - Identifier in master data","example":"store"},"entity_type":{"type":"string","description":"Entity type this mapping is for (e.g. organisation, product)","example":"organisation"},"context":{"type":"string","description":"Type of data this mapping applies to","example":"visitor"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["source_system_id","master_id","entity_type","context"],"additionalProperties":false,"example":{"source_system_id":"abc","master_id":"store","entity_type":"organisation","context":"visitor","source_system":"ABCDEF"}},"example":[{"source_system_id":"abc","master_id":"store","entity_type":"organisation","context":"visitor","source_system":"ABCDEF"}]}]}},"components/schemas/IdMappingUploadPayloadCsv":{"id":"components/schemas/IdMappingUploadPayloadCsv","kind":"json-schema","title":"IdMappingUploadPayloadCsv","data":{"type":"string","description":"Id mapping data in CSV format.","example":"context; entity_type; master_id; source_system_id\nvisitor-data; organisation; store-123; ABCDE\n"}},"components/schemas/UpdateTimeUploadPayloadJson":{"id":"components/schemas/UpdateTimeUploadPayloadJson","kind":"json-schema","title":"UpdateTimeUploadPayloadJson","data":{"anyOf":[{"$ref":"#/components/schemas/UpdateTime"},{"type":"array","items":{"type":"object","properties":{"entity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key of entity updated. Generally One of Zapi end point names in lower case eg. workshifts, sales, salessummaries, inventorysnapshots, visitors etc. Special key 'last_updated' can be used to send aggregated update time for all data sets."},"children":[]}]}]}],"example":"workshifts"},"organisation_id":{"type":"string","description":"Optional organisation unit this update refers to only","example":"123"},"last_updated":{"type":"string","description":"Last time stamp when entity was successfully updated","example":"2019-08-21T02:25:31"},"source_system":{"type":"string","description":"Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.","example":"ABCDEF"}},"required":["entity","last_updated"],"additionalProperties":false,"example":{"entity":"workshifts","organisation_id":"123","last_updated":"2019-08-21 02:25:31","source_system":"ABCDEF"}},"example":[{"entity":"workshifts","organisation_id":"123","last_updated":"2019-08-21 02:25:31","source_system":"ABCDEF"}]}]}},"components/schemas/UpdateTimeUploadPayloadCsv":{"id":"components/schemas/UpdateTimeUploadPayloadCsv","kind":"json-schema","title":"UpdateTimeUploadPayloadCsv","data":{"type":"string","description":"Last updated data in CSV format.","example":"entity;organisation_id;last_updated;source_system\nworkshifts;store-123;2019-08-21 02:24:12;ABCDE\n"}},"schema_0":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SalesTransactionUploadPayloadJson"}],"description":""},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProductUploadPayloadJson"}],"description":""},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product data in CSV format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products can be uploaded either with category levels defined inline,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or by referencing an existing category using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CustomerUploadPayloadJson"}],"description":""},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CustomerFeedbackUploadPayloadJson"}],"description":""},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CashierBalanceUploadPayloadJson"}],"description":""},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/OrganisationUnitUploadPayloadJson"}],"description":""},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/DepartmentUploadPayloadJson"}],"description":""},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SalesPersonUploadPayloadJson"}],"description":""},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CashRegisterUploadPayloadJson"}],"description":""},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/OpeningHourUploadPayloadJson"}],"description":""},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CounterUploadPayloadJson"}],"description":""},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/AccountUploadPayloadJson"}],"description":""},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EventUploadPayloadJson"}],"description":""},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CalendarUploadPayloadJson"}],"description":""},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CampaignUploadPayloadJson"}],"description":""},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CampaignProductUploadPayloadJson"}],"description":""},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SalesCampaignUploadPayloadJson"}],"description":""},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CurrencyRateUploadPayloadJson"}],"description":""},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/WorkshiftUploadPayloadJson"}],"description":""},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/EmployeeHourUploadPayloadJson"}],"description":""},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/StaffCostUploadPayloadJson"}],"description":""},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/InventorySnapshotUploadPayloadJson"}],"description":""},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/InventoryTransactionUploadPayloadJson"}],"description":""},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CapacityUploadPayloadJson"}],"description":""},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/FlatHierarchyUploadPayloadJson"}],"description":""},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CategoryUploadPayloadJson"}],"description":""},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/RebateCodeUploadPayloadJson"}],"description":""},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/PaymentTypeUploadPayloadJson"}],"description":""},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/PurchaseOrdersUploadPayloadJson"}],"description":""},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SalesOffersUploadPayloadJson"}],"description":""},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SalesOrdersUploadPayloadJson"}],"description":""},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SalesSummaryUploadPayloadJson"}],"description":""},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SalesPaymentUploadPayloadJson"}],"description":""},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/GiftcardPaymentUploadPayloadJson"}],"description":""},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/AccountingUploadPayloadJson"}],"description":""},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/BookingUploadPayloadJson"}],"description":""},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SupplierUploadPayloadJson"}],"description":""},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/VisitorUploadPayloadJson"}],"description":""},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/VisitorDemographicsUploadPayloadJson"}],"description":""},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/IdMappingUploadPayloadJson"}],"description":""},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/BudgetEntry"},{"type":"array","items":{"type":"object","properties":{"year":{"type":"number","description":"Year this budget entry refers to","example":2017},"month":{"type":"number","description":"Month this budget entry refers to. Either month or week must be there.","example":1},"week":{"type":"number","description":"Week number this budget entry refers to. Either month or week must be there.","example":12},"day":{"type":"number","description":"Optional day this budget entry refers to","example":1},"hour":{"type":"number","description":"Optional hour this budget refers to. Day must be also specified if hour is specified.","example":1},"dimensions":{"type":"object","properties":{},"additionalProperties":false,"description":"Key-value pairs of dimensions and values for entry"},"metrics":{"type":"object","properties":{},"additionalProperties":false,"description":"Key-value pairs of metric values for given time and dimensions"}},"required":["year","dimensions","metrics"],"additionalProperties":false,"example":{"year":2017,"month":1,"week":12,"day":1,"hour":1,"dimensions":{},"metrics":{}}},"example":[{"year":2017,"month":1,"week":12,"day":1,"hour":1,"dimensions":{},"metrics":{}}]}],"description":""},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/UpdateTimeUploadPayloadJson"}],"description":""},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"number"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"242224"},"line_item_id":{"type":"string","description":"Secondary transaction identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"delivery_customer_id":{"type":"string","description":"Delivery customer ID for identified customer","example":"35"},"sales_date":{"type":"string","description":"Sales date (yyyy-mm-dd)","example":"2016-01-01"},"sales_time":{"type":"string","description":"Sales time (HH:mm:ss)","example":"15:00:00"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"product_quantity":{"type":"number","description":"Sold quantity","example":2},"product_unit_price":{"type":"number","description":"Unit price for single product","example":10},"sales_value":{"type":"number","description":"Total sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":20},"compensation_amount":{"type":"number","description":"Optional compensation paid for this sale","example":3},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"currency":{"type":"string","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"payment_method":{"type":"string","description":"Payment method","example":"Visa"},"supplier_id":{"type":"string","description":"Supplier ID","example":"13"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":5},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":5},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"deparment_id":{"type":"string","description":"Department unit ID","example":"5400"},"salesperson_id":{"type":"string","description":"Sales person / cashier ID","example":"5402101"},"sales_representative_id":{"type":"string","description":"Responsible sales person ID","example":"5402100"},"campaign_id":{"type":"string","description":"Campaign ID","example":"6344"},"delivery_date":{"type":"string","description":"Delivery date (yyyy-mm-dd)","example":"2016-01-01"},"delivery_time":{"type":"string","description":"Delivery time (HH:mm:ss)","example":"15:00:00"},"invoice_date":{"type":"string","description":"Invoice date (yyyy-mm-dd)","example":"2016-01-01"},"invoice_time":{"type":"string","description":"Invoice time (HH:mm:ss)","example":"15:00:00"},"register_id":{"type":"string","description":"Cash register ID","example":"54022"},"table_number":{"type":"string","description":"Table number","example":"54"},"rebate_code_id":{"type":"string","description":"Rebate Code ID","example":"3313V"},"booking_id":{"type":"string","description":"12 (string, optional) - Optional reference to booking that generated this sale.","example":"B1224"},"booking_line_id":{"type":"string","description":"Optional booking line that corresponds to this sale.","example":"1"},"event_id":{"type":"string","description":"Event ID","example":"221"},"sales_order_id":{"type":"string","description":"56 (string, optional) - Optional sales order that generated this sale.","example":"SO1234"},"sales_order_line_id":{"type":"string","description":"Optional sales order line that corresponds to this sale.","example":"1"},"parent_line_id":{"type":"string","description":"Line item id for parent line item in this sales transaction that this line is child to.","example":"1"},"custom_field_1":{"type":"string","description":"User defined custom field 1","example":"extra info"},"custom_field_2":{"type":"string","description":"User defined custom field 2","example":"extra info"},"custom_field_3":{"type":"string","description":"User defined custom field 3","example":"extra info"},"custom_field_4":{"type":"string","description":"User defined custom field 4","example":"extra info"},"custom_field_5":{"type":"string","description":"User defined custom field 5","example":"extra info"},"custom_field_6":{"type":"string","description":"User defined custom field 6","example":"extra info"},"custom_field_7":{"type":"string","description":"User defined custom field 7","example":"extra info"},"custom_field_8":{"type":"string","description":"User defined custom field 8","example":"extra info"},"custom_field_9":{"type":"string","description":"User defined custom field 9","example":"extra info"},"custom_field_10":{"type":"string","description":"User defined custom field 10","example":"extra info"},"custom_field_11":{"type":"string","description":"User defined custom field 11","example":"extra info"},"custom_field_12":{"type":"string","description":"User defined custom field 12","example":"extra info"},"custom_field_13":{"type":"string","description":"User defined custom field 13","example":"extra info"},"custom_field_14":{"type":"string","description":"User defined custom field 14","example":"extra info"},"custom_field_15":{"type":"string","description":"User defined custom field 15","example":"extra info"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"custom_metric_6":{"type":"number","description":"Custom metric 6","example":1},"custom_metric_7":{"type":"number","description":"Custom metric 7","example":100},"custom_metric_8":{"type":"number","description":"Custom metric 8","example":2.2},"custom_metric_9":{"type":"number","description":"Custom metric 9","example":1.05},"custom_metric_10":{"type":"number","description":"Custom metric 10","example":10000}},"required":["transaction_id","line_item_id","sales_date","sales_time","product_id","product_quantity","product_unit_price","sales_value"]},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"er/232/f31"},"line_item_id":{"type":"string","description":"Secondary transaction identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"delivery_customer_id":{"type":"string","description":"Delivery customer ID for identified customer","example":"35"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"product_quantity":{"type":"number","description":"Sold quantity","example":2},"delivered_quantity":{"type":"number","description":"Delivered quantity","example":1},"planned_quantity":{"type":"number","description":"Planned quantity","example":2},"product_unit_price":{"type":"number","description":"Unit price for single product","example":10},"sales_value":{"type":"number","description":"Total sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":20},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"rebate_code_id":{"type":"string","description":"Rebate Code ID","example":"3313V"},"currency":{"type":"string","description":"Order currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"payment_method":{"type":"string","description":"Payment method","example":"Invoice 30"},"tender_amount":{"type":"number","description":"Amount paid with given payment method.","example":20},"deposit_amount":{"type":"number","description":"Amount of deposit paid for this order item.","example":10},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":5},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":5},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"54011"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"order_date":{"type":"string","description":"Order date (yyyy-mm-dd)","example":"2016-01-01"},"order_time":{"type":"string","description":"Order time (HH:mm:ss)","example":"15:00:00"},"invoice_date":{"type":"string","description":"Invoice date (yyyy-mm-dd)","example":"2016-01-01"},"invoice_time":{"type":"string","description":"Invoice time (HH:mm:ss)","example":"15:00:00"},"arrival_date":{"type":"string","description":"Arrival date (yyyy-mm-dd)","example":"2016-01-03"},"arrival_time":{"type":"string","description":"Arrival time (HH:mm:ss)","example":"15:00:00"},"order_status":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}],"example":1},"order_type":{"type":"string","description":"Order type","example":"internal"},"gross_weight":{"type":"number","description":"Gross weight for this order item","example":123},"customer_order_number":{"type":"string","description":"Optional order ID visible to end users","example":"12345"},"sales_offer_id":{"type":"string","description":"Optional transaction ID for offer this order was created from","example":"123"},"sales_offer_line_id":{"type":"string","description":"Optional line ID for offer this order was created from","example":"1"},"custom_field_1":{"type":"string","description":"User defined custom field 1","example":"extra info"},"custom_field_2":{"type":"string","description":"User defined custom field 2","example":"extra info"},"custom_field_3":{"type":"string","description":"User defined custom field 3","example":"extra info"},"custom_field_4":{"type":"string","description":"User defined custom field 4","example":"extra info"},"custom_field_5":{"type":"string","description":"User defined custom field 5","example":"extra info"},"custom_field_6":{"type":"string","description":"User defined custom field 6","example":"extra info"},"custom_field_7":{"type":"string","description":"User defined custom field 7","example":"extra info"},"custom_field_8":{"type":"string","description":"User defined custom field 8","example":"extra info"},"custom_field_9":{"type":"string","description":"User defined custom field 9","example":"extra info"},"custom_field_10":{"type":"string","description":"User defined custom field 10","example":"extra info"},"custom_field_11":{"type":"string","description":"User defined custom field 11","example":"extra info"},"custom_field_12":{"type":"string","description":"User defined custom field 12","example":"extra info"},"custom_field_13":{"type":"string","description":"User defined custom field 13","example":"extra info"},"custom_field_14":{"type":"string","description":"User defined custom field 14","example":"extra info"},"custom_field_15":{"type":"string","description":"User defined custom field 15","example":"extra info"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["transaction_id","line_item_id","product_id","product_quantity","product_unit_price","sales_value"]},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"er/232/f31"},"line_item_id":{"type":"string","description":"Secondary transaction identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"product_quantity":{"type":"number","description":"Sold quantity","example":2},"product_unit_price":{"type":"number","description":"Unit price for single product","example":10},"sales_value":{"type":"number","description":"Total sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":20},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":5},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":5},"currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"offer_date":{"type":"string","description":"Order date (yyyy-mm-dd)","example":"2016-01-01"},"offer_time":{"type":"string","description":"Order time (HH:mm:ss)","example":"15:00:00"},"valid_date":{"type":"string","description":"Invoice date (yyyy-mm-dd)","example":"2016-01-01"},"valid_time":{"type":"string","description":"Invoice time (HH:mm:ss)","example":"15:00:00"},"offer_status":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offer status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}],"example":1},"offer_type":{"type":"string","description":"Offer type","example":"internal"},"custom_field_1":{"type":"string","description":"User defined custom field 1","example":"extra info"},"custom_field_2":{"type":"string","description":"User defined custom field 2","example":"extra info"},"custom_field_3":{"type":"string","description":"User defined custom field 3","example":"extra info"},"custom_field_4":{"type":"string","description":"User defined custom field 4","example":"extra info"},"custom_field_5":{"type":"string","description":"User defined custom field 5","example":"extra info"},"custom_field_6":{"type":"string","description":"User defined custom field 6","example":"extra info"},"custom_field_7":{"type":"string","description":"User defined custom field 7","example":"extra info"},"custom_field_8":{"type":"string","description":"User defined custom field 8","example":"extra info"},"custom_field_9":{"type":"string","description":"User defined custom field 9","example":"extra info"},"custom_field_10":{"type":"string","description":"User defined custom field 10","example":"extra info"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["transaction_id","line_item_id","product_id","product_quantity","product_unit_price","sales_value"]},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"er/232/f31"},"line_item_id":{"type":"string","description":"Secondary transaction identifier","example":"1"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"ordered_quantity":{"type":"number","description":"Purchased quantity","example":2},"delivered_quantity":{"type":"number","description":"Delivered quantity","example":2},"product_unit_price":{"type":"number","description":"Unit price including tax","example":2.5},"currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":5},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":4},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"retail_value":{"type":"number","description":"Total retail (sales) value including tax","example":10},"retail_value_wo_vat":{"type":"number","description":"Total retail (sales) value without tax","example":8},"sales_unit":{"type":"string","description":"Unit of packaging","example":"pcs"},"gross_weight":{"type":"number","description":"Total weight of this order item","example":12.5},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"54011"},"purchaser_id":{"type":"string","description":"Purchaser ID","example":"5400"},"order_date":{"type":"string","description":"Order date (yyyy-mm-dd)","example":"2016-01-01"},"order_time":{"type":"string","description":"Order time (HH:mm:ss)","example":"15:00:00"},"delivery_date":{"type":"string","description":"Delivery date (yyyy-mm-dd)","example":"2016-01-01"},"delivery_time":{"type":"string","description":"Delivery time (HH:mm:ss)","example":"15:00:00"},"arrival_date":{"type":"string","description":"Arrival date (yyyy-mm-dd)","example":"2016-01-03"},"arrival_time":{"type":"string","description":"Arrival time (HH:mm:ss)","example":"15:00:00"},"order_status":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order status. 1=Open, 2=Reserved, 3=Invoiced, 4=Cancelled"},"children":[]}]}]}],"example":1},"order_type":{"type":"string","description":"Order Type","example":"Express"},"custom_field_1":{"type":"string","description":"User defined custom field 1","example":"extra info"},"custom_field_2":{"type":"string","description":"User defined custom field 2","example":"extra info"},"custom_field_3":{"type":"string","description":"User defined custom field 3","example":"extra info"},"custom_field_4":{"type":"string","description":"User defined custom field 4","example":"extra info"},"custom_field_5":{"type":"string","description":"User defined custom field 5","example":"extra info"},"custom_field_6":{"type":"string","description":"User defined custom field 6","example":"extra info"},"custom_field_7":{"type":"string","description":"User defined custom field 7","example":"extra info"},"custom_field_8":{"type":"string","description":"User defined custom field 8","example":"extra info"},"custom_field_9":{"type":"string","description":"User defined custom field 9","example":"extra info"},"custom_field_10":{"type":"string","description":"User defined custom field 10","example":"extra info"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["transaction_id","line_item_id","product_id","ordered_quantity","organisation_id","order_date","order_status"]},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","properties":{"sales_date":{"type":"string","description":"Sales date (yyyy-mm-dd)","example":"2016-01-01"},"sales_time":{"type":"string","description":"Sales time (HH:mm:ss)","example":"15:00:00"},"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"15:00:00"},"customer_id":{"type":"string","description":"Customer ID","example":"1234"},"supplier_id":{"type":"string","description":"Supplier ID","example":"12"},"campaign_id":{"type":"string","description":"Campaign ID","example":"123"},"rebate_code_id":{"type":"string","description":"Rebate Code ID","example":"3313V"},"sales_value":{"type":"number","description":"Total sales amount including tax","example":2000},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":1600},"sales_currency":{"type":"string","description":"Sales currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":500},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":400},"product_quantity":{"type":"number","description":"Sold quantity","example":4},"number_of_transactions":{"type":"number","description":"Number of receipts","example":2},"custom_field_1":{"type":"string","description":"User defined custom field 1","example":"extra info"},"custom_field_2":{"type":"string","description":"User defined custom field 2","example":"extra info"},"custom_field_3":{"type":"string","description":"User defined custom field 3","example":"extra info"},"custom_field_4":{"type":"string","description":"User defined custom field 4","example":"extra info"},"custom_field_5":{"type":"string","description":"User defined custom field 5","example":"extra info"},"custom_field_6":{"type":"string","description":"User defined custom field 6","example":"extra info"},"custom_field_7":{"type":"string","description":"User defined custom field 7","example":"extra info"},"custom_field_8":{"type":"string","description":"User defined custom field 8","example":"extra info"},"custom_field_9":{"type":"string","description":"User defined custom field 9","example":"extra info"},"custom_field_10":{"type":"string","description":"User defined custom field 10","example":"extra info"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["sales_date","organisation_id"]},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for the transaction","example":"242224"},"line_item_id":{"type":"string","description":"Transaction line identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"delivery_customer_id":{"type":"string","description":"Delivery customer ID for identified customer","example":"35"},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"department_id":{"type":"string","description":"Department unit ID","example":"5400"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"register_id":{"type":"string","description":"Cash register ID","example":"54022"},"table_number":{"type":"string","description":"Table number","example":"54"},"payment_method":{"type":"string","description":"Payment method ID","example":"Visa"},"giftcard_payment_id":{"type":"string","description":"Id to link to possible giftcard used for this payment.","example":"12345"},"sales_date":{"type":"string","description":"Sales date (yyyy-mm-dd)","example":"2016-01-01"},"sales_time":{"type":"string","description":"Sales time (HH:mm:ss)","example":"15:00:00"},"product_quantity":{"type":"number","description":"Sold quantity","example":4},"sales_value":{"type":"number","description":"Total sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total sales amount without tax","example":20},"rebate":{"type":"number","description":"Amount of rebate given including tax","example":0},"rebate_wo_vat":{"type":"number","description":"Amount of rebate given without tax","example":0},"purchase_price":{"type":"number","description":"Total purchase price including tax","example":500},"purchase_price_wo_vat":{"type":"number","description":"Total purchase price without tax","example":400},"currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"custom_field_1":{"type":"string","description":"User defined custom field 1","example":"extra info"},"custom_field_2":{"type":"string","description":"User defined custom field 2","example":"extra info"},"custom_field_3":{"type":"string","description":"User defined custom field 3","example":"extra info"},"custom_field_4":{"type":"string","description":"User defined custom field 4","example":"extra info"},"custom_field_5":{"type":"string","description":"User defined custom field 5","example":"extra info"},"custom_field_6":{"type":"string","description":"User defined custom field 6","example":"extra info"},"custom_field_7":{"type":"string","description":"User defined custom field 7","example":"extra info"},"custom_field_8":{"type":"string","description":"User defined custom field 8","example":"extra info"},"custom_field_9":{"type":"string","description":"User defined custom field 9","example":"extra info"},"custom_field_10":{"type":"string","description":"User defined custom field 10","example":"extra info"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"custom_metric_6":{"type":"number","description":"Custom metric 6","example":1},"custom_metric_7":{"type":"number","description":"Custom metric 7","example":100},"custom_metric_8":{"type":"number","description":"Custom metric 8","example":2.2},"custom_metric_9":{"type":"number","description":"Custom metric 9","example":1.05},"custom_metric_10":{"type":"number","description":"Custom metric 10","example":10000}},"required":["transaction_id","line_item_id","sales_date","sales_time","sales_value"]},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"object","properties":{"giftcard_id":{"type":"string","description":"Unique ID for the gift card.","example":"A67gigMp"},"giftcard_number":{"type":"string","description":"Gift card number","example":"7TON39"},"giftcard_status":{"type":"string","description":"Gift card status","example":"Active"},"giftcard_balance":{"type":"number","description":"Gift card balance","example":50},"creation_date":{"type":"string","description":"Gift card creation date (yyyy-mm-dd)","example":"2016-01-01"},"creation_time":{"type":"string","description":"Gift card creation time (HH:mm:ss)","example":"15:00:00"},"expiration_date":{"type":"string","description":"Gift card expiration date (yyyy-mm-dd)","example":"2017-01-01"},"expiration_time":{"type":"string","description":"Gift card expiration time (HH:mm:ss)","example":"15:00:00"},"sales_id":{"type":"string","description":"Sales Id","example":"dbeba367"},"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"register_id":{"type":"string","description":"Cash register ID","example":"32"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"payment_id":{"type":"string","description":"Payment method ID","example":"A65A"},"payment_type":{"type":"string","description":"Payment type","example":"Activation"},"payment_date":{"type":"string","description":"Payment date (yyyy-mm-dd)","example":"2016-05-15"},"payment_time":{"type":"string","description":"Payment time (HH:mm:ss)","example":"15:00:00"},"payment_value":{"type":"number","description":"Payment amount","example":20},"payment_currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["giftcard_id","giftcard_number","giftcard_status","creation_date","organisation_id","payment_id","payment_type","payment_date","payment_time","payment_value"]},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"booking_id":{"type":"string","description":"Unique ID for the booking","example":"er/232/f31"},"booking_line_id":{"type":"string","description":"Secondary booking identifier","example":"1"},"customer_id":{"type":"string","description":"Customer ID for identified customer","example":"32"},"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"event_id":{"type":"string","description":"A (string, optional) - Optional ID for the event this booking is done for.","example":"123"},"organisation_id":{"type":"string","description":"Organisation unit ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"54011"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"booked_quantity":{"type":"number","description":"Booked quantity","example":2},"number_of_guests":{"type":"number","description":"Number of guests booked","example":2},"number_of_visits":{"type":"number","description":"Number of visits allowed per guest within start and end dates.","example":2},"sales_value":{"type":"number","description":"Total booking sales amount including tax","example":20},"sales_value_wo_vat":{"type":"number","description":"Total booking sales amount without tax","example":20},"currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"canceled":{"type":"boolean","description":"True when this booking has been cancelled.","example":false},"booking_date":{"type":"string","description":"Booking date (yyyy-mm-dd)","example":"2020-03-01"},"booking_time":{"type":"string","description":"Booking time (HH:mm:ss)","example":"15:00:00"},"event_start_date":{"type":"string","description":"Event start date (yyyy-mm-dd)","example":"2020-03-10"},"event_start_time":{"type":"string","description":"Event start time (HH:mm:ss)","example":"15:00:00"},"event_end_date":{"type":"string","description":"Event end date (yyyy-mm-dd)","example":"2020-03-11"},"event_end_time":{"type":"string","description":"Event end time (HH:mm:ss)","example":"15:00:00"},"booking_type":{"type":"string","description":"Booking type. Must be either event, ticket or room.","example":"event"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["booking_id","booking_line_id","product_id","organisation_id","booked_quantity","sales_value","booking_date","event_start_date","booking_type"]},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":"Unique ID for this accounting receipt","example":"1234"},"line_item_id":{"type":"string","description":"Unique ID for this accounting receipt line item","example":"1"},"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"account_id":{"type":"string","description":"Account ID","example":"1150"},"event_date":{"type":"string","description":"Event date (yyyy-mm-dd)","example":"2016-01-01"},"event_time":{"type":"string","description":"Event time (HH:mm:ss)","example":"15:00:00"},"receipt_type":{"type":"string","description":"Receipt type","enum":["income","cost","asset","liability"],"x-enumDescriptions":{"income":"This receipt is income for the company in income statement","cost":"This receipt is cost for the company in income statement","asset":"This receipt is balance sheet asset (eg. property) for the company","liability":"This receipt is balance sheet liability (eg. debt) for the company"},"example":"cost"},"receipt_number":{"type":"string","description":"XZY (string, optional) - Optional bookkeeping receipt number","example":"12345"},"receipt_value":{"type":"number","description":"Total amount of this line item","example":2000},"receipt_value_wo_vat":{"type":"number","description":"Total amount of this line item without taxes","example":1600},"currency":{"type":"string","description":"Currency as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"cancelled":{"type":"boolean","description":"If set then this receipt has been cancelled.","example":true},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"}},"required":["transaction_id","line_item_id","organisation_id","account_id","event_date","receipt_type"]},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Identifier of store for this balance","example":"ORG1"},"department_id":{"type":"string","description":"Optional identifier of department for this balance","example":"DEP1"},"register_id":{"type":"string","description":"Optional cash register identifier for this balance","example":"123"},"batch_id":{"type":"string","description":"Optional batch or shift identifier for this balance row","example":"1"},"payment_method":{"type":"string","description":"Payment method of this balance row","example":"Cash"},"sales_date":{"type":"string","description":"Date of balance (yyyy-mm-dd)","example":"2018-01-01"},"sales_time":{"type":"string","description":"Optional time of balance (hh:mm:ss)","example":"15:00:00"},"batch_status":{"type":"string","description":"Optional status of this batch ID","example":"OK"},"transaction_count":{"type":"number","description":"Number of transactions for this shift and payment method","example":9},"shift_amount":{"type":"number","description":"Total amount of payments for this shift and payment method","example":1000},"over_short":{"type":"number","description":"Difference in money between sales and shift amounts","example":100},"cash_dropped":{"type":"number","description":"How much cash was dropped from register during this shift","example":0},"cash_paid_out":{"type":"number","description":"How much cash was paid out from register during this shift","example":50},"currency":{"type":"string","description":"Shift currency as ISO 4217 currency code. Required if multiple currencies are used by the customer.","example":"EUR"}},"required":["organisation_id","payment_method","sales_date","transaction_count","shift_amount"]},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"object","properties":{"feedback_id":{"type":"string","description":"Unique ID for this feedback entry","example":"xyz"},"respondent_id":{"type":"string","description":"Optional ID for survey respondent. Can be used to group all responses by single respondent.","example":"1234"},"survey_id":{"type":"string","description":"Optional ID for survey. Can be used to separate responses between different surveys.","example":"Survey 1"},"question_id":{"type":"string","description":"Optional ID for feedback question. Should be used if multiple separate feedback questions are needed.","example":"Q1"},"organisation_id":{"type":"string","description":"Identifier of store this feedback entry refers to","example":"ORG1"},"department_id":{"type":"string","description":"Optional identifier of department this feedback entry refers to","example":"DEP1"},"feedback_date":{"type":"string","description":"Date of feedback (yyyy-mm-dd)","example":"2018-01-01"},"feedback_time":{"type":"string","description":"Optional time of feedback (hh:mm:ss)","example":"15:00:00"},"feedback_type":{"type":"string","description":"Optional type of feedback","example":"Store survey"},"main_feedback":{"type":"boolean","description":"Is this main (overall grade) feedback. Default is true","example":true},"grade":{"type":"number","description":"Numerical grade for feedback","example":9},"grade_total":{"type":"number","description":"Optional numerical total grade calculated by source (eg. Google Review) for feedback","example":8.5},"comments":{"type":"string","description":"Optional free form feedback","example":"Great service today!"},"comments_en":{"type":"string","description":"Optional free form feedback translated in English","example":"Great service today!"},"review_url":{"type":"string","description":"Google review URL","example":"https://www.google.com/maps/reviews?data=XYZ"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"}},"required":["feedback_id","organisation_id","feedback_date","grade"]},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5401"},"department_id":{"type":"string","description":"Department ID","example":"54011"},"operator_id":{"type":"string","description":"Operator ID","example":"5402"},"movement_date":{"type":"string","description":"Date of transaction (yyyy-mm-dd)","example":"2016-02-01"},"movement_time":{"type":"string","description":"Time of transaction (HH:mm:ss).","example":"15:00:00"},"delivered_date":{"type":"string","description":"Date of transaction completion (yyyy-mm-dd)","example":"2016-02-02"},"delivered_time":{"type":"string","description":"Time of transaction completion (HH:mm:ss).","example":"15:00:00"},"product_id":{"type":"string","description":"1 (string, required) - Product ID","example":"123"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"123"},"quantity":{"type":"number","description":"Quantity moved from/to inventory","example":100},"delivered_quantity":{"type":"number","description":"Final quantity moved from/to inventory after completion.","example":90},"expected_quantity":{"type":"number","description":"Quantity expected in inventory (for stock takes).","example":110},"movement_type":{"type":"string","description":"Movement type","enum":["purchase","waste","transfer","stock_take","adjustment","sale","internal"],"x-enumDescriptions":{"purchase":"Products have been purchased to inventory","waste":"Products have been removed from inventory as waste","transfer":"Products have been transferred to another inventory location","stock_take":"Stock take has been done to correct inventory counts","adjustment":"Adjustments have been done to individual products to correct inventory counts","sale":"Products have been sold from inventory","internal":"Products have been used internally from inventory"},"example":"waste"},"movement_status":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Movement status. 1=Open, 2=Complete, 3=Complete with variances, 4=Cancelled"},"children":[]}]}]}],"example":2},"movement_batch_id":{"type":"string","description":"Optional identifier for batch this movement row is part of.","example":"june-stock-take"},"movement_batch_line_id":{"type":"string","description":"Optional line id within the batch this movement row is part of.","example":"1"},"unit_purchase_price":{"type":"number","description":"Unit purchase price","example":12.4},"unit_purchase_price_wo_vat":{"type":"number","description":"Unit purchase price without tax","example":10},"unit_retail_price":{"type":"number","description":"Unit retail (sales) price","example":12.4},"unit_retail_price_wo_vat":{"type":"number","description":"Unit retail (sales) price without tax","example":10},"reason_code":{"type":"string","description":"Optional reason code or description for this transaction","example":"Theft"},"target_organisation_id":{"type":"string","description":"Organisation / Store ID for target of inventory transfer. Mandatory for type transfer.","example":"510"},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"purchase_order_id":{"type":"string","description":"Order id for purchase order this purchase movement originates from.","example":"1234"},"purchase_order_line_id":{"type":"string","description":"Order line item id in purchase order this purchase movement line item originates from.","example":"1"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_field_6":{"type":"string","description":"Custom field 6","example":"EU only"},"custom_field_7":{"type":"string","description":"Custom field 7","example":"EU only"},"custom_field_8":{"type":"string","description":"Custom field 8","example":"EU only"},"custom_field_9":{"type":"string","description":"Custom field 9","example":"EU only"},"custom_field_10":{"type":"string","description":"Custom field 10","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["organisation_id","salesperson_id","movement_date","quantity","movement_type"]},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"snapshot_date":{"type":"string","description":"Date of snapshot (yyyy-mm-dd)","example":"2016-01-01"},"snapshot_time":{"type":"string","description":"Time of snapshot (HH:mm:ss). Needed if inter-day inventory saldos are tracked.","example":"15:00:00"},"product_id":{"type":"string","description":"Product ID","example":"My product ID"},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"quantity":{"type":"number","description":"On hand quantity in inventory","example":100},"available_quantity":{"type":"number","description":"Available quantity in inventory (after pending/reserved orders)","example":90},"reorder_point":{"type":"number","description":"Quantity threshold for this item to order more into inventory","example":5},"max_reorder_quantity":{"type":"number","description":"Max quantity threshold for this item after reordering","example":10},"unit_purchase_price":{"type":"number","description":"Unit purchase price","example":12.4},"unit_purchase_price_wo_vat":{"type":"number","description":"Unit purchase price without tax","example":10},"unit_sales_price":{"type":"number","description":"Unit sales price","example":22.4},"unit_sales_price_wo_vat":{"type":"number","description":"Unit sales price without tax","example":20},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"}},"required":["organisation_id","snapshot_date","product_id","quantity"]},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation ID","example":"540"},"product_id":{"type":"string","description":"A (string, required) - Product ID","example":"123"},"event_id":{"type":"string","description":"Event ID","example":"221"},"capacity_date":{"type":"string","description":"Date of capacity (yyyy-mm-dd)","example":"2020-02-01"},"capacity_time":{"type":"string","description":"Time of capacity (HH:mm:ss).","example":"15:00:00"},"capacity_type":{"type":"string","description":"Capacity type. Must be either event or room.","example":"event"},"max_capacity":{"type":"number","description":"Maximum available capacity for this item.","example":100}},"required":["organisation_id","capacity_date","capacity_type","max_capacity"]},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"540"},"counter_id":{"type":"string","description":"Counter ID","example":"540"},"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Optional product id associated to this visitor (eg. ticket)"},"children":[]}]}]}],"example":"ABC-123"},"date":{"type":"string","description":"Date of visit (yyyy-mm-dd)","example":"2016-01-01"},"time":{"type":"string","description":"Time of visit (HH:mm:ss)","example":"15:00:00"},"time_zone":{"type":"string","description":"Optional location time zone.","example":"02:00"},"visit_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Type of visitor record ('in', 'out', 'pass', 'occupancy', 'visit_time', 'queue')"},"children":[]}]}]}],"example":"in"},"vehicle_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional field for vehicle type. Supported values are car & bicycle."},"children":[]}]}]}],"example":"car"},"visitors":{"type":"number","description":"Number of visitors at given time","example":1000},"queue_area_name":{"type":"string","description":"For a queue camera, the name of the queue area","example":"Area 1"},"low_queue":{"type":"number","description":"Threshold for low queue.","example":1},"high_queue":{"type":"number","description":"Threshold for high queue.","example":5},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"}},"required":["organisation_id","date","time","visitors"]},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation/Store ID","example":"540"},"department_id":{"type":"string","description":"Department ID","example":"540"},"counter_id":{"type":"string","description":"Counter ID","example":"540"},"visitor_id":{"type":"string","description":"Visitor ID","example":"540"},"date":{"type":"string","description":"Date of visit (yyyy-mm-dd)","example":"2016-01-01"},"time":{"type":"string","description":"Time of visit (HH:mm:ss)","example":"15:00:00"},"gender":{"type":"string","description":"Gender of visitor. 'm' for male, 'f' for female and 'u' for unknown.","example":"m"},"age":{"type":"number","description":"Age of the visitor.","example":25},"visitors":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of visitors for given age & gender for time specified."},"children":[]}]}]}],"example":1000}},"required":["organisation_id","date","time","visitors"]},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation unit where shift will take place","example":"234"},"department_id":{"type":"string","description":"Store department ID","example":"5401"},"salesperson_id":{"type":"string","description":"Identifier of sales person / employee working. Required for punched shifts","example":"345"},"shift_id":{"type":"string","description":"Unique identifier for the workshift","example":"123"},"start_date":{"type":"string","description":"Shift start date (yyyy-mm-dd)","example":"2016-01-01"},"start_time":{"type":"string","description":"Shift start time (HH:mm:ss)","example":"15:00:00"},"duration":{"type":"number","description":"Duration of the shift in hours.","example":8.15},"shift_type":{"type":"string","description":"Type of the shift. Freeform, will be available as dimension in portal.","example":"Chef"},"salary_type":{"type":"string","description":"Type of compensation for the shift.","example":"Evening compensation"},"staff_cost":{"type":"number","description":"Cost associated with this shift","example":500},"breaks_duration":{"type":"number","description":"Total hours of breaks during this shift","example":0.5},"breaks_cost":{"type":"number","description":"Total salary cost associated for paid breaks during this shift","example":40},"overtime_duration":{"type":"number","description":"Total overtime hours during this shift","example":2},"overtime_cost":{"type":"number","description":"Total salary cost associated for overtime hours","example":120},"absence_code":{"type":"string","description":"Code for the absense if this entry describes absence.","example":"BREAK"},"productive":{"type":"boolean","description":"Whether this is productive or administrative work, default is true","example":true},"active_work_time":{"type":"boolean","description":"Whether this shift is calculated in active work time, default is true","example":true},"scheduled":{"type":"boolean","description":"Whether this is scheduled or punched shift, default is false","example":false},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["organisation_id","shift_id","start_date","start_time","duration"]},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"54021"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"employee_type":{"type":"string","description":"Employee Type","example":"Permie"},"absence_code":{"type":"string","description":"Code for the absense if this entry describes absence.","example":"BREAK"},"date":{"type":"string","description":"Date of entry (yyyy-mm-dd)","example":"2016-01-01"},"time":{"type":"string","description":"Time of entry (HH:mm:ss)","example":"15:00:00"},"scheduled":{"type":"boolean","description":"Whether this is scheduled or punched shift, default is false","example":false},"productive":{"type":"boolean","description":"Whether this is productive or administrative work, default is true","example":true},"hours":{"type":"number","description":"Number of hours to record for this specific time","example":8},"staff_cost":{"type":"number","description":"Salary cost associated with this hour","example":500},"breaks":{"type":"number","description":"Total hours of breaks","example":0.5},"breaks_cost":{"type":"number","description":"Total salary cost associated for paid breaks","example":40},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"}},"required":["organisation_id","date","time","hours"]},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"department_id":{"type":"string","description":"Store department ID","example":"54021"},"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"start_date":{"type":"string","description":"Start date of entry (yyyy-mm-dd)","example":"2024-01-01"},"staff_cost":{"type":"number","description":"Hourly salary cost","example":15},"currency":{"type":"string","description":"Currency for the purchase price as ISO 4217 currency code. Required if multiple currencies are used.","example":"EUR"}},"required":["organisation_id","start_date","staff_cost"]},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"object","properties":{"product_id":{"type":"string","description":"Product ID","example":"XYZ"},"product_name":{"type":"string","description":"Product Name","example":"Widget XYZ"},"product_description":{"type":"string","description":"Product description","example":"Best performance XYZ on the market"},"average_price":{"type":"number","description":"Running average purchase price for product.","example":8},"purchase_price":{"type":"number","description":"Default purchase price for product. Used if sales transaction doesn't have purchase price set.","example":10},"sales_price":{"type":"number","description":"Default retail price for product with taxes.","example":20},"sales_price_wo_vat":{"type":"number","description":"Default retail price for product without taxes.","example":16},"vat_rate":{"type":"number","description":"VAT/tax rate","example":24},"unit_of_measure":{"type":"string","description":"Unit of measure","example":"PCS"},"product_size":{"type":"string","description":"Product size","example":"XS"},"product_width":{"type":"string","description":"Product width","example":"5\""},"product_height":{"type":"string","description":"Product height","example":"10\""},"product_color":{"type":"string","description":"Product color","example":"Dark Blue"},"product_type":{"type":"string","description":"Product type","example":"Type A"},"product_season":{"type":"string","description":"Product season","example":"Spring"},"product_brand":{"type":"string","description":"Product brand","example":"Tiger"},"model":{"type":"string","description":"a (string, optional) - Product model","example":"XYZ B40"},"model_number":{"type":"string","description":"Product model number","example":"X311"},"country_of_origin":{"type":"string","description":"Country of origin","example":"Moldovia"},"freight":{"type":"number","description":"Freight","example":5},"duty":{"type":"number","description":"Duty","example":0.24},"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"fabric":{"type":"string","description":"Product fabric","example":"Felt"},"buyer":{"type":"string","description":"Buyer name","example":"Lena Shields"},"ean":{"type":"string","description":"Ean code","example":"Ean code"},"parent_product_id":{"type":"string","description":"Parent Product ID","example":"XY"},"image_url":{"type":"string","description":"Url for external product image file","example":"http://example.com?product=XYZ"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"},"custom_field_6":{"type":"string","description":"Custom field 6","example":"EU only"},"custom_field_7":{"type":"string","description":"Custom field 7","example":"EU only"},"custom_field_8":{"type":"string","description":"Custom field 8","example":"EU only"},"custom_field_9":{"type":"string","description":"Custom field 9","example":"EU only"},"custom_field_10":{"type":"string","description":"Custom field 10","example":"EU only"},"custom_field_11":{"type":"string","description":"Custom field 11","example":"EU only"},"custom_field_12":{"type":"string","description":"Custom field 12","example":"EU only"},"custom_field_13":{"type":"string","description":"Custom field 13","example":"EU only"},"custom_field_14":{"type":"string","description":"Custom field 14","example":"EU only"},"custom_field_15":{"type":"string","description":"Custom field 15","example":"EU only"},"custom_field_16":{"type":"string","description":"Custom field 16","example":"EU only"},"custom_field_17":{"type":"string","description":"Custom field 17","example":"EU only"},"custom_field_18":{"type":"string","description":"Custom field 18","example":"EU only"},"custom_field_19":{"type":"string","description":"Custom field 19","example":"EU only"},"custom_field_20":{"type":"string","description":"Custom field 20","example":"EU only"},"custom_field_21":{"type":"string","description":"Custom field 21","example":"EU only"},"custom_field_22":{"type":"string","description":"Custom field 22","example":"EU only"},"custom_field_23":{"type":"string","description":"Custom field 23","example":"EU only"},"custom_field_24":{"type":"string","description":"Custom field 24","example":"EU only"},"custom_field_25":{"type":"string","description":"Custom field 25","example":"EU only"},"custom_field_26":{"type":"string","description":"Custom field 26","example":"EU only"},"custom_field_27":{"type":"string","description":"Custom field 27","example":"EU only"},"custom_field_28":{"type":"string","description":"Custom field 28","example":"EU only"},"custom_field_29":{"type":"string","description":"Custom field 29","example":"EU only"},"custom_field_30":{"type":"string","description":"Custom field 30","example":"EU only"},"custom_field_31":{"type":"string","description":"Custom field 31","example":"EU only"},"custom_field_32":{"type":"string","description":"Custom field 32","example":"EU only"},"custom_field_33":{"type":"string","description":"Custom field 33","example":"EU only"},"custom_field_34":{"type":"string","description":"Custom field 34","example":"EU only"},"custom_field_35":{"type":"string","description":"Custom field 35","example":"EU only"},"custom_field_36":{"type":"string","description":"Custom field 36","example":"EU only"},"custom_field_37":{"type":"string","description":"Custom field 37","example":"EU only"},"custom_field_38":{"type":"string","description":"Custom field 38","example":"EU only"},"custom_field_39":{"type":"string","description":"Custom field 39","example":"EU only"},"custom_field_40":{"type":"string","description":"Custom field 40","example":"EU only"},"custom_field_41":{"type":"string","description":"Custom field 41","example":"EU only"},"custom_field_42":{"type":"string","description":"Custom field 42","example":"EU only"},"custom_field_43":{"type":"string","description":"Custom field 43","example":"EU only"},"custom_field_44":{"type":"string","description":"Custom field 44","example":"EU only"},"custom_field_45":{"type":"string","description":"Custom field 45","example":"EU only"},"custom_field_46":{"type":"string","description":"Custom field 46","example":"EU only"},"custom_field_47":{"type":"string","description":"Custom field 47","example":"EU only"},"custom_field_48":{"type":"string","description":"Custom field 48","example":"EU only"},"custom_field_49":{"type":"string","description":"Custom field 49","example":"EU only"},"custom_field_50":{"type":"string","description":"Custom field 50","example":"EU only"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000},"custom_metric_6":{"type":"number","description":"Custom metric 6","example":150},"custom_metric_7":{"type":"number","description":"Custom metric 7","example":1000},"custom_metric_8":{"type":"number","description":"Custom metric 8","example":2.52},"custom_metric_9":{"type":"number","description":"Custom metric 9","example":1.5},"custom_metric_10":{"type":"number","description":"Custom metric 10","example":2000}},"required":["product_id","product_name"]},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"object","properties":{"customer_id":{"type":"string","description":"Customer ID","example":"32"},"customer_name":{"type":"string","description":"Customer Name","example":"John Smith"},"customer_company":{"type":"string","description":"Customer Company","example":"Smith Industries"},"customer_email":{"type":"string","description":"Customer Email","example":"john.smith@customer.customer"},"customer_phone":{"type":"string","description":"Customer Phone","example":"+35811111111"},"customer_address":{"type":"string","description":"Customer Street Address","example":"Mannerheimintie 1"},"customer_zipcode":{"type":"string","description":"Customer's Zip Code","example":"00100"},"customer_city":{"type":"string","description":"Customer City","example":"Helsinki"},"customer_country":{"type":"string","description":"Customer Country","example":"Finland"},"account_number":{"type":"string","description":"45 (string, optional) - Account number","example":"123"},"vat_number":{"type":"string","description":"9 (string, optional) - VAT Number","example":"12345678"},"organisation_id":{"type":"string","description":"Customer account store ID","example":"1"},"salesperson_id":{"type":"string","description":"Customer account sales person ID","example":"3"},"creation_date":{"type":"string","description":"Date when this customer was added to system (yyyy-mm-dd).","example":"2021-12-15"},"subscribe_date":{"type":"string","description":"Date when this customer subscribed newsletter (yyyy-mm-dd).","example":"2022-01-15"},"unsubscribe_date":{"type":"string","description":"Date when this customer unsubscribed newsletter (yyyy-mm-dd).","example":"2022-02-15"},"register_date":{"type":"string","description":"Date when this customer registered to system (yyyy-mm-dd).","example":"2022-01-10"},"unregister_date":{"type":"string","description":"Date when this customer unregistered from system (yyyy-mm-dd).","example":"2022-03-15"},"custom_dimension_1":{"type":"string","description":"Custom Field 1","example":"Class 3"},"custom_dimension_2":{"type":"string","description":"Custom Field 2","example":"Class 3"},"custom_dimension_3":{"type":"string","description":"Custom Field 3","example":"Class 3"},"custom_dimension_4":{"type":"string","description":"Custom Field 4","example":"Class 3"},"custom_dimension_5":{"type":"string","description":"Custom Field 5","example":"Class 3"},"custom_dimension_6":{"type":"string","description":"Custom Field 6","example":"Class 3"},"custom_dimension_7":{"type":"string","description":"Custom Field 7","example":"Class 3"},"custom_dimension_8":{"type":"string","description":"Custom Field 8","example":"Class 3"},"custom_dimension_9":{"type":"string","description":"Custom Field 9","example":"Class 3"},"custom_dimension_10":{"type":"string","description":"Custom Field 10","example":"Class 3"},"custom_dimension_11":{"type":"string","description":"Custom Field 11","example":"Class 3"},"custom_dimension_12":{"type":"string","description":"Custom Field 12","example":"Class 3"},"custom_dimension_13":{"type":"string","description":"Custom Field 13","example":"Class 3"},"custom_dimension_14":{"type":"string","description":"Custom Field 14","example":"Class 3"},"custom_dimension_15":{"type":"string","description":"Custom Field 15","example":"Class 3"},"custom_dimension_16":{"type":"string","description":"Custom Field 16","example":"Class 3"},"custom_dimension_17":{"type":"string","description":"Custom Field 17","example":"Class 3"},"custom_dimension_18":{"type":"string","description":"Custom Field 18","example":"Class 3"},"custom_dimension_19":{"type":"string","description":"Custom Field 19","example":"Class 3"},"custom_dimension_20":{"type":"string","description":"Custom Field 20","example":"Class 3"},"custom_dimension_21":{"type":"string","description":"Custom Field 21","example":"Class 3"},"custom_dimension_22":{"type":"string","description":"Custom Field 22","example":"Class 3"},"custom_dimension_23":{"type":"string","description":"Custom Field 23","example":"Class 3"},"custom_dimension_24":{"type":"string","description":"Custom Field 24","example":"Class 3"},"custom_dimension_25":{"type":"string","description":"Custom Field 25","example":"Class 3"},"custom_dimension_26":{"type":"string","description":"Custom Field 26","example":"Class 3"},"custom_dimension_27":{"type":"string","description":"Custom Field 27","example":"Class 3"},"custom_dimension_28":{"type":"string","description":"Custom Field 28","example":"Class 3"},"custom_dimension_29":{"type":"string","description":"Custom Field 29","example":"Class 3"},"custom_dimension_30":{"type":"string","description":"Custom Field 30","example":"Class 3"},"custom_dimension_31":{"type":"string","description":"Custom Field 31","example":"Class 3"},"custom_dimension_32":{"type":"string","description":"Custom Field 32","example":"Class 3"},"custom_dimension_33":{"type":"string","description":"Custom Field 33","example":"Class 3"},"custom_dimension_34":{"type":"string","description":"Custom Field 34","example":"Class 3"},"custom_dimension_35":{"type":"string","description":"Custom Field 35","example":"Class 3"},"custom_dimension_36":{"type":"string","description":"Custom Field 36","example":"Class 3"},"custom_dimension_37":{"type":"string","description":"Custom Field 37","example":"Class 3"},"custom_dimension_38":{"type":"string","description":"Custom Field 38","example":"Class 3"},"custom_dimension_39":{"type":"string","description":"Custom Field 39","example":"Class 3"},"custom_dimension_40":{"type":"string","description":"Custom Field 40","example":"Class 3"},"custom_dimension_41":{"type":"string","description":"Custom Field 41","example":"Class 3"},"custom_dimension_42":{"type":"string","description":"Custom Field 42","example":"Class 3"},"custom_dimension_43":{"type":"string","description":"Custom Field 43","example":"Class 3"},"custom_dimension_44":{"type":"string","description":"Custom Field 44","example":"Class 3"},"custom_dimension_45":{"type":"string","description":"Custom Field 45","example":"Class 3"},"custom_dimension_46":{"type":"string","description":"Custom Field 46","example":"Class 3"},"custom_dimension_47":{"type":"string","description":"Custom Field 47","example":"Class 3"},"custom_dimension_48":{"type":"string","description":"Custom Field 48","example":"Class 3"},"custom_dimension_49":{"type":"string","description":"Custom Field 49","example":"Class 3"},"custom_dimension_50":{"type":"string","description":"Custom Field 50","example":"Class 3"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["customer_id"]},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"object","properties":{"organisation_id":{"type":"string","description":"Organisation / Store ID","example":"540"},"organisation_name":{"type":"string","description":"Organisation name","example":"Web Sales"},"area":{"type":"string","description":"Sales area","example":"South"},"latitude":{"type":"number","description":"Latitude","example":60.184014},"longitude":{"type":"number","description":"Longitude","example":24.960046},"channel":{"type":"string","description":"Sales channel","example":"Concession"},"floor_area":{"type":"number","description":"Store area eg. in m2","example":250},"no_customer_seats":{"type":"number","description":"Number of customer seats in store","example":150},"organisation_type":{"type":"string","description":"Outlet / Brand / Essential","example":"Outlet"},"organisation_group":{"type":"string","description":"Organisation group","example":"A"},"google_location_url":{"type":"string","description":"Google review location URL","example":"https://www.google.com/maps/reviews?data=XYZ"},"image_url":{"type":"string","description":"Url for external store image file","example":"http://example.com?product=XYZ"},"store_status":{"type":"string","description":"Status of store","enum":["open","closed","temporarily_closed"],"x-enumDescriptions":{"open":"Store is open and active","closed":"Store has been closed down permanently","temporarily_closed":"Store has been closed temporarily"},"example":"closed"},"custom_dimension1":{"type":"string","description":"Custom Field 1","example":"Class 3"},"custom_dimension2":{"type":"string","description":"Custom Field 2","example":"Class 3"},"custom_dimension3":{"type":"string","description":"Custom Field 3","example":"Class 3"},"custom_dimension4":{"type":"string","description":"Custom Field 4","example":"Class 3"},"custom_dimension5":{"type":"string","description":"Custom Field 5","example":"Class 3"}},"required":["organisation_id","organisation_name"]},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"object","properties":{"department_id":{"type":"string","description":"Department ID","example":"5401"},"name":{"type":"string","description":"Department name","example":"Web Sales"},"floor_area":{"type":"number","description":"Department area in m2","example":100},"organisation_id":{"type":"string","description":"Organisation / store this department belongs to","example":"540"},"no_customer_seats":{"type":"number","description":"Number of customer seats available","example":150},"custom_dimension1":{"type":"string","description":"Custom Field 1","example":"Class 3"},"custom_dimension2":{"type":"string","description":"Custom Field 2","example":"Class 3"},"custom_dimension3":{"type":"string","description":"Custom Field 3","example":"Class 3"},"custom_dimension4":{"type":"string","description":"Custom Field 4","example":"Class 3"},"custom_dimension5":{"type":"string","description":"Custom Field 5","example":"Class 3"}},"required":["department_id","name"]},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"object","properties":{"salesperson_id":{"type":"string","description":"Sales person ID","example":"5402101"},"salesperson_name":{"type":"string","description":"Sales person name","example":"John Smith"},"salesperson_email":{"type":"string","description":"Sales person email","example":"john.smith@store.store"},"salesperson_phone":{"type":"string","description":"Sales person phone number","example":"+35811111111"},"employment_start":{"type":"string","description":"Employment start date","example":"2020-01-01"},"employment_end":{"type":"string","description":"Employment end date","example":"2020-05-31"},"custom_field_1":{"type":"string","description":"Custom Field 1","example":"Project worker"},"custom_field_2":{"type":"string","description":"Custom Field 2","example":"Project worker"},"custom_field_3":{"type":"string","description":"Custom Field 3","example":"Project worker"},"custom_field_4":{"type":"string","description":"Custom Field 4","example":"Project worker"},"custom_field_5":{"type":"string","description":"Custom Field 5","example":"Project worker"},"custom_metric_1":{"type":"number","description":"Custom metric 1","example":1},"custom_metric_2":{"type":"number","description":"Custom metric 2","example":100},"custom_metric_3":{"type":"number","description":"Custom metric 3","example":2.2},"custom_metric_4":{"type":"number","description":"Custom metric 4","example":1.05},"custom_metric_5":{"type":"number","description":"Custom metric 5","example":10000}},"required":["salesperson_id"]},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"object","properties":{"register_id":{"type":"string","description":"Register ID","example":"123-1"},"register_name":{"type":"string","description":"Register name","example":"Kiosk 1"},"organisation_id":{"type":"string","description":"Organisation / store this register belongs to","example":"540"},"register_type":{"type":"string","description":"Register type","example":"Kiosk"},"register_group":{"type":"string","description":"Register group","example":"Self service"},"custom_dimension1":{"type":"string","description":"Custom Field 1","example":"Class 3"},"custom_dimension2":{"type":"string","description":"Custom Field 2","example":"Class 3"},"custom_dimension3":{"type":"string","description":"Custom Field 3","example":"Class 3"},"custom_dimension4":{"type":"string","description":"Custom Field 4","example":"Class 3"},"custom_dimension5":{"type":"string","description":"Custom Field 5","example":"Class 3"}},"required":["register_id","register_name"]},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"object","properties":{"account_id":{"type":"string","description":"Account ID","example":"1150"},"account_name":{"type":"string","description":"Account name","example":"Employee Salaries"},"account_type":{"type":"string","description":"Account type","example":"Salaries"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"}},"required":["account_id","account_name"]},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"object","properties":{"event_id":{"type":"string","description":"Event ID","example":"1150"},"event_name":{"type":"string","description":"Event name","example":"Rock around the clock"},"event_type":{"type":"string","description":"Event type","example":"Concert"},"venue_name":{"type":"string","description":"Venue name","example":"Arena 1"},"custom_field_1":{"type":"string","description":"Custom field 1","example":"EU only"},"custom_field_2":{"type":"string","description":"Custom field 2","example":"EU only"},"custom_field_3":{"type":"string","description":"Custom field 3","example":"EU only"},"custom_field_4":{"type":"string","description":"Custom field 4","example":"EU only"},"custom_field_5":{"type":"string","description":"Custom field 5","example":"EU only"}},"required":["event_id","event_name"]},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"object","properties":{"hierarchy_name":{"type":"string","description":"Hierarchy name","example":"product"},"category_id":{"type":"string","description":"Category ID","example":"123"},"category_name":{"type":"string","description":"Category name","example":"Shoes"},"parent_id":{"type":"string","description":"Category parent ID","example":"12"}},"required":["hierarchy_name","category_id","category_name"]},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"object","properties":{"hierarchy_key":{"type":"string","description":"Type of hierarchy that is uploaded","enum":["product","model","product_group","organisation","customer","channel","area","account"],"x-enumDescriptions":{"product":"Product category hierarchy","model":"Product model hierarchy","product_group":"Product group hierarchy","organisation":"Organisation hierarchy","customer":"Customer hierarchy","channel":"Channel hierarchy","area":"Area hierarchy","account":"Bookkeeping account hierarchy"},"example":"product"},"entity_id":{"type":"string","description":"Identifier for the lowest level entity in the hierarchy","example":"XYZ"},"level1":{"type":"string","description":"Name of root category level","example":"Clothing"},"level2":{"type":"string","description":"Name of category level 2","example":"Children's clothing"},"level3":{"type":"string","description":"Name of category level 3","example":"Children's outdoor clothing"},"level4":{"type":"string","description":"Name of category level 4","example":"Children's outdoor headwear"},"level5":{"type":"string","description":"Name of category level 5","example":"Children's caps"},"level6":{"type":"string","description":"Name of category level 6","example":"Children's small caps"},"level7":{"type":"string","description":"Name of category level 7","example":"Children's themed caps"},"level8":{"type":"string","description":"Name of category level 8","example":"Children's disney caps"},"level9":{"type":"string","description":"Name of category level 9","example":"Children's mickey caps"},"level10":{"type":"string","description":"Name of category level 10","example":"Children's ..."}},"required":["hierarchy_key","entity_id","level1"]},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"object","properties":{"counter_id":{"type":"string","description":"Counter ID","example":"5"},"counter_name":{"type":"string","description":"Counter name","example":"Front door 1"},"folder_id: front_door_1":{"type":"string","description":"Name of identification folder","example":""},"serial":{"type":"string","description":"Camera serial number","example":"ABCDE12345"},"registration_code":{"type":"string","description":"Camera registration code","example":"A1B2C3D4E5"},"disabled":{"type":"boolean","description":"True if the counter is disabled (i.e. is set to not send data)","example":false},"is_queue":{"type":"boolean","description":"True if the counter is a queue counter","example":false},"on_store_perimeter":{"type":"boolean","description":"True, if this a store perimeter camera","example":true},"organisation_id: my_organisation_id":{"type":"string","description":"Id of the store/organisation where the camera is located"},"department_id: my_department_id":{"type":"string","description":"Id of the department where the camera is located"},"department_reversed_id":{"type":"string","description":"Secondary department id where in and out counts are reversed.","example":"reverse_id"}},"required":["counter_id","counter_name","disabled"]},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"object","properties":{"campaign_id":{"type":"string","description":"Campaign ID","example":"6344"},"campaign_name":{"type":"string","description":"Campaign name","example":"February 2016"},"campaign_type":{"type":"string","description":"Campaign type","example":"Web"},"start_date":{"type":"string","description":"Campaign Start Date (yyyy-mm-dd)","example":"2016-02-01"},"end_date":{"type":"string","description":"Campaign End Date (yyyy-mm-dd)","example":"2016-02-29"},"custom_field_1":{"type":"string","description":"Custom Field 1","example":"New"},"custom_field_2":{"type":"string","description":"Custom Field 2","example":"New"},"custom_field_3":{"type":"string","description":"Custom Field 3","example":"New"},"custom_field_4":{"type":"string","description":"Custom Field 4","example":"New"},"custom_field_5":{"type":"string","description":"Custom Field 5","example":"Old"}},"required":["campaign_id","campaign_name"]},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"object","properties":{"payment_type_id":{"type":"string","description":"Payment Type ID","example":"1"},"payment_type":{"type":"string","description":"Payment type name","example":"credit card"},"payment_group":{"type":"string","description":"Payment group","example":"Store"},"custom_field_1":{"type":"string","description":"Custom Field 1","example":"App"},"custom_field_2":{"type":"string","description":"Custom Field 2","example":"App"},"custom_field_3":{"type":"string","description":"Custom Field 3","example":"App"},"custom_field_4":{"type":"string","description":"Custom Field 4","example":"App"},"custom_field_5":{"type":"string","description":"Custom Field 5","example":"App"}},"required":["payment_type_id","payment_type"]},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"object","properties":{"rebate_code_id":{"type":"string","description":"Rebate Code ID","example":"3313V"},"rebate_code_name":{"type":"string","description":"Description of the reason","example":"Model product"}},"required":["rebate_code_id","rebate_code_name"]},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"object","properties":{"supplier_id":{"type":"string","description":"Supplier ID","example":"221"},"supplier_name":{"type":"string","description":"Supplier name","example":"WasSuppliers"},"supplier_email":{"type":"string","description":"Supplier Email","example":"john.smith@supplier.supplier"},"supplier_phone":{"type":"string","description":"Supplier phone number","example":"+3581111111"},"supplier_address":{"type":"string","description":"Street address","example":"Mannerheimintie 1"},"supplier_city":{"type":"string","description":"City","example":"Helsinki"},"supplier_zipcode":{"type":"string","description":"Postal code","example":"00100"},"supplier_country":{"type":"string","description":"Country","example":"Finland"},"supplier_type":{"type":"string","description":"Supplier type","example":"Local"},"supplier_group":{"type":"string","description":"Supplier group","example":"Strategic Supplier"},"custom_field_1":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_2":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_3":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_4":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"},"custom_field_5":{"type":"string","description":"Field that can be used for custom dimensions","example":"XYZ"}},"required":["supplier_id"]},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"object","properties":{"period_key":{"type":"string","description":"Period type identifier","example":"season"},"period_year":{"type":"number","description":"Period year","example":2018},"period_name":{"type":"string","description":"Name of period","example":"Autumn Season"},"period_number":{"type":"number","description":"period numeric id","example":2},"start_date":{"type":"string","description":"Start date of period","example":"2018-07-01"},"end_date":{"type":"string","description":"End date of period","example":"2018-12-31"}},"required":["period_key","period_year","period_name","period_number","start_date","end_date"]},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"object","properties":{"calendar_date":{"type":"string","description":"Calendar date","example":"2019-01-01"},"calendar_year":{"type":"string","description":"Calendar period year name","example":"2018/2019"},"period_name":{"type":"string","description":"Name of period","example":"January"},"period_number":{"type":"number","description":"period numeric id","example":2},"week_number":{"type":"number","description":"Week number of period","example":9},"season":{"type":"string","description":"Season name","example":"Spring 2019"},"season_label":{"type":"string","description":"Season label","example":"Spring"},"lfl_date":{"type":"string","description":"Comparison (LFL) date last year period","example":"2018-01-02"},"bank_holiday_name":{"type":"string","description":"Bank holiday name","example":"New Year"}},"required":["calendar_date"]},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"object","properties":{"source_currency":{"type":"string","description":"Source currency as ISO 4217 currency code.","example":"EUR"},"target_currency":{"type":"string","description":"Target currency as ISO 4217 currency code.","example":"SEK"},"valid_from":{"type":"string","description":"First day when the exchange rate is valid","example":"2017-01-01"},"valid_to":{"type":"string","description":"Last day when the exchange rate is valid","example":"2017-12-31"},"rate":{"type":"number","description":"Exchange rate to from source to target currency","example":0.1123}},"required":["source_currency","target_currency","valid_from","valid_to","rate"]},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"object","properties":{"year":{"type":"number","description":"Year this budget entry refers to","example":2019},"month":{"type":"number","description":"Month this budget entry refers to. Either month or week must be specified.","example":1},"week":{"type":"number","description":"Week this budget entry refers to. Either month or week must be specified.","example":12},"day":{"type":"number","description":"Optional day this budget entry refers to","example":1},"hour":{"type":"number","description":"Optional hour this budget refers to. Day must be also specified if hour is specified.","example":12},"label":{"type":"string","description":"Label (type) this budget has","example":"forecast"},"dimensions":{"type":"object","properties":{},"description":"Key-value pairs of dimensions and values for entry","example":{}},"metrics":{"type":"object","properties":{},"description":"Key-value pairs of metric values for given time and dimensions","example":{}}},"required":["year","dimensions","metrics"]},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"object","properties":{"context":{"type":"object","properties":{"locale":{"type":"string","description":"Locale for the results","example":"en"},"currency":{"type":"string","description":"Currency for returned monetary values","example":"EUR"}},"description":"Context for the queries","example":{"locale":"en","currency":"EUR"}},"query":{"type":"object","properties":{"grouping":{"type":"array","description":"Dimensions to group over","items":{},"example":["day","store"]},"metrics":{"type":"array","description":"Metrics that should be returned","items":{},"example":["sales","sales_margin"]},"filters":{"type":"object","properties":{},"example":{}},"seriesType":{"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 result series. Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual"},"children":[]}]}]}],"example":"actual"},"sort":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields to use for sorting the results. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the field name reverses sort order"},"children":[]}]}]}],"items":{},"example":["day"]},"limit":{"type":"number","description":"Amount of rows to return","example":1000},"offset":{"type":"number","description":"Starting index for returned rows","example":0},"label":{"type":"string","description":"Optional label used with budget series type to select which budget to fetch.","example":"forecast"},"fillTimeSeries":{"type":"boolean","description":"Fill empty time gaps (days, hours etc.) in time series with either zeroes or in case of sparse metrics with previous value","example":true}},"required":["grouping","metrics"],"description":"Query parameters","example":{"grouping":["day","store"],"metrics":["sales","sales_margin"],"filters":{},"seriesType":"actual","sort":["day"],"limit":1000,"offset":0,"label":"forecast","fillTimeSeries":true}}},"example":{"context":{"locale":"en","currency":"EUR"},"query":{"grouping":["day","store"],"metrics":["sales","sales_margin"],"filters":{},"seriesType":"actual","sort":["day"],"limit":1000,"offset":0,"label":"forecast","fillTimeSeries":true}}},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"dimensions":{"type":"object","description":"All dimensions from grouping list","properties":{"day":{"type":"object","properties":{"id":{"type":"string","description":"Identifier for the dimension entry","example":"20170101"},"name":{"type":"string","description":"Human visible name for the dimension entry","example":"2017-01-01"}}},"store":{"type":"object","properties":{"id":{"type":"string","description":"Identifier for the dimension entry","example":"Helsinki"},"name":{"type":"string","description":"Human visible name for the dimension entry","example":"Helsinki"}}}}},"metrics":{"type":"object","description":"Aggregated metric values for set of dimensions","properties":{"sales":{"type":"number","example":10000},"sales_margin":{"type":"number","example":2000}}},"sort":{"type":"object","description":"List of items (dimension and metrics from above) to be used for sorting","properties":{"day":{"type":"string"},"store":{"type":"string"}}}}}},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"object","properties":{"X-Zoined-Total-Items":{"type":"string","example":"30"},"X-Zoined-Limit":{"type":"string","example":"1000"},"X-Zoined-Offset":{"type":"string","example":"0"}}},"id":"schema_86"}},"exampleStore":{"paths/~1sales/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1sales/post/responses/200/content/application~1json/examples/response"},"paths/~1sales/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1sales/post/responses/400/content/application~1json/examples/response"},"paths/~1sales/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1sales/post/responses/401/content/application~1json/examples/response"},"paths/~1sales/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1sales/post/responses/500/content/application~1json/examples/response"},"paths/~1products/post/requestBody/content/text~1csv/examples/categoryId":{"value":"product_id;product_name;product_description;category_id;purchase_price;vat_rate;unit_of_measure;product_size;product_color;product_type;product_season;model;model_number;country_of_origin;freight;supplier_id;fabric;\nXYZ;Widget XYZ;Best performance XYZ on the market;23;10;24;PCS;XS;Dark Blue;Type A;Spring;XYZ B40;X311;Moldovia;5;221;Felt;\n","key":"categoryId","summary":"Category defined with category_id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this format when the product is linked to an existing category"},"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":"category_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1products/post/requestBody/content/text~1csv/examples/categoryId"},"paths/~1products/post/requestBody/content/text~1csv/examples/categoryLevelsInline":{"value":"product_id;product_name;product_description;purchase_price;vat_rate;unit_of_measure;product_size;product_color;product_type;product_season;model;model_number;country_of_origin;freight;supplier_id;fabric\nXYZ;Widget XYZ;Best performance XYZ on the market;10;24;PCS;XS;Dark Blue;Type A;Spring;XYZ B40;X311;Moldovia;5;221;Felt\n","key":"categoryLevelsInline","summary":"Category levels defined inline","description":"Use this format when the product category hierarchy is defined\ndirectly in the product data.\n","id":"paths/~1products/post/requestBody/content/text~1csv/examples/categoryLevelsInline"},"paths/~1products/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1products/post/responses/200/content/application~1json/examples/response"},"paths/~1products/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1products/post/responses/400/content/application~1json/examples/response"},"paths/~1products/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1products/post/responses/401/content/application~1json/examples/response"},"paths/~1products/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1products/post/responses/500/content/application~1json/examples/response"},"paths/~1customers/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1customers/post/responses/200/content/application~1json/examples/response"},"paths/~1customers/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1customers/post/responses/400/content/application~1json/examples/response"},"paths/~1customers/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1customers/post/responses/401/content/application~1json/examples/response"},"paths/~1customers/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1customers/post/responses/500/content/application~1json/examples/response"},"paths/~1customerFeedbacks/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1customerFeedbacks/post/responses/200/content/application~1json/examples/response"},"paths/~1customerFeedbacks/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1customerFeedbacks/post/responses/400/content/application~1json/examples/response"},"paths/~1customerFeedbacks/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1customerFeedbacks/post/responses/401/content/application~1json/examples/response"},"paths/~1customerFeedbacks/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1customerFeedbacks/post/responses/500/content/application~1json/examples/response"},"paths/~1cashierBalance/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1cashierBalance/post/responses/200/content/application~1json/examples/response"},"paths/~1cashierBalance/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1cashierBalance/post/responses/400/content/application~1json/examples/response"},"paths/~1cashierBalance/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1cashierBalance/post/responses/401/content/application~1json/examples/response"},"paths/~1cashierBalance/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1cashierBalance/post/responses/500/content/application~1json/examples/response"},"paths/~1organisations/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1organisations/post/responses/200/content/application~1json/examples/response"},"paths/~1organisations/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1organisations/post/responses/400/content/application~1json/examples/response"},"paths/~1organisations/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1organisations/post/responses/401/content/application~1json/examples/response"},"paths/~1organisations/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1organisations/post/responses/500/content/application~1json/examples/response"},"paths/~1departments/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1departments/post/responses/200/content/application~1json/examples/response"},"paths/~1departments/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1departments/post/responses/400/content/application~1json/examples/response"},"paths/~1departments/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1departments/post/responses/401/content/application~1json/examples/response"},"paths/~1departments/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1departments/post/responses/500/content/application~1json/examples/response"},"paths/~1salesPersons/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1salesPersons/post/responses/200/content/application~1json/examples/response"},"paths/~1salesPersons/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesPersons/post/responses/400/content/application~1json/examples/response"},"paths/~1salesPersons/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1salesPersons/post/responses/401/content/application~1json/examples/response"},"paths/~1salesPersons/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesPersons/post/responses/500/content/application~1json/examples/response"},"paths/~1cashRegisters/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1cashRegisters/post/responses/200/content/application~1json/examples/response"},"paths/~1cashRegisters/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1cashRegisters/post/responses/400/content/application~1json/examples/response"},"paths/~1cashRegisters/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1cashRegisters/post/responses/401/content/application~1json/examples/response"},"paths/~1cashRegisters/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1cashRegisters/post/responses/500/content/application~1json/examples/response"},"paths/~1openHours/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1openHours/post/responses/200/content/application~1json/examples/response"},"paths/~1openHours/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1openHours/post/responses/400/content/application~1json/examples/response"},"paths/~1openHours/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1openHours/post/responses/401/content/application~1json/examples/response"},"paths/~1openHours/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1openHours/post/responses/500/content/application~1json/examples/response"},"paths/~1counters/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1counters/post/responses/200/content/application~1json/examples/response"},"paths/~1counters/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1counters/post/responses/400/content/application~1json/examples/response"},"paths/~1counters/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1counters/post/responses/401/content/application~1json/examples/response"},"paths/~1counters/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1counters/post/responses/500/content/application~1json/examples/response"},"paths/~1accounts/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1accounts/post/responses/200/content/application~1json/examples/response"},"paths/~1accounts/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1accounts/post/responses/400/content/application~1json/examples/response"},"paths/~1accounts/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1accounts/post/responses/401/content/application~1json/examples/response"},"paths/~1accounts/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1accounts/post/responses/500/content/application~1json/examples/response"},"paths/~1events/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1events/post/responses/200/content/application~1json/examples/response"},"paths/~1events/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1events/post/responses/400/content/application~1json/examples/response"},"paths/~1events/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1events/post/responses/401/content/application~1json/examples/response"},"paths/~1events/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1events/post/responses/500/content/application~1json/examples/response"},"paths/~1calendar/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1calendar/post/responses/200/content/application~1json/examples/response"},"paths/~1calendar/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1calendar/post/responses/400/content/application~1json/examples/response"},"paths/~1calendar/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1calendar/post/responses/401/content/application~1json/examples/response"},"paths/~1calendar/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1calendar/post/responses/500/content/application~1json/examples/response"},"paths/~1campaigns/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1campaigns/post/responses/200/content/application~1json/examples/response"},"paths/~1campaigns/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1campaigns/post/responses/400/content/application~1json/examples/response"},"paths/~1campaigns/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1campaigns/post/responses/401/content/application~1json/examples/response"},"paths/~1campaigns/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1campaigns/post/responses/500/content/application~1json/examples/response"},"paths/~1campaignProducts/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1campaignProducts/post/responses/200/content/application~1json/examples/response"},"paths/~1campaignProducts/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1campaignProducts/post/responses/400/content/application~1json/examples/response"},"paths/~1campaignProducts/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1campaignProducts/post/responses/401/content/application~1json/examples/response"},"paths/~1campaignProducts/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1campaignProducts/post/responses/500/content/application~1json/examples/response"},"paths/~1salesCampaigns/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1salesCampaigns/post/responses/200/content/application~1json/examples/response"},"paths/~1salesCampaigns/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesCampaigns/post/responses/400/content/application~1json/examples/response"},"paths/~1salesCampaigns/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1salesCampaigns/post/responses/401/content/application~1json/examples/response"},"paths/~1salesCampaigns/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesCampaigns/post/responses/500/content/application~1json/examples/response"},"paths/~1currencyRates/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1currencyRates/post/responses/200/content/application~1json/examples/response"},"paths/~1currencyRates/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1currencyRates/post/responses/400/content/application~1json/examples/response"},"paths/~1currencyRates/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1currencyRates/post/responses/401/content/application~1json/examples/response"},"paths/~1currencyRates/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1currencyRates/post/responses/500/content/application~1json/examples/response"},"paths/~1workShifts/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1workShifts/post/responses/200/content/application~1json/examples/response"},"paths/~1workShifts/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1workShifts/post/responses/400/content/application~1json/examples/response"},"paths/~1workShifts/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1workShifts/post/responses/401/content/application~1json/examples/response"},"paths/~1workShifts/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1workShifts/post/responses/500/content/application~1json/examples/response"},"paths/~1employeeHours/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1employeeHours/post/responses/200/content/application~1json/examples/response"},"paths/~1employeeHours/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1employeeHours/post/responses/400/content/application~1json/examples/response"},"paths/~1employeeHours/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1employeeHours/post/responses/401/content/application~1json/examples/response"},"paths/~1employeeHours/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1employeeHours/post/responses/500/content/application~1json/examples/response"},"paths/~1staffCosts/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1staffCosts/post/responses/200/content/application~1json/examples/response"},"paths/~1staffCosts/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1staffCosts/post/responses/400/content/application~1json/examples/response"},"paths/~1staffCosts/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1staffCosts/post/responses/401/content/application~1json/examples/response"},"paths/~1staffCosts/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1staffCosts/post/responses/500/content/application~1json/examples/response"},"paths/~1inventorySnapshots/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1inventorySnapshots/post/responses/200/content/application~1json/examples/response"},"paths/~1inventorySnapshots/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1inventorySnapshots/post/responses/400/content/application~1json/examples/response"},"paths/~1inventorySnapshots/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1inventorySnapshots/post/responses/401/content/application~1json/examples/response"},"paths/~1inventorySnapshots/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1inventorySnapshots/post/responses/500/content/application~1json/examples/response"},"paths/~1inventoryTransactions/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1inventoryTransactions/post/responses/200/content/application~1json/examples/response"},"paths/~1inventoryTransactions/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1inventoryTransactions/post/responses/400/content/application~1json/examples/response"},"paths/~1inventoryTransactions/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1inventoryTransactions/post/responses/401/content/application~1json/examples/response"},"paths/~1inventoryTransactions/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1inventoryTransactions/post/responses/500/content/application~1json/examples/response"},"paths/~1capacity/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1capacity/post/responses/200/content/application~1json/examples/response"},"paths/~1capacity/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1capacity/post/responses/400/content/application~1json/examples/response"},"paths/~1capacity/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1capacity/post/responses/401/content/application~1json/examples/response"},"paths/~1capacity/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1capacity/post/responses/500/content/application~1json/examples/response"},"paths/~1flatHierarchies/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1flatHierarchies/post/responses/200/content/application~1json/examples/response"},"paths/~1flatHierarchies/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1flatHierarchies/post/responses/400/content/application~1json/examples/response"},"paths/~1flatHierarchies/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1flatHierarchies/post/responses/401/content/application~1json/examples/response"},"paths/~1flatHierarchies/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1flatHierarchies/post/responses/500/content/application~1json/examples/response"},"paths/~1productHierarchies/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1productHierarchies/post/responses/200/content/application~1json/examples/response"},"paths/~1productHierarchies/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1productHierarchies/post/responses/400/content/application~1json/examples/response"},"paths/~1productHierarchies/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1productHierarchies/post/responses/401/content/application~1json/examples/response"},"paths/~1productHierarchies/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1productHierarchies/post/responses/500/content/application~1json/examples/response"},"paths/~1rebateCodes/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1rebateCodes/post/responses/200/content/application~1json/examples/response"},"paths/~1rebateCodes/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1rebateCodes/post/responses/400/content/application~1json/examples/response"},"paths/~1rebateCodes/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1rebateCodes/post/responses/401/content/application~1json/examples/response"},"paths/~1rebateCodes/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1rebateCodes/post/responses/500/content/application~1json/examples/response"},"paths/~1paymentTypes/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1paymentTypes/post/responses/200/content/application~1json/examples/response"},"paths/~1paymentTypes/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1paymentTypes/post/responses/400/content/application~1json/examples/response"},"paths/~1paymentTypes/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1paymentTypes/post/responses/401/content/application~1json/examples/response"},"paths/~1paymentTypes/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1paymentTypes/post/responses/500/content/application~1json/examples/response"},"paths/~1purchaseOrders/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1purchaseOrders/post/responses/200/content/application~1json/examples/response"},"paths/~1purchaseOrders/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1purchaseOrders/post/responses/400/content/application~1json/examples/response"},"paths/~1purchaseOrders/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1purchaseOrders/post/responses/401/content/application~1json/examples/response"},"paths/~1purchaseOrders/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1purchaseOrders/post/responses/500/content/application~1json/examples/response"},"paths/~1salesOffers/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1salesOffers/post/responses/200/content/application~1json/examples/response"},"paths/~1salesOffers/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesOffers/post/responses/400/content/application~1json/examples/response"},"paths/~1salesOffers/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1salesOffers/post/responses/401/content/application~1json/examples/response"},"paths/~1salesOffers/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesOffers/post/responses/500/content/application~1json/examples/response"},"paths/~1salesOrders/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1salesOrders/post/responses/200/content/application~1json/examples/response"},"paths/~1salesOrders/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesOrders/post/responses/400/content/application~1json/examples/response"},"paths/~1salesOrders/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1salesOrders/post/responses/401/content/application~1json/examples/response"},"paths/~1salesOrders/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesOrders/post/responses/500/content/application~1json/examples/response"},"paths/~1salesSummaries/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1salesSummaries/post/responses/200/content/application~1json/examples/response"},"paths/~1salesSummaries/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesSummaries/post/responses/400/content/application~1json/examples/response"},"paths/~1salesSummaries/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1salesSummaries/post/responses/401/content/application~1json/examples/response"},"paths/~1salesSummaries/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesSummaries/post/responses/500/content/application~1json/examples/response"},"paths/~1salesPayments/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1salesPayments/post/responses/200/content/application~1json/examples/response"},"paths/~1salesPayments/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesPayments/post/responses/400/content/application~1json/examples/response"},"paths/~1salesPayments/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1salesPayments/post/responses/401/content/application~1json/examples/response"},"paths/~1salesPayments/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1salesPayments/post/responses/500/content/application~1json/examples/response"},"paths/~1giftcardPayments/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1giftcardPayments/post/responses/200/content/application~1json/examples/response"},"paths/~1giftcardPayments/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1giftcardPayments/post/responses/400/content/application~1json/examples/response"},"paths/~1giftcardPayments/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1giftcardPayments/post/responses/401/content/application~1json/examples/response"},"paths/~1giftcardPayments/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1giftcardPayments/post/responses/500/content/application~1json/examples/response"},"paths/~1accounting/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1accounting/post/responses/200/content/application~1json/examples/response"},"paths/~1accounting/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1accounting/post/responses/400/content/application~1json/examples/response"},"paths/~1accounting/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1accounting/post/responses/401/content/application~1json/examples/response"},"paths/~1accounting/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1accounting/post/responses/500/content/application~1json/examples/response"},"paths/~1bookings/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1bookings/post/responses/200/content/application~1json/examples/response"},"paths/~1bookings/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1bookings/post/responses/400/content/application~1json/examples/response"},"paths/~1bookings/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1bookings/post/responses/401/content/application~1json/examples/response"},"paths/~1bookings/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1bookings/post/responses/500/content/application~1json/examples/response"},"paths/~1suppliers/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1suppliers/post/responses/200/content/application~1json/examples/response"},"paths/~1suppliers/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1suppliers/post/responses/400/content/application~1json/examples/response"},"paths/~1suppliers/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1suppliers/post/responses/401/content/application~1json/examples/response"},"paths/~1suppliers/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1suppliers/post/responses/500/content/application~1json/examples/response"},"paths/~1visitors/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1visitors/post/responses/200/content/application~1json/examples/response"},"paths/~1visitors/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1visitors/post/responses/400/content/application~1json/examples/response"},"paths/~1visitors/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1visitors/post/responses/401/content/application~1json/examples/response"},"paths/~1visitors/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1visitors/post/responses/500/content/application~1json/examples/response"},"paths/~1visitorDemographics/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1visitorDemographics/post/responses/200/content/application~1json/examples/response"},"paths/~1visitorDemographics/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1visitorDemographics/post/responses/400/content/application~1json/examples/response"},"paths/~1visitorDemographics/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1visitorDemographics/post/responses/401/content/application~1json/examples/response"},"paths/~1visitorDemographics/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1visitorDemographics/post/responses/500/content/application~1json/examples/response"},"paths/~1idMapping/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1idMapping/post/responses/200/content/application~1json/examples/response"},"paths/~1idMapping/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1idMapping/post/responses/400/content/application~1json/examples/response"},"paths/~1idMapping/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1idMapping/post/responses/401/content/application~1json/examples/response"},"paths/~1idMapping/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1idMapping/post/responses/500/content/application~1json/examples/response"},"paths/~1budgets~1{type}/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1budgets~1{type}/post/responses/200/content/application~1json/examples/response"},"paths/~1budgets~1{type}/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1budgets~1{type}/post/responses/400/content/application~1json/examples/response"},"paths/~1budgets~1{type}/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1budgets~1{type}/post/responses/401/content/application~1json/examples/response"},"paths/~1budgets~1{type}/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1budgets~1{type}/post/responses/500/content/application~1json/examples/response"},"paths/~1updateTime/post/responses/200/content/application~1json/examples/response":{"value":{"status":"OK","msg":"1 entity added"},"key":"response","summary":"response","id":"paths/~1updateTime/post/responses/200/content/application~1json/examples/response"},"paths/~1updateTime/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1updateTime/post/responses/400/content/application~1json/examples/response"},"paths/~1updateTime/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1updateTime/post/responses/401/content/application~1json/examples/response"},"paths/~1updateTime/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1updateTime/post/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1sales.json/get/responses/200/content/application~1json/examples/response":{"value":{"transaction_id":"242224","line_item_id":"1","customer_id":"32","delivery_customer_id":"35","sales_date":"2016-01-01","sales_time":"15:00:00","product_id":"XYZ","product_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"compensation_amount":3,"rebate":0,"rebate_wo_vat":0,"currency":"EUR","payment_method":"Visa","supplier_id":"13","parent_product_id":"123","purchase_price":5,"purchase_price_wo_vat":5,"organisation_id":"540","deparment_id":"5400","salesperson_id":"5402101","sales_representative_id":"5402100","campaign_id":"6344","delivery_date":"2016-01-01","delivery_time":"15:00:00","invoice_date":"2016-01-01","invoice_time":"15:00:00","register_id":"54022","table_number":"54","rebate_code_id":"3313V","booking_id":"B1224","booking_line_id":"1","event_id":"221","sales_order_id":"SO1234","sales_order_line_id":"1","parent_line_id":"1","custom_field_1":"extra info","custom_field_2":"extra info","custom_field_3":"extra info","custom_field_4":"extra info","custom_field_5":"extra info","custom_field_6":"extra info","custom_field_7":"extra info","custom_field_8":"extra info","custom_field_9":"extra info","custom_field_10":"extra info","custom_field_11":"extra info","custom_field_12":"extra info","custom_field_13":"extra info","custom_field_14":"extra info","custom_field_15":"extra info","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":1,"custom_metric_7":100,"custom_metric_8":2.2,"custom_metric_9":1.05,"custom_metric_10":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1sales.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1sales.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1sales.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1sales.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1sales.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1sales.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1sales.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1sales.csv/get/responses/200/content/application~1csv/examples/response":{"value":"transaction_id; line_item_id; customer_id; sales_date; sales_time; product_id; product_quantity; product_unit_price; sales_value; sales_value_wo_vat; rebate; rebate_wo_vat; sales_currency; payment_method; supplier_id; purchase_price; purchase_price_wo_vat; organisation_id; salesperson_id; delivery_date; delivery_time; invoice_date; invoice_time;  register_id; rebate_code_id\n242224 ; 1 ; 32 ; 2016-01-01 ; 15:00:00 ; XYZ ;2;10;20;20;0;0; EUR ; Visa ; 13 ;5;5; 540 ; 5402101 ; 6344 ; 2016-01-01 ; 15:00:00 ; 2016-01-01 ; 15:00:00 ; 54022 ; 3233V\n","key":"response","summary":"response","id":"paths/~1v2~1download~1sales.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1sales.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1sales.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1sales.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1sales.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1sales.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1sales.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOrders.json/get/responses/200/content/application~1json/examples/response":{"value":{"transaction_id":"er/232/f31","line_item_id":"1","customer_id":"32","delivery_customer_id":"35","product_id":"XYZ","product_quantity":2,"delivered_quantity":1,"planned_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"rebate":0,"rebate_wo_vat":0,"rebate_code_id":"3313V","currency":"EUR","payment_method":"Invoice 30","tender_amount":20,"deposit_amount":10,"supplier_id":"221","parent_product_id":"123","purchase_price":5,"purchase_price_wo_vat":5,"organisation_id":"540","department_id":"54011","salesperson_id":"5402101","order_date":"2016-01-01","order_time":"15:00:00","invoice_date":"2016-01-01","invoice_time":"15:00:00","arrival_date":"2016-01-03","arrival_time":"15:00:00","order_status":1,"order_type":"internal","gross_weight":123,"customer_order_number":"12345","sales_offer_id":"123","sales_offer_line_id":"1","custom_field_1":"extra info","custom_field_2":"extra info","custom_field_3":"extra info","custom_field_4":"extra info","custom_field_5":"extra info","custom_field_6":"extra info","custom_field_7":"extra info","custom_field_8":"extra info","custom_field_9":"extra info","custom_field_10":"extra info","custom_field_11":"extra info","custom_field_12":"extra info","custom_field_13":"extra info","custom_field_14":"extra info","custom_field_15":"extra info","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOrders.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOrders.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOrders.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOrders.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOrders.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOrders.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOrders.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOrders.csv/get/responses/200/content/application~1csv/examples/response":{"value":"transaction_id;line_item_id;customer_id;product_id;product_quantity;product_unit_price;sales_value;sales_value_wo_vat;rebate;rebate_wo_vat;sales_currency;payment_method;supplier_id;purchase_price;purchase_price_wo_vat;piece_good;organisation_id;salesperson_id;order_date;order_time;invoice_date;invoice_time;order_status\ner/232/f31; 1; 32; XYZ; 2; 10; 20; 20; 0; 0; EUR; Invoice 30; ; 5; 5; EUR; true; 540; 5402101; 2016-01-01; 15:00:00; 2016-01-01; 15:00:00; 1\n","key":"response","summary":"response","id":"paths/~1v2~1download~1salesOrders.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1salesOrders.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOrders.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOrders.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOrders.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOrders.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOrders.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOffers.json/get/responses/200/content/application~1json/examples/response":{"value":{"transaction_id":"er/232/f31","line_item_id":"1","customer_id":"32","product_id":"XYZ","supplier_id":"221","parent_product_id":"123","product_quantity":2,"product_unit_price":10,"sales_value":20,"sales_value_wo_vat":20,"rebate":0,"rebate_wo_vat":0,"purchase_price":5,"purchase_price_wo_vat":5,"currency":"EUR","organisation_id":"540","salesperson_id":"5402101","offer_date":"2016-01-01","offer_time":"15:00:00","valid_date":"2016-01-01","valid_time":"15:00:00","offer_status":1,"offer_type":"internal","custom_field_1":"extra info","custom_field_2":"extra info","custom_field_3":"extra info","custom_field_4":"extra info","custom_field_5":"extra info","custom_field_6":"extra info","custom_field_7":"extra info","custom_field_8":"extra info","custom_field_9":"extra info","custom_field_10":"extra info","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOffers.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOffers.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOffers.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOffers.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOffers.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOffers.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOffers.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOffers.csv/get/responses/200/content/application~1csv/examples/response":{"value":"transaction_id;line_item_id;customer_id;product_id;product_quantity;product_unit_price;sales_value;sales_value_wo_vat;rebate;rebate_wo_vat;currency;supplier_id;purchase_price;purchase_price_wo_vat;organisation_id;salesperson_id;offer_date;offer_time;valid_date;valid_time;offer_status;offer_type\ner/232/f31; 1; 32; XYZ; 2; 10; 20; 20; 0; 0; EUR; ; 5; 5; 540; 5402101; 2016-01-01; 15:00:00; 2016-01-01; 15:00:00; 1;internal\n","key":"response","summary":"response","id":"paths/~1v2~1download~1salesOffers.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1salesOffers.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOffers.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOffers.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOffers.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesOffers.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesOffers.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1purchaseOrders.json/get/responses/200/content/application~1json/examples/response":{"value":{"transaction_id":"er/232/f31","line_item_id":"1","product_id":"XYZ","supplier_id":"221","parent_product_id":"123","ordered_quantity":2,"delivered_quantity":2,"product_unit_price":2.5,"currency":"EUR","purchase_price":5,"purchase_price_wo_vat":4,"rebate":0,"rebate_wo_vat":0,"retail_value":10,"retail_value_wo_vat":8,"sales_unit":"pcs","gross_weight":12.5,"organisation_id":"540","department_id":"54011","purchaser_id":"5400","order_date":"2016-01-01","order_time":"15:00:00","delivery_date":"2016-01-01","delivery_time":"15:00:00","arrival_date":"2016-01-03","arrival_time":"15:00:00","order_status":1,"order_type":"Express","custom_field_1":"extra info","custom_field_2":"extra info","custom_field_3":"extra info","custom_field_4":"extra info","custom_field_5":"extra info","custom_field_6":"extra info","custom_field_7":"extra info","custom_field_8":"extra info","custom_field_9":"extra info","custom_field_10":"extra info","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1purchaseOrders.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1purchaseOrders.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1purchaseOrders.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1purchaseOrders.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1purchaseOrders.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1purchaseOrders.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1purchaseOrders.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1purchaseOrders.csv/get/responses/200/content/application~1csv/examples/response":{"value":"transaction_id;line_item_id;product_id;ordered_quantity;delivered_quantity;supplier_id;purchase_price;purchase_price_wo_vat;currency;organisation_id;order_date;order_time;delivery_date;delivery_time;order_status\ner/232/f31; 1; XYZ; 2; 2; 1; 5.50; 4.10; EUR; 540; 2016-01-01; 15:00:00; 2016-01-01; 15:00:00; 1\n","key":"response","summary":"response","id":"paths/~1v2~1download~1purchaseOrders.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1purchaseOrders.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1purchaseOrders.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1purchaseOrders.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1purchaseOrders.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1purchaseOrders.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1purchaseOrders.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesSummaries.json/get/responses/200/content/application~1json/examples/response":{"value":{"sales_date":"2016-01-01","sales_time":"15:00:00","organisation_id":"540","department_id":"5401","salesperson_id":"15:00:00","customer_id":"1234","supplier_id":"12","campaign_id":"123","rebate_code_id":"3313V","sales_value":2000,"sales_value_wo_vat":1600,"sales_currency":"EUR","rebate":0,"rebate_wo_vat":0,"purchase_price":500,"purchase_price_wo_vat":400,"product_quantity":4,"number_of_transactions":2,"custom_field_1":"extra info","custom_field_2":"extra info","custom_field_3":"extra info","custom_field_4":"extra info","custom_field_5":"extra info","custom_field_6":"extra info","custom_field_7":"extra info","custom_field_8":"extra info","custom_field_9":"extra info","custom_field_10":"extra info","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesSummaries.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1salesSummaries.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesSummaries.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesSummaries.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesSummaries.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesSummaries.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesSummaries.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesSummaries.csv/get/responses/200/content/application~1csv/examples/response":{"value":"sales_date; sales_time; organisation_id; department_id; salesperson_id; product_quantity; number_of_transactions; sales_value; sales_value_wo_vat; sales_currency; rebate; rebate_wo_vat; purchase_price; purchase_price_wo_vat\n2016-01-01 ; 15:00:00 ; 540;5401;'15:00:00'1;4;2;2150.1700.0; EUR ;0;0;1000.0;750.0\n","key":"response","summary":"response","id":"paths/~1v2~1download~1salesSummaries.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1salesSummaries.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesSummaries.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesSummaries.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesSummaries.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesSummaries.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesSummaries.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPayments.json/get/responses/200/content/application~1json/examples/response":{"value":{"transaction_id":"242224","line_item_id":"1","customer_id":"32","delivery_customer_id":"35","organisation_id":"540","department_id":"5400","salesperson_id":"5402101","register_id":"54022","table_number":"54","payment_method":"Visa","giftcard_payment_id":"12345","sales_date":"2016-01-01","sales_time":"15:00:00","product_quantity":4,"sales_value":20,"sales_value_wo_vat":20,"rebate":0,"rebate_wo_vat":0,"purchase_price":500,"purchase_price_wo_vat":400,"currency":"EUR","custom_field_1":"extra info","custom_field_2":"extra info","custom_field_3":"extra info","custom_field_4":"extra info","custom_field_5":"extra info","custom_field_6":"extra info","custom_field_7":"extra info","custom_field_8":"extra info","custom_field_9":"extra info","custom_field_10":"extra info","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":1,"custom_metric_7":100,"custom_metric_8":2.2,"custom_metric_9":1.05,"custom_metric_10":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPayments.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPayments.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPayments.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPayments.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPayments.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPayments.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPayments.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPayments.csv/get/responses/200/content/application~1csv/examples/response":{"value":"transaction_id;line_item_id;customer_id;sales_value;sales_value_wo_vat;rebate;rebate_wo_vat;currency;payment_method;organisation_id;salesperson_id;cancel_id;sales_date;sales_time;register_id;custom_field1;custom_field2\ner/232/f31;1 ; 32; 20; 20; 0; 0; EUR; Invoice; 540; 5402101; ; 2016-01-01; 15:00:00; 1;payment 1 ; extra pay\n","key":"response","summary":"response","id":"paths/~1v2~1download~1salesPayments.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1salesPayments.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPayments.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPayments.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPayments.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPayments.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPayments.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1giftcardPayments.json/get/responses/200/content/application~1json/examples/response":{"value":{"giftcard_id":"A67gigMp","giftcard_number":"7TON39","giftcard_status":"Active","giftcard_balance":50,"creation_date":"2016-01-01","creation_time":"15:00:00","expiration_date":"2017-01-01","expiration_time":"15:00:00","sales_id":"dbeba367","organisation_id":"540","department_id":"5401","register_id":"32","salesperson_id":"5402101","customer_id":"32","payment_id":"A65A","payment_type":"Activation","payment_date":"2016-05-15","payment_time":"15:00:00","payment_value":20,"payment_currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1giftcardPayments.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1giftcardPayments.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1giftcardPayments.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1giftcardPayments.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1giftcardPayments.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1giftcardPayments.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1giftcardPayments.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1giftcardPayments.csv/get/responses/200/content/application~1csv/examples/response":{"value":"giftcard_id; giftcard_number; giftcard_status; giftcard_balance; creation_date; organisation_id; payment_id; payment_type; payment_date; payment_time; payment_value; payment_currency; salesperson_id\nA67gigMp ; 7TON39 ; Active ; 50.00 ; 2016-01-01 ; 540 ; A65A ; Activation ; 2016-05-15 ; 18:00:00 ; 20.00; EUR ; '15:00:00'1\n","key":"response","summary":"response","id":"paths/~1v2~1download~1giftcardPayments.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1giftcardPayments.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1giftcardPayments.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1giftcardPayments.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1giftcardPayments.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1giftcardPayments.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1giftcardPayments.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1bookings.json/get/responses/200/content/application~1json/examples/response":{"value":{"booking_id":"er/232/f31","booking_line_id":"1","customer_id":"32","product_id":"XYZ","event_id":"123","organisation_id":"540","department_id":"54011","salesperson_id":"5402101","booked_quantity":2,"number_of_guests":2,"number_of_visits":2,"sales_value":20,"sales_value_wo_vat":20,"currency":"EUR","canceled":false,"booking_date":"2020-03-01","booking_time":"15:00:00","event_start_date":"2020-03-10","event_start_time":"15:00:00","event_end_date":"2020-03-11","event_end_time":"15:00:00","booking_type":"event","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1bookings.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1bookings.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1bookings.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1bookings.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1bookings.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1bookings.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1bookings.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1bookings.csv/get/responses/200/content/application~1csv/examples/response":{"value":"booking_id;booking_line_id;customer_id;product_id;booked_quantity;product_unit_price;sales_value;sales_value_wo_vat;currency;organisation_id;salesperson_id;event_id;booking_date;booking_time;event_start_date;event_start_time;event_end_date;event_end_time\ner/232/f31; 1; 32; XYZ; 2; 10; 20; 20; EUR; 540; 5402101; 6344; 2021-02-01; 15:30:00; 2021-03-01; 15:00:00; 2021-03-01; 15:00:00\n","key":"response","summary":"response","id":"paths/~1v2~1download~1bookings.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1bookings.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1bookings.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1bookings.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1bookings.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1bookings.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1bookings.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1accounting.json/get/responses/200/content/application~1json/examples/response":{"value":{"transaction_id":"1234","line_item_id":"1","organisation_id":"540","department_id":"5401","account_id":"1150","event_date":"2016-01-01","event_time":"15:00:00","receipt_type":"cost","receipt_number":"12345","receipt_value":2000,"receipt_value_wo_vat":1600,"currency":"EUR","cancelled":true,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounting.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1accounting.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounting.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1accounting.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounting.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1accounting.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounting.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1accounting.csv/get/responses/200/content/application~1csv/examples/response":{"value":"transaction_id;line_item_id;receipt_type;receipt_value;receipt_value_wo_vat;currency;organisation_id;account_id;event_date;event_time;custom_field1\n1234-XY;1 ; cost; 20; 20; EUR; 540; 1230; 2016-01-01; 15:00:00; extra pay\n","key":"response","summary":"response","id":"paths/~1v2~1download~1accounting.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1accounting.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounting.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1accounting.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounting.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1accounting.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounting.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1cashierBalance.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"ORG1","department_id":"DEP1","register_id":"123","batch_id":"1","payment_method":"Cash","sales_date":"2018-01-01","sales_time":"15:00:00","batch_status":"OK","transaction_count":9,"shift_amount":1000,"over_short":100,"cash_dropped":0,"cash_paid_out":50,"currency":"EUR"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashierBalance.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1cashierBalance.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashierBalance.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1cashierBalance.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashierBalance.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1cashierBalance.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashierBalance.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1cashierBalance.csv/get/responses/200/content/application~1csv/examples/response":{"value":"organisation_id;shift_amount;over_short;cash_dropped;cash_paid_out;currency;payment_method;batch_id;batch_status;sales_date;sales_time;register_id\n32; 20; 25; 0; 0; EUR; Invoice; 5402101; OK; 2016-01-01; 15:00:00; 1\n","key":"response","summary":"response","id":"paths/~1v2~1download~1cashierBalance.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1cashierBalance.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashierBalance.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1cashierBalance.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashierBalance.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1cashierBalance.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashierBalance.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1customerFeedbacks.json/get/responses/200/content/application~1json/examples/response":{"value":{"feedback_id":"xyz","respondent_id":"1234","survey_id":"Survey 1","question_id":"Q1","organisation_id":"ORG1","department_id":"DEP1","feedback_date":"2018-01-01","feedback_time":"15:00:00","feedback_type":"Store survey","main_feedback":true,"grade":9,"grade_total":8.5,"comments":"Great service today!","comments_en":"Great service today!","review_url":"https://www.google.com/maps/reviews?data=XYZ","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customerFeedbacks.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1customerFeedbacks.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customerFeedbacks.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1customerFeedbacks.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customerFeedbacks.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1customerFeedbacks.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customerFeedbacks.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1customerFeedbacks.csv/get/responses/200/content/application~1csv/examples/response":{"value":"feedback_id;organisation_id;department_id;feedback_date;feedback_time;feedback_type;grade;comments\nxyz;ORG1;DEP1;2018-01-01;15:00:00;\"Store survey\";9;\"Great service today!\"\n","key":"response","summary":"response","id":"paths/~1v2~1download~1customerFeedbacks.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1customerFeedbacks.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customerFeedbacks.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1customerFeedbacks.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customerFeedbacks.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1customerFeedbacks.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customerFeedbacks.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1inventoryTransactions.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"540","salesperson_id":"5401","department_id":"54011","operator_id":"5402","movement_date":"2016-02-01","movement_time":"15:00:00","delivered_date":"2016-02-02","delivered_time":"15:00:00","product_id":"123","supplier_id":"221","parent_product_id":"123","quantity":100,"delivered_quantity":90,"expected_quantity":110,"movement_type":"waste","movement_status":2,"movement_batch_id":"june-stock-take","movement_batch_line_id":"1","unit_purchase_price":12.4,"unit_purchase_price_wo_vat":10,"unit_retail_price":12.4,"unit_retail_price_wo_vat":10,"reason_code":"Theft","target_organisation_id":"510","currency":"EUR","purchase_order_id":"1234","purchase_order_line_id":"1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventoryTransactions.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1inventoryTransactions.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventoryTransactions.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1inventoryTransactions.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventoryTransactions.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1inventoryTransactions.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventoryTransactions.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1inventoryTransactions.csv/get/responses/200/content/application~1csv/examples/response":{"value":"organisation_id;movement_date;movement_time;movement_type;product_id;quantity;unit_purchase_price;unit_purchase_price_wo_vat;currency\n540;2016-01-01;10:00:00;waste;My product ID;100;12.40;10.00;EUR\n","key":"response","summary":"response","id":"paths/~1v2~1download~1inventoryTransactions.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1inventoryTransactions.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventoryTransactions.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1inventoryTransactions.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventoryTransactions.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1inventoryTransactions.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventoryTransactions.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1inventorySnapshots.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"540","snapshot_date":"2016-01-01","snapshot_time":"15:00:00","product_id":"My product ID","supplier_id":"221","quantity":100,"available_quantity":90,"reorder_point":5,"max_reorder_quantity":10,"unit_purchase_price":12.4,"unit_purchase_price_wo_vat":10,"unit_sales_price":22.4,"unit_sales_price_wo_vat":20,"currency":"EUR"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventorySnapshots.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1inventorySnapshots.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventorySnapshots.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1inventorySnapshots.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventorySnapshots.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1inventorySnapshots.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventorySnapshots.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1inventorySnapshots.csv/get/responses/200/content/application~1csv/examples/response":{"value":"organisation_id;snapshot_date;snapshot_time;product_id;quantity;unit_purchase_price;unit_purchase_price_wo_vat;currency\n540;2016-01-01;10:00:00;My product ID;100;12.40;10.00;EUR\n","key":"response","summary":"response","id":"paths/~1v2~1download~1inventorySnapshots.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1inventorySnapshots.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventorySnapshots.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1inventorySnapshots.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventorySnapshots.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1inventorySnapshots.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1inventorySnapshots.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1capacity.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"540","product_id":"123","event_id":"221","capacity_date":"2020-02-01","capacity_time":"15:00:00","capacity_type":"event","max_capacity":100},"key":"response","summary":"response","id":"paths/~1v2~1download~1capacity.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1capacity.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1capacity.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1capacity.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1capacity.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1capacity.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1capacity.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1capacity.csv/get/responses/200/content/application~1csv/examples/response":{"value":"organisation_id;capacity_date;capacity_time;product_id;event_id;max_capacity\n540;2021-02-01;10:00:00;123;456;100\n","key":"response","summary":"response","id":"paths/~1v2~1download~1capacity.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1capacity.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1capacity.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1capacity.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1capacity.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1capacity.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1capacity.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1visitors.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"540","department_id":"540","counter_id":"540","product_id":"ABC-123","date":"2016-01-01","time":"15:00:00","time_zone":"02:00","visit_type":"in","vehicle_type":"car","visitors":1000,"queue_area_name":"Area 1","low_queue":1,"high_queue":5,"custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitors.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1visitors.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitors.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1visitors.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitors.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1visitors.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitors.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1visitors.csv/get/responses/200/content/application~1csv/examples/response":{"value":"counter_id;custom_field_1;custom_field_2;custom_field_3;custom_field_4;custom_field_5;custom_metric_1;custom_metric_2;custom_metric_3;custom_metric_4;custom_metric_5;customer_id;date;department_id;high_queue;low_queue;organisation_id;product_id;queue_area_name;time;vehicle_type;visit_type;visitors\nmy counter id;custom 1;custom 2;custom 3;custom 4;custom 5;1;1;1;1;1;customer id;2018-01-19;my department id;6;1;my organisation id;my product id;Area 1;06:18:00;NULL;in;3\n","key":"response","summary":"response","id":"paths/~1v2~1download~1visitors.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1visitors.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitors.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1visitors.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitors.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1visitors.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitors.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1visitorDemographics.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"540","department_id":"540","counter_id":"540","visitor_id":"540","date":"2016-01-01","time":"15:00:00","gender":"m","age":25,"visitors":1000},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitorDemographics.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1visitorDemographics.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitorDemographics.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1visitorDemographics.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitorDemographics.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1visitorDemographics.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitorDemographics.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1visitorDemographics.csv/get/responses/200/content/application~1csv/examples/response":{"value":"organisation_id;department_id;counter_id;visitor_id;date;time;gender;age;visitors\n540;540;540;2016-01-01;15:00:00;m;25;1000\n","key":"response","summary":"response","id":"paths/~1v2~1download~1visitorDemographics.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1visitorDemographics.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitorDemographics.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1visitorDemographics.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitorDemographics.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1visitorDemographics.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1visitorDemographics.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1workShifts.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"234","department_id":"5401","salesperson_id":"345","shift_id":"123","start_date":"2016-01-01","start_time":"15:00:00","duration":8.15,"shift_type":"Chef","salary_type":"Evening compensation","staff_cost":500,"breaks_duration":0.5,"breaks_cost":40,"overtime_duration":2,"overtime_cost":120,"absence_code":"BREAK","productive":true,"active_work_time":true,"scheduled":false,"currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1workShifts.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1workShifts.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1workShifts.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1workShifts.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1workShifts.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1workShifts.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1workShifts.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1workShifts.csv/get/responses/200/content/application~1csv/examples/response":{"value":"shift_id;organisation_id;department_id;employee_id;shift_date;shift_time;shift_duration;scheduled;productive;active_worktime;salary_type\n1234;540;5401;54001;2017-01-01;15:00:00;5.5;false;true;true;overtime\n","key":"response","summary":"response","id":"paths/~1v2~1download~1workShifts.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1workShifts.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1workShifts.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1workShifts.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1workShifts.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1workShifts.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1workShifts.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1employeeHours.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"540","department_id":"54021","salesperson_id":"5402101","employee_type":"Permie","absence_code":"BREAK","date":"2016-01-01","time":"15:00:00","scheduled":false,"productive":true,"hours":8,"staff_cost":500,"breaks":0.5,"breaks_cost":40,"currency":"EUR","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ"},"key":"response","summary":"response","id":"paths/~1v2~1download~1employeeHours.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1employeeHours.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1employeeHours.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1employeeHours.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1employeeHours.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1employeeHours.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1employeeHours.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1employeeHours.csv/get/responses/200/content/application~1csv/examples/response":{"value":"organisation_id;date;time;hours;salesperson_id;employee_type\n540;2016-01-01;15:00:00;8;5402101;Permie\n","key":"response","summary":"response","id":"paths/~1v2~1download~1employeeHours.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1employeeHours.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1employeeHours.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1employeeHours.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1employeeHours.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1employeeHours.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1employeeHours.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1staffCosts.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"540","department_id":"54021","salesperson_id":"5402101","start_date":"2024-01-01","staff_cost":15,"currency":"EUR"},"key":"response","summary":"response","id":"paths/~1v2~1download~1staffCosts.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1staffCosts.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1staffCosts.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1staffCosts.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1staffCosts.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1staffCosts.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1staffCosts.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1staffCosts.csv/get/responses/200/content/application~1csv/examples/response":{"value":"organisation_id;start_date;staff_cost;currency\n540;2024-01-01;12.50;EUR\n","key":"response","summary":"response","id":"paths/~1v2~1download~1staffCosts.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1staffCosts.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1staffCosts.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1staffCosts.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1staffCosts.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1staffCosts.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1staffCosts.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1products.json/get/responses/200/content/application~1json/examples/response":{"value":{"product_id":"XYZ","product_name":"Widget XYZ","product_description":"Best performance XYZ on the market","average_price":8,"purchase_price":10,"sales_price":20,"sales_price_wo_vat":16,"vat_rate":24,"unit_of_measure":"PCS","product_size":"XS","product_width":"5\"","product_height":"10\"","product_color":"Dark Blue","product_type":"Type A","product_season":"Spring","product_brand":"Tiger","model":"XYZ B40","model_number":"X311","country_of_origin":"Moldovia","freight":5,"duty":0.24,"supplier_id":"221","fabric":"Felt","buyer":"Lena Shields","ean":"Ean code","parent_product_id":"XY","image_url":"http://example.com?product=XYZ","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only","custom_field_6":"EU only","custom_field_7":"EU only","custom_field_8":"EU only","custom_field_9":"EU only","custom_field_10":"EU only","custom_field_11":"EU only","custom_field_12":"EU only","custom_field_13":"EU only","custom_field_14":"EU only","custom_field_15":"EU only","custom_field_16":"EU only","custom_field_17":"EU only","custom_field_18":"EU only","custom_field_19":"EU only","custom_field_20":"EU only","custom_field_21":"EU only","custom_field_22":"EU only","custom_field_23":"EU only","custom_field_24":"EU only","custom_field_25":"EU only","custom_field_26":"EU only","custom_field_27":"EU only","custom_field_28":"EU only","custom_field_29":"EU only","custom_field_30":"EU only","custom_field_31":"EU only","custom_field_32":"EU only","custom_field_33":"EU only","custom_field_34":"EU only","custom_field_35":"EU only","custom_field_36":"EU only","custom_field_37":"EU only","custom_field_38":"EU only","custom_field_39":"EU only","custom_field_40":"EU only","custom_field_41":"EU only","custom_field_42":"EU only","custom_field_43":"EU only","custom_field_44":"EU only","custom_field_45":"EU only","custom_field_46":"EU only","custom_field_47":"EU only","custom_field_48":"EU only","custom_field_49":"EU only","custom_field_50":"EU only","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000,"custom_metric_6":150,"custom_metric_7":1000,"custom_metric_8":2.52,"custom_metric_9":1.5,"custom_metric_10":2000},"key":"response","summary":"response","id":"paths/~1v2~1download~1products.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1products.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1products.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1products.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1products.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1products.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1products.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1products.csv/get/responses/200/content/application~1csv/examples/response":{"value":"product_id;product_name;product_description;category_id;purchase_price;vat_rate;unit_of_measure;product_size;product_color;product_type;product_season;model;model_number;country_of_origin;freight;supplier_id;fabric;buyer;ean;custom_field_1;custom_field_2;custom_field_3;custom_field_4;custom_field_5\nXYZ; Widget XYZ; Best performance XYZ on the market; 23;10;24; PCS; XS; Dark Blue; Type A; Spring; XYZ B40; X311; Moldovia;5; 221; Felt;Lena Shields;123k;EU;;;;;\n","key":"response","summary":"response","id":"paths/~1v2~1download~1products.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1products.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1products.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1products.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1products.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1products.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1products.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1customers.json/get/responses/200/content/application~1json/examples/response":{"value":{"customer_id":"32","customer_name":"John Smith","customer_company":"Smith Industries","customer_email":"john.smith@customer.customer","customer_phone":"+35811111111","customer_address":"Mannerheimintie 1","customer_zipcode":"00100","customer_city":"Helsinki","customer_country":"Finland","account_number":"123","vat_number":"12345678","organisation_id":"1","salesperson_id":"3","creation_date":"2021-12-15","subscribe_date":"2022-01-15","unsubscribe_date":"2022-02-15","register_date":"2022-01-10","unregister_date":"2022-03-15","custom_dimension_1":"Class 3","custom_dimension_2":"Class 3","custom_dimension_3":"Class 3","custom_dimension_4":"Class 3","custom_dimension_5":"Class 3","custom_dimension_6":"Class 3","custom_dimension_7":"Class 3","custom_dimension_8":"Class 3","custom_dimension_9":"Class 3","custom_dimension_10":"Class 3","custom_dimension_11":"Class 3","custom_dimension_12":"Class 3","custom_dimension_13":"Class 3","custom_dimension_14":"Class 3","custom_dimension_15":"Class 3","custom_dimension_16":"Class 3","custom_dimension_17":"Class 3","custom_dimension_18":"Class 3","custom_dimension_19":"Class 3","custom_dimension_20":"Class 3","custom_dimension_21":"Class 3","custom_dimension_22":"Class 3","custom_dimension_23":"Class 3","custom_dimension_24":"Class 3","custom_dimension_25":"Class 3","custom_dimension_26":"Class 3","custom_dimension_27":"Class 3","custom_dimension_28":"Class 3","custom_dimension_29":"Class 3","custom_dimension_30":"Class 3","custom_dimension_31":"Class 3","custom_dimension_32":"Class 3","custom_dimension_33":"Class 3","custom_dimension_34":"Class 3","custom_dimension_35":"Class 3","custom_dimension_36":"Class 3","custom_dimension_37":"Class 3","custom_dimension_38":"Class 3","custom_dimension_39":"Class 3","custom_dimension_40":"Class 3","custom_dimension_41":"Class 3","custom_dimension_42":"Class 3","custom_dimension_43":"Class 3","custom_dimension_44":"Class 3","custom_dimension_45":"Class 3","custom_dimension_46":"Class 3","custom_dimension_47":"Class 3","custom_dimension_48":"Class 3","custom_dimension_49":"Class 3","custom_dimension_50":"Class 3","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1customers.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1customers.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customers.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1customers.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customers.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1customers.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customers.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1customers.csv/get/responses/200/content/application~1csv/examples/response":{"value":"customer_id;customer_name;customer_company;customer_email;customer_phone;customer_address;customer_zipcode;customer_city;customer_country;custom_dimension_1;custom_dimension_2;custom_dimension_3;custom_dimension_4;custom_dimension_5\n32; John Smith; Smith Industries; john.smith@customer.customer;+35811111111; Mannerheimintie 1;00100; Helsinki; Finland;;;;;;\n","key":"response","summary":"response","id":"paths/~1v2~1download~1customers.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1customers.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customers.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1customers.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customers.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1customers.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1customers.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1organisations.json/get/responses/200/content/application~1json/examples/response":{"value":{"organisation_id":"540","organisation_name":"Web Sales","area":"South","latitude":60.184014,"longitude":24.960046,"channel":"Concession","floor_area":250,"no_customer_seats":150,"organisation_type":"Outlet","organisation_group":"A","google_location_url":"https://www.google.com/maps/reviews?data=XYZ","image_url":"http://example.com?product=XYZ","store_status":"closed","custom_dimension1":"Class 3","custom_dimension2":"Class 3","custom_dimension3":"Class 3","custom_dimension4":"Class 3","custom_dimension5":"Class 3"},"key":"response","summary":"response","id":"paths/~1v2~1download~1organisations.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1organisations.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1organisations.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1organisations.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1organisations.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1organisations.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1organisations.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1organisations.csv/get/responses/200/content/application~1csv/examples/response":{"value":"organisation_id;organisation_name;area;channel;latitude;longitude;custom_dimension1;custom_dimension2;custom_dimension3;custom_dimension4;custom_dimension5\n540; Web Sales; South; Concession;Outlet;12.3;15.9;;;;;\n","key":"response","summary":"response","id":"paths/~1v2~1download~1organisations.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1organisations.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1organisations.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1organisations.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1organisations.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1organisations.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1organisations.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1departments.json/get/responses/200/content/application~1json/examples/response":{"value":{"department_id":"5401","name":"Web Sales","floor_area":100,"organisation_id":"540","no_customer_seats":150,"custom_dimension1":"Class 3","custom_dimension2":"Class 3","custom_dimension3":"Class 3","custom_dimension4":"Class 3","custom_dimension5":"Class 3"},"key":"response","summary":"response","id":"paths/~1v2~1download~1departments.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1departments.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1departments.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1departments.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1departments.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1departments.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1departments.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1departments.csv/get/responses/200/content/application~1csv/examples/response":{"value":"department_id;name;floor_area;organisation_id\n5401; Web Sales;100;540\n","key":"response","summary":"response","id":"paths/~1v2~1download~1departments.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1departments.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1departments.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1departments.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1departments.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1departments.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1departments.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPersons.json/get/responses/200/content/application~1json/examples/response":{"value":{"salesperson_id":"5402101","salesperson_name":"John Smith","salesperson_email":"john.smith@store.store","salesperson_phone":"+35811111111","employment_start":"2020-01-01","employment_end":"2020-05-31","custom_field_1":"Project worker","custom_field_2":"Project worker","custom_field_3":"Project worker","custom_field_4":"Project worker","custom_field_5":"Project worker","custom_metric_1":1,"custom_metric_2":100,"custom_metric_3":2.2,"custom_metric_4":1.05,"custom_metric_5":10000},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPersons.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPersons.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPersons.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPersons.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPersons.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPersons.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPersons.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPersons.csv/get/responses/200/content/application~1csv/examples/response":{"value":"salesperson_id;salesperson_name;salesperson_email;salesperson_phone\n5402101;John Smith;john.smith@store.store;+35811111111\n","key":"response","summary":"response","id":"paths/~1v2~1download~1salesPersons.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1salesPersons.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPersons.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPersons.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPersons.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1salesPersons.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1salesPersons.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1cashRegisters.json/get/responses/200/content/application~1json/examples/response":{"value":{"register_id":"123-1","register_name":"Kiosk 1","organisation_id":"540","register_type":"Kiosk","register_group":"Self service","custom_dimension1":"Class 3","custom_dimension2":"Class 3","custom_dimension3":"Class 3","custom_dimension4":"Class 3","custom_dimension5":"Class 3"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashRegisters.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1cashRegisters.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashRegisters.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1cashRegisters.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashRegisters.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1cashRegisters.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashRegisters.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1cashRegisters.csv/get/responses/200/content/application~1csv/examples/response":{"value":"register_id;register_name;register_type;register_group\n123-1;Kiosk 1;Kiosk;Self service\n","key":"response","summary":"response","id":"paths/~1v2~1download~1cashRegisters.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1cashRegisters.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashRegisters.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1cashRegisters.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashRegisters.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1cashRegisters.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1cashRegisters.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1accounts.json/get/responses/200/content/application~1json/examples/response":{"value":{"account_id":"1150","account_name":"Employee Salaries","account_type":"Salaries","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounts.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1accounts.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounts.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1accounts.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounts.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1accounts.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounts.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1accounts.csv/get/responses/200/content/application~1csv/examples/response":{"value":"account_id;account_name;account_type\n1020;Employee Salaries;Salaries\n","key":"response","summary":"response","id":"paths/~1v2~1download~1accounts.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1accounts.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounts.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1accounts.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounts.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1accounts.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1accounts.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1events.json/get/responses/200/content/application~1json/examples/response":{"value":{"event_id":"1150","event_name":"Rock around the clock","event_type":"Concert","venue_name":"Arena 1","custom_field_1":"EU only","custom_field_2":"EU only","custom_field_3":"EU only","custom_field_4":"EU only","custom_field_5":"EU only"},"key":"response","summary":"response","id":"paths/~1v2~1download~1events.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1events.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1events.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1events.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1events.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1events.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1events.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1events.csv/get/responses/200/content/application~1csv/examples/response":{"value":"event_id;event_name;event_type\n102;Rock concert;Concert\n","key":"response","summary":"response","id":"paths/~1v2~1download~1events.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1events.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1events.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1events.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1events.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1events.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1events.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1hierarchies.json/get/responses/200/content/application~1json/examples/response":{"value":{"hierarchy_name":"product","category_id":"123","category_name":"Shoes","parent_id":"12"},"key":"response","summary":"response","id":"paths/~1v2~1download~1hierarchies.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1hierarchies.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1hierarchies.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1hierarchies.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1hierarchies.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1hierarchies.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1hierarchies.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1hierarchies.csv/get/responses/200/content/application~1csv/examples/response":{"value":"hierarchy_name;category_id;category_name;parent_id\nproduct;1234; Shoes;123\n","key":"response","summary":"response","id":"paths/~1v2~1download~1hierarchies.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1hierarchies.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1hierarchies.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1hierarchies.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1hierarchies.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1hierarchies.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1hierarchies.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1flatHierarchies.json/get/responses/200/content/application~1json/examples/response":{"value":{"hierarchy_key":"product","entity_id":"XYZ","level1":"Clothing","level2":"Children's clothing","level3":"Children's outdoor clothing","level4":"Children's outdoor headwear","level5":"Children's caps","level6":"Children's small caps","level7":"Children's themed caps","level8":"Children's disney caps","level9":"Children's mickey caps","level10":"Children's ..."},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatHierarchies.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1flatHierarchies.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatHierarchies.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1flatHierarchies.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatHierarchies.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1flatHierarchies.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatHierarchies.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1flatHierarchies.csv/get/responses/200/content/application~1csv/examples/response":{"value":"hierarchy_key;entity_id;level1;level2;level3;level4;level5\nproduct;XYZ;Clothing;Children's clothing;Children's outdoor clothing;Children's outdoor headwear;Children's caps\n","key":"response","summary":"response","id":"paths/~1v2~1download~1flatHierarchies.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1flatHierarchies.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatHierarchies.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1flatHierarchies.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatHierarchies.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1flatHierarchies.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatHierarchies.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1counters.json/get/responses/200/content/application~1json/examples/response":{"value":{"counter_id":"5","counter_name":"Front door 1","folder_id: front_door_1":"","serial":"ABCDE12345","registration_code":"A1B2C3D4E5","disabled":false,"is_queue":false,"on_store_perimeter":true,"department_reversed_id":"reverse_id"},"key":"response","summary":"response","id":"paths/~1v2~1download~1counters.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1counters.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1counters.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1counters.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1counters.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1counters.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1counters.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1counters.csv/get/responses/200/content/application~1csv/examples/response":{"value":"counter_id;counter_name;department_id;disabled;folder_id;is_queue;last_update_time;on_store_perimeter;organisation_id;registration_code;serial;time_zone;first_connected_date;last_connected_date\nmy_counter;My counter name;my_department_id;false;my_folder_id;false;2023-06-20 11:15:00;true;my_organisation_id;A1B2C3D4E5;ABCDE12345;Europe/Helsinki;2022-11-20 15:04:37;2023-10-21 16:14:07\n","key":"response","summary":"response","id":"paths/~1v2~1download~1counters.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1counters.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1counters.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1counters.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1counters.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1counters.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1counters.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1campaigns.json/get/responses/200/content/application~1json/examples/response":{"value":{"campaign_id":"6344","campaign_name":"February 2016","campaign_type":"Web","start_date":"2016-02-01","end_date":"2016-02-29","custom_field_1":"New","custom_field_2":"New","custom_field_3":"New","custom_field_4":"New","custom_field_5":"Old"},"key":"response","summary":"response","id":"paths/~1v2~1download~1campaigns.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1campaigns.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1campaigns.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1campaigns.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1campaigns.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1campaigns.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1campaigns.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1campaigns.csv/get/responses/200/content/application~1csv/examples/response":{"value":"campaign_id;campaign_name;start_date;end_date\n6344;February 2016;2016-02-01;2016-02-29\n","key":"response","summary":"response","id":"paths/~1v2~1download~1campaigns.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1campaigns.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1campaigns.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1campaigns.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1campaigns.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1campaigns.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1campaigns.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1paymentTypes.json/get/responses/200/content/application~1json/examples/response":{"value":{"payment_type_id":"1","payment_type":"credit card","payment_group":"Store","custom_field_1":"App","custom_field_2":"App","custom_field_3":"App","custom_field_4":"App","custom_field_5":"App"},"key":"response","summary":"response","id":"paths/~1v2~1download~1paymentTypes.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1paymentTypes.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1paymentTypes.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1paymentTypes.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1paymentTypes.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1paymentTypes.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1paymentTypes.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1paymentTypes.csv/get/responses/200/content/application~1csv/examples/response":{"value":"payment_type_id;payment_type\n1; credit card\n","key":"response","summary":"response","id":"paths/~1v2~1download~1paymentTypes.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1paymentTypes.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1paymentTypes.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1paymentTypes.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1paymentTypes.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1paymentTypes.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1paymentTypes.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1rebateCodes.json/get/responses/200/content/application~1json/examples/response":{"value":{"rebate_code_id":"3313V","rebate_code_name":"Model product"},"key":"response","summary":"response","id":"paths/~1v2~1download~1rebateCodes.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1rebateCodes.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1rebateCodes.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1rebateCodes.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1rebateCodes.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1rebateCodes.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1rebateCodes.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1rebateCodes.csv/get/responses/200/content/application~1csv/examples/response":{"value":"rebate_code_id;rebate_code_name\n3313V; Model product\n","key":"response","summary":"response","id":"paths/~1v2~1download~1rebateCodes.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1rebateCodes.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1rebateCodes.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1rebateCodes.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1rebateCodes.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1rebateCodes.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1rebateCodes.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1suppliers.json/get/responses/200/content/application~1json/examples/response":{"value":{"supplier_id":"221","supplier_name":"WasSuppliers","supplier_email":"john.smith@supplier.supplier","supplier_phone":"+3581111111","supplier_address":"Mannerheimintie 1","supplier_city":"Helsinki","supplier_zipcode":"00100","supplier_country":"Finland","supplier_type":"Local","supplier_group":"Strategic Supplier","custom_field_1":"XYZ","custom_field_2":"XYZ","custom_field_3":"XYZ","custom_field_4":"XYZ","custom_field_5":"XYZ"},"key":"response","summary":"response","id":"paths/~1v2~1download~1suppliers.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1suppliers.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1suppliers.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1suppliers.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1suppliers.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1suppliers.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1suppliers.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1suppliers.csv/get/responses/200/content/application~1csv/examples/response":{"value":"supplier_id;supplier_name;supplier_email;supplier_phone;supplier_address;supplier_city; supplier_zipcode;supplier_country\n221; WasSuppliers; john.smith@supplier.supplier; +3581111111; Mannerheimintie 1;Helsinki; 00100; Finland\n","key":"response","summary":"response","id":"paths/~1v2~1download~1suppliers.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1suppliers.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1suppliers.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1suppliers.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1suppliers.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1suppliers.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1suppliers.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1calendar.json/get/responses/200/content/application~1json/examples/response":{"value":{"period_key":"season","period_year":2018,"period_name":"Autumn Season","period_number":2,"start_date":"2018-07-01","end_date":"2018-12-31"},"key":"response","summary":"response","id":"paths/~1v2~1download~1calendar.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1calendar.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1calendar.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1calendar.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1calendar.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1calendar.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1calendar.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1calendar.csv/get/responses/200/content/application~1csv/examples/response":{"value":"period_key;period_name;period_year;period_number;start_date;end_date\nseason;Autumn Season;2018;2;2018-07-01;2018-12-31\n","key":"response","summary":"response","id":"paths/~1v2~1download~1calendar.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1calendar.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1calendar.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1calendar.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1calendar.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1calendar.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1calendar.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1flatCalendar.json/get/responses/200/content/application~1json/examples/response":{"value":{"calendar_date":"2019-01-01","calendar_year":"2018/2019","period_name":"January","period_number":2,"week_number":9,"season":"Spring 2019","season_label":"Spring","lfl_date":"2018-01-02","bank_holiday_name":"New Year"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatCalendar.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1flatCalendar.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatCalendar.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1flatCalendar.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatCalendar.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1flatCalendar.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatCalendar.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1flatCalendar.csv/get/responses/200/content/application~1csv/examples/response":{"value":"calendar_date;calendar_year;period_name;period_number;week_number;season;season_label;lfl_date;bank_holiday_name\n2018-01-01;2017/2018;January;1;1;Spring 2018;Spring;2016-12-30;New year day\n","key":"response","summary":"response","id":"paths/~1v2~1download~1flatCalendar.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1flatCalendar.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatCalendar.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1flatCalendar.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatCalendar.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1flatCalendar.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1flatCalendar.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1currencyRates.json/get/responses/200/content/application~1json/examples/response":{"value":{"source_currency":"EUR","target_currency":"SEK","valid_from":"2017-01-01","valid_to":"2017-12-31","rate":0.1123},"key":"response","summary":"response","id":"paths/~1v2~1download~1currencyRates.json/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1currencyRates.json/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1currencyRates.json/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1currencyRates.json/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1currencyRates.json/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1currencyRates.json/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1currencyRates.json/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1currencyRates.csv/get/responses/200/content/application~1csv/examples/response":{"value":"source_currency;target_currency;valid_from;valid_to;rate\nSEK;EUR;2018-01-01;2018-12-31;0.11234\n","key":"response","summary":"response","id":"paths/~1v2~1download~1currencyRates.csv/get/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1download~1currencyRates.csv/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1currencyRates.csv/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1currencyRates.csv/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1currencyRates.csv/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1currencyRates.csv/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1currencyRates.csv/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1download~1budgets/get/responses/200/content/application~1json/examples/response":{"value":{"year":2019,"month":1,"week":12,"day":1,"hour":12,"label":"forecast","dimensions":{},"metrics":{}},"key":"response","summary":"response","id":"paths/~1v2~1download~1budgets/get/responses/200/content/application~1json/examples/response"},"paths/~1v2~1download~1budgets/get/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1budgets/get/responses/400/content/application~1json/examples/response"},"paths/~1v2~1download~1budgets/get/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1download~1budgets/get/responses/401/content/application~1json/examples/response"},"paths/~1v2~1download~1budgets/get/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1download~1budgets/get/responses/500/content/application~1json/examples/response"},"paths/~1v2~1query~1table/post/responses/200/content/application~1json/examples/response":{"value":[{"dimensions":{"day":{"id":"20170101","name":"2017-01-01"},"store":{"id":"Helsinki","name":"Helsinki"}},"metrics":{"sales":10000,"sales_margin":2000},"sort":{"day":"","store":""}}],"key":"response","summary":"response","id":"paths/~1v2~1query~1table/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1query~1table/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1query~1table/post/responses/400/content/application~1json/examples/response"},"paths/~1v2~1query~1table/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1query~1table/post/responses/401/content/application~1json/examples/response"},"paths/~1v2~1query~1table/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1query~1table/post/responses/500/content/application~1json/examples/response"},"paths/~1v2~1query~1table.csv/post/responses/200/content/application~1csv/examples/response":{"value":"day;store;sales;sales_margin\n2017-01-01;Helsinki;10000;2000\n","key":"response","summary":"response","id":"paths/~1v2~1query~1table.csv/post/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1query~1table.csv/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1query~1table.csv/post/responses/400/content/application~1json/examples/response"},"paths/~1v2~1query~1table.csv/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1query~1table.csv/post/responses/401/content/application~1json/examples/response"},"paths/~1v2~1query~1table.csv/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1query~1table.csv/post/responses/500/content/application~1json/examples/response"},"paths/~1v2~1query~1stream/post/responses/200/content/application~1json/examples/response":{"value":[{"dimensions":{"day":{"id":"20170101","name":"2017-01-01"},"store":{"id":"Helsinki","name":"Helsinki"}},"metrics":{"sales":10000,"sales_margin":2000},"sort":{"day":"","store":""}}],"key":"response","summary":"response","id":"paths/~1v2~1query~1stream/post/responses/200/content/application~1json/examples/response"},"paths/~1v2~1query~1stream/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1query~1stream/post/responses/400/content/application~1json/examples/response"},"paths/~1v2~1query~1stream/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1query~1stream/post/responses/401/content/application~1json/examples/response"},"paths/~1v2~1query~1stream/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1query~1stream/post/responses/500/content/application~1json/examples/response"},"paths/~1v2~1query~1stream.csv/post/responses/200/content/application~1csv/examples/response":{"value":"day;store;sales;sales_margin\n2017-01-01;Helsinki;10000;2000\n","key":"response","summary":"response","id":"paths/~1v2~1query~1stream.csv/post/responses/200/content/application~1csv/examples/response"},"paths/~1v2~1query~1stream.csv/post/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1query~1stream.csv/post/responses/400/content/application~1json/examples/response"},"paths/~1v2~1query~1stream.csv/post/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1v2~1query~1stream.csv/post/responses/401/content/application~1json/examples/response"},"paths/~1v2~1query~1stream.csv/post/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1v2~1query~1stream.csv/post/responses/500/content/application~1json/examples/response"},"paths/~1data/delete/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1data/delete/responses/400/content/application~1json/examples/response"},"paths/~1data/delete/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1data/delete/responses/401/content/application~1json/examples/response"},"paths/~1data/delete/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1data/delete/responses/500/content/application~1json/examples/response"},"paths/~1data~1{entity}~1id/delete/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1id/delete/responses/400/content/application~1json/examples/response"},"paths/~1data~1{entity}~1id/delete/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1id/delete/responses/401/content/application~1json/examples/response"},"paths/~1data~1{entity}~1id/delete/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1id/delete/responses/500/content/application~1json/examples/response"},"paths/~1data~1{entity}~1daterange/delete/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1daterange/delete/responses/400/content/application~1json/examples/response"},"paths/~1data~1{entity}~1daterange/delete/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1daterange/delete/responses/401/content/application~1json/examples/response"},"paths/~1data~1{entity}~1daterange/delete/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1daterange/delete/responses/500/content/application~1json/examples/response"},"paths/~1data~1{entity}~1batchdate/delete/responses/400/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1batchdate/delete/responses/400/content/application~1json/examples/response"},"paths/~1data~1{entity}~1batchdate/delete/responses/401/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Unauthorized"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1batchdate/delete/responses/401/content/application~1json/examples/response"},"paths/~1data~1{entity}~1batchdate/delete/responses/500/content/application~1json/examples/response":{"value":{"status":"Not OK","msg":"Reason for error"},"key":"response","summary":"response","id":"paths/~1data~1{entity}~1batchdate/delete/responses/500/content/application~1json/examples/response"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use your Zoined API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer your-token"},"children":[]}]}]}]}},"servers":[{"url":"/_mock/","isMockServer":true,"description":"Mock server"},{"url":"https://api.zoined.com"}],"specType":"openapi"},"options":{"layout":"three-panel","hideReplay":true,"schemasExpansionLevel":0,"jsonSamplesExpandLevel":2,"mockServer":{"url":"/_mock/","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/index.json?download"},{"url":"/_bundle/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Zoined API (ZAPI)","description":"Zoined API enables customers or third parties to send their data to\nZoined using RESTful HTTP API. Uploaded data will be processed and stored to our data\nwarehouse and used for generating analytic reports for the retailers. API service has end\npoints for almost every facet of a retail business be it sales, inventory or even\nemployee time keeping.\n\nThis document contains instructions on how to access the Zoined API. This document \ncontains two parts: introduction and reference. Introduction walks you through the \ngeneral structure of the API and how to use it. Reference contains detailed\ndocumentation for each API end point including code examples for multiple programming\nlanguages, and live in-browser testing tool for the API end points.\n\nIf you have any questions related to Zoined API, don't hesitate to contact \n[Zoined support](mailto:support@zoined.com).\n\n## Authentication and security\n\nEvery client must authenticate itself to send data towards any end points in Zoined API service.\nThis means that every request to the service must have an authorization header with\nan identification token. Token is unique to every customer and can be obtained by\ncontacting Zoined support services.\n\nAn example of the header would be:\n\n```\nAuthorization: Bearer dGVzdGlhc2lha2FzOnZhaWtlYXBhc3N1\n```\n\nAll traffic to Zoined API is sent with HTTPS and protected with [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security).\n\n<a name=\"messaging\"></a>\n\n## Messaging and error handling\n\nAPI service uses JSON data format to exchange data with clients. This means all\nreplies to clients will be delivered in JSON (including all possible error messages).\nThe successful requests; i.e. the requests which delivered data in the correct format\nand thereby resulted in successful archiving of data will get 200 OK response with a\nJSON message conveying number of records and the model to which it has\nbeen been added. This message looks like:\n\n```\n{\n status: OK\n msg: \"1 Customer added\"\n}\n```\n\nError handling is done through standard HTTP status codes where code 200 means successful\nreply (no errors) and any other code describes error conditions while executing the service. \nUsually error code is accompanied by JSON reply that further describes what went wrong. \nGenerally following error codes are used:\n\n* **400** – Means that there is something wrong with the request submitted by the client. \nUsually there is JSON-reply describing the error. In most cases it is caused by missing \nor malformed request body (JSON), missing mandatory fields in the JSON or Type errors, \ne.g character instead of number, date/time format issues etc. Below is an example of \nvisitors end point if an empty request body was sent.\n\n```\n{\n  \"status\": \"NOT OK\",\n  \"msg\": [\n    \"/visitors: error.path.missing\",\n    \"/date: error.path.missing\",\n    \"/organisation_id: error.path.missing\",\n    \"/time: error.path.missing\"\n  ]\n}\n```\n\n* **401** – This code means that authentication has failed, due to missing or incorrect access token in authorization header. The response JSON body would be:\n\n```\n{\n  \"status\":\"NOT OK\",\n  \"msg\":\"Unauthorized\"\n}\n```\n\n* **404** – Requested service does not exist or request method (eg. GET vs. POST) is incorrect. The response JSON in this case would be:\n\n```\n{\n  \"status\":\"NOT OK\",\n  \"msg\":\"End point requested does not exist\"\n}\n```\n\n* **500** – There was an internal error while processing the request. This is often a problem with the service itself. If this persists please contact Zoined service team with detailed information about the error\n\n```\n{\n  \"status\":\"NOT OK\",\n  \"msg\":\"An Exception Occurred\"\n}\n```\n\n* **503** – Service is entirely offline. This indicates maintenance break or problem with the infrastructure. If error persists, please contact support.\n\n## Frequently asked questions\n\nQ: How do I choose data format to send my data?</br>\nA: You need to set Content-Type header in your request to correct value. Zoined API currently supports either JSON or CSV data formats. Any other format is NOT supported and will cause error reply. \nBy default we assume content is `application/json` but it can be changed to CSV by adding header:\n\n```\nContent-Type: application/csv\n```\n\nQ: What is the number format?<br/>\nNo thousand separators. Use dot `.` as decimal separator.\n\nQ: What is the date format?<br/>\nA: All dates should be in ISO-format \"YYYY-MM-DD\".\n\nQ: How do I enter the time? What is \"Z\" at the end of the time example?<br/>\nA: Enter the time in 24 hour format \"H24:Mi:ss\". 'Z' stands for UTC time zone and is optional like all time zone information. \nZoined will always use local time so any time zone information is just ignored and no time zone conversions are done.\n\nQ: Do I enter values and headers with quotes (single or double) or without?<br/>\nA: For JSON, use double quotes for all headers and values. For CSV, do not use anything for either except when escaping special characters (see below).\n\nQ: How do I escape special characters in CSV?<br/>\nA: If field value has separator character (eg. `;`) backslash `\\` or double quote `\"` in it, you'll need to escape it by \nwrapping the field value with double quotes `\"` and prefixing any double quotes and backslashes with backslash. For example value \n`example;\\\"value\"` should be converted to `\"example;\\\\\\\"value\\\"\"`. Separator character can be specified with `separator` query string parameter. \nBy default we assume semicolon ';'. Escape characters ('\\' and '\"') cannot be changed.\n\nQ: What character encoding should be used?<br/>\nA: For JSON the standard specifies that character set should be Unicode with either UTF-8, UTF-16 or UTF-32 encoding.\nFor CSV you can use any character encoding where separators and other special characters are encoded with single byte. \nHence pure multi-byte encodings like UTF-16 are NOT supported with CSV format but mixed ones like UTF-8 are as long as special characters are encoded with single byte. \nEncoding should be specified with `encoding` query string parameter and it must correspond to encoding used in actual data. If unspecified then by default UTF-8 is assumed.\n\nQ: How to get best performance for bigger data volume uploads?<br/>\nA: First of don't send your data one row at a time by making separate API call for each row. \nThat will severely degrade performance of overall data load causing it to take significantly longer time to complete.\nInstead use fixed size chunks of suitable size (eg. 100000 rows per chunk) for each API call. \nJson format is also generally slightly faster to process than csv data format."}},"baseSlug":"/","routesMapping":{}}