{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e829be61-0a3c-4807-8706-5cd79cb9cafe","name":"UnifyWMS","description":"UnifyWMS API is available on the following URLs:\n\nProduction: https:://{tenant_domain}.unifywms.com/api/v1\n\nStaging: https:://{tenant_domain}.unifywms-staging.com/api/v1\n\n## Authentication\n\nTo authenticate on the API, you need an API token. You can create one in the UnifyWMS portal. API tokens are associated with the UnifyWMS account.\n\nWe strongly advise you to create a separate API token for each application that integrates with the UnifyWMS API. API tokens can be revoked at any time.\n\nEvery request to the API needs to have the `Authorization` header set like so:\n\n``` php\nAuthorization: Bearer YOUR_ACCESS_TOKEN\n\n ```\n\nWhen no, or an incorrect `Authorization` header is set, a 401 Unauthorized is returned.\n\n## Versioning\n\nThe API currently supports one version, which needs to be explicitly set in url: /api/v1\n\n## API Status\n\nThe API Status page provides real-time information about the operational status of the API and its components.\n\n  \n[https://status.unifywms.com](https://status.unifywms.com)\n\n## Rate Limit\n\nThe API uses a rate limit, it allows you to make up to 60 requests per minute.\n\nYou can check the returned HTTP headers of any API request to see your current rate limit status.\n\n**When still within the rate limit:**\n\n```\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 58\n\n ```\n\nWhere `Limit` indicates how many requests per minute are allowed, and `Remaining` how many requests are left for this minute.\n\n**When over the rate limit:**\n\nA 429 Too Many Requests response will be returned when the rate limit is reached, with the following headers set:\n\n```\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 0\n\n ```\n\n## Filtering\n\nYou can filter a resource by setting the `filter` params in the uri, like so:\n\n| type | uri formatting |\n| --- | --- |\n| single field / value | `/resource1?filter[field1]=value1` |\n| multiple values | `/resource1?filter[field1]=value1,value2` |\n| multiple fields | `/resource1?filter[field1]=value1&filter[field2]=value2` |\n\nThe available filters are specified per resource in the resource definition and will be either `exact` or `partial` filters:\n\n| filter type | description |\n| --- | --- |\n| exact | only resources exactly matching the value for the field will be returned |\n| partial | resources for which the passed value exists within the field will be returned |\n\n## Sorting\n\nYou can sort a resource by setting the `sort` param in the uri, like so:\n\n| type | uri formatting |\n| --- | --- |\n| single field ascending | `/resource1?sort=field1` |\n| single field descending | `/resource1?sort=-field1` |\n| multiple fields | `/resource1?sort=field1,-field2` |\n\nThe available sorts are specified per resource in the resource definition.\n\n## Including Resources\n\nWhen fetching a single or list of resources, the response will usually not include related resources by default.\n\nYou can include a resource by setting the `include` param in the uri, like so:\n\n| type | uri formatting |\n| --- | --- |\n| single | `/resource1?include=resource2` |\n| multiple | `/resource1?include=resource2,resource3` |\n| nested | `/resource1?include=resource2.nested_resource1` |\n| combined | `/resource1?include=resource2.nested_resource1,resource3` |\n\nThe available includes are specified per resource in the resource definition.\n\n## Cursor Pagination\n\nListing a resource will return a paginated response where the number of items returned is limited to a maximum of 100. Default is 30.\n\nYou can specify the page number and size like so: `/resource?page[size]=100&page[cursor]=eyJp`\n\nInformation about pagination is provided in the `links` and `meta` objects of a response. E.g.:\n\n``` json\n{\n  \"data\": [\n    {\n      \"...\": \"...\"\n    }\n  ],\n  \"links\": {\n        \"first\": null,\n        \"last\": null,\n        \"prev\": null,\n        \"next\": \"https://tenant1.unifywms.com/api/v1/accounts?page[cursor]=eyJpZCI6NjIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0\"\n    },\n    \"meta\": {\n        \"path\": \"https://tenant1.unifywms.com/api/v1/accounts\",\n        \"per_page\": 30,\n        \"next_cursor\": \"eyJpZCI6NjIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0\",\n        \"prev_cursor\": null\n    },\n    \"success\": true,\n    \"message\": null\n  }\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30621634","team":6119048,"collectionId":"e829be61-0a3c-4807-8706-5cd79cb9cafe","publishedId":"2sA35Bc4Px","public":true,"publicUrl":"https://docs.unifywms.com","privateUrl":"https://go.postman.co/documentation/30621634-e829be61-0a3c-4807-8706-5cd79cb9cafe","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/df9d69b1-59ca-4a38-9190-1733ae8ac890/d21zbG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/df9d69b1-59ca-4a38-9190-1733ae8ac890/d21zbG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-03-24T17:05:09.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/df9d69b1-59ca-4a38-9190-1733ae8ac890/d21zbG9nby5wbmc=","logoDark":"https://content.pstmn.io/df9d69b1-59ca-4a38-9190-1733ae8ac890/d21zbG9nby5wbmc="}},"statusCode":200},"environments":[],"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/73c87824256d661606a471e20dd7f20f9440443794c19f65cef969661244baf7","favicon":"https://unifywms.com/favicon.ico"},"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"}],"canonicalUrl":"https://docs.unifywms.com/view/metadata/2sA35Bc4Px"}