{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b0456acb-7a1d-4e5a-bcc5-82f19670a93d","name":"OrderEZ - Supplier [Tray]","description":"# Authentication\n\nEvery request must contain `Authorization` header with value `Bearer [ACCESS-TOKEN]` . For integration purposes, we are issuing long-lived tokens, valid only for set of endpoints included in this documentation.\n\n#### **Sandbox environment**\n\nAPI URL: [https://api-staging.orderez.co/](https://api-staging.orderez.co/)  \nApplication URL: [https://app-staging.orderez.co/](https://app-staging.orderez.co/)  \nFor creating sandbox accounts and their tokens, please send a request to `petra@weareneopix.com`\n\n# Response formats\n\n#### Status code `200`\n\nWhen there is data to return, it will be found in `data` property of response object:\n\n*   **Object** as a response\n    \n\n```\n{\n    \"data\": {\n        \"name\": \"OrderEZ\",\n        \"developedBy\": \"Neopix\"\n    }\n}\n\n```\n\n*   **Array** as a response\n    \n\n```\n{\n  \"data\": [\n      // an array\n      {\n          // of objects\n      }\n    ]\n}\n\n```\n\nSuccessful response can also contain `meta` fields in case of pagination responses.\n\n#### Status codes `40x`\n\n*Note:* `type` is an error type which can be seen as an enum, so client side code can do enum like handling of the errors with these codes.\n\n```\n{\n    \"error\": {\n        \"message\": \"This is some user friendly message.\",\n        \"type\": \"error_type\"\n    }\n}\n\n```\n\n#### Status code `422` (validation errors)\n\n```\n{\n    \"error\": {\n        \"fields\": {\n            \"username\": [\n                \"Username must be an email.\",\n                \"Username should not be empty.\"\n            ],\n            \"password\": [\n                \"Password must be longer than or equal to 6 characters.\",\n                \"Password should not be empty.\"\n            ]\n        },\n        \"type\": \"UnprocessableEntityException\"\n    }\n}\n\n```\n\n# Pagination\n\nIndex endpoints use cursor pagination. Most of them return items sorted by id, as a default. Some of the endpoints support sorting by other fields, sent as `sortBy` parameter.\n\nPagination works via following query params:\n\n`limit` - Number of entities returned in one call. Default value is 10.\n\n`nextId` - The id of the first entity in the next page. This value is returned in `meta` object in previous response. Not needed for first page.\n\n`nextValue` - if `sortBy` param is set, `nextValue` from `meta` object needs to be included as query param along with `nextId`.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3171682","team":184758,"collectionId":"b0456acb-7a1d-4e5a-bcc5-82f19670a93d","publishedId":"UzXPww6n","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3171682/UzXPww6n","privateUrl":"https://go.postman.co/documentation/3171682-b0456acb-7a1d-4e5a-bcc5-82f19670a93d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4875F0"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-28T16:05:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"OrderEZ - staging","id":"3ab39472-85d4-4394-b657-19d8089fb082","owner":"3171682","values":[{"key":"domain","value":"https://api-staging.orderez.co","enabled":true},{"key":"accessToken","value":"12ea70344abf26d9a8f9e41630b71be255d96aa1","enabled":true},{"key":"refreshToken","value":"60ce194cbbea1925b76ecdeb7e1778bf8799958c","enabled":true},{"key":"venueId","value":3,"enabled":true},{"key":"distributorId","value":1,"enabled":true},{"key":"productId","value":"","enabled":true},{"key":"categoryId","value":"","enabled":true},{"key":"distributorAccessToken","value":"e6c7f03bb4fd6114179a148ab2aae6dc7b1d6a99","enabled":true},{"key":"distributorRefreshToken","value":"c1d8b7d2a0ebf9a19782fe07250c2ae131919a55","enabled":true},{"key":"venueAccessToken","value":"83092d2e5daa48bc761a19002bad152b5826de2a","enabled":true},{"key":"venueRefreshToken","value":"fe81791990e5d9021f276e3fd78c334d59804925","enabled":true},{"key":"orderId","value":121,"enabled":true},{"key":"venueGroupUserId","value":38,"enabled":true},{"key":"managerAccessToken","value":"e6c7f03bb4fd6114179a148ab2aae6dc7b1d6a99","enabled":true},{"key":"adminAccessToken","value":"","enabled":true,"type":"any"},{"key":"adminRefreshToken","value":"","enabled":true,"type":"any"},{"key":"netsuiteAccessToken","value":"","enabled":true,"type":"any"},{"key":"token","value":"","enabled":true,"type":"any"},{"key":"stapleAccessToken","value":"","enabled":true,"type":"any"},{"key":"stapleApiKey","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d28801ea94586fcdbb6dbab18a48ebd42791c4ccaaec5b657bac48e6a7a2ef5a","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"OrderEZ - staging","value":"3171682-3ab39472-85d4-4394-b657-19d8089fb082"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UzXPww6n"}