{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1fe2b3a3-2393-4022-ad6a-8f820fa0f1b9","name":"Shipway - All in One Shipping Solution APIs","description":"<p>The super most efficient eCommerce back-office automation system.<br>Shipway offers an easy API solution that lets your eCommerce store integrate with all the leading shipping solutions, warehouse management systems, and 3PL providers. The integration enables eCommerce brands to streamline forward and reverse shipments quickly and efficiently.</p>\n\nTo get started you need to\n\n<a href=\"https://app.shipway.com/register\">register with Shipway</a>\n\nfirst, create an account and complete the signup process.  \nNow, to Integrate your store and courier partner with your eCommerce platform follow these steps, Log In\n\n**Select Settings >**\n\n<a href=\"https://app.shipway.com/merchant.php?dispatch=vendor_carrier.manage&amp;tab=import_orders\"><b>Integrations</b></a>\n\n**\\> Select your channel to import orders**\n\n**Select Settings >**\n\n<a href=\"https://app.shipway.com/merchant.php?dispatch=vendor_carrier.manage&amp;tab=vendor_carrier\"><b>Manage Couriers</b></a>\n\n**\\> Select courier and fill the API credentials**\n\n# Shipway API Requirement\n\nUsing Shipway API, Developers can interface their system with Shipway Platform. The API is used to automate tasks and processing orders fast and efficiently.\n\n<h4>Authentication</h4>\n\nThe Shipway API uses Basic HTTP authentication. Use your Shipway **`Email`** as the username and **`License Key`** as the password. You can find your License Key as the password from,  \n**Shipway >Profile>Manage profile.**\n\nThe Authorization header is constructed as follows:\n\n<ul><li><div>Username (Email) and Password (License Key) are combined into a string \"username:password\".</div></li><li><div>The resulting string is then encoded in base64.</div></li></ul>\n\nPHP example:  \n$token = base64_encode(\"email:License key\");  \n$authHeaderString = 'Authorization: Basic ' . $token;\n\n# API Usage Guidelines\n\n<ul><li><div>Our API's use the basic HTTP request codes: <i>POST</i>, <i>GET</i></div></li><li><div>You can select the required response and request code language by selecting it from the drop down menu on the top.</div></li><li><div>You can test all our APIs by importing the full API collection through the <b>'Run in Postman'</b> button, and running them in the Postman app.</div></li><li><div><b>Note</b>: Any requests made using the valid API credentials will affect the real time data in your Shipway account.</div></li><li><p>Please note that in order to use the generated token in your own code, you will need to pass the token in the following format in the appropriate header of your code :</p><pre class=\"plain\"><code><div>      Authorization: Bearer \n<br></div></code></pre></li></ul>\n\n<p>All the APIs are provided with their appropriate example requests and responses for successful and failure calls. The example definitions are:</p>\n\n<ul><li><div><b>Successful Call</b>: The correct API call was made.</div></li><li><div><b>Invalid Data</b>: The invalid data was entered.</div></li></ul>\n\n# Error And Response Codes\n\n<table><tbody><tr><th>Status Code</th><th>Response</th><th>Description</th></tr><tr><td><div><code>201</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Created</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The request is successful and an order is created.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>400</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Bad Request</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>The request is missing required parameters.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>401</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Unauthorized</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Authentication failed.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>403</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Forbidden</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Access denied.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>404</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Not Found</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Resource is not found.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>405</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Method not allowed</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Requested method is not supported for the specified resource.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><code>500</code></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Internal Server Error</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Shipway has encountered an error.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14217096","team":1513129,"collectionId":"1fe2b3a3-2393-4022-ad6a-8f820fa0f1b9","publishedId":"TW74hQ7r","public":true,"publicUrl":"https://apidocs.shipway.com","privateUrl":"https://go.postman.co/documentation/14217096-1fe2b3a3-2393-4022-ad6a-8f820fa0f1b9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-01-20T05:52:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/ba3e0d6ee482a5532adfb44b750c006995f4bc74e0d768fce8755a86442d1c23","favicon":"https://res.cloudinary.com/postman/image/upload/v1617789330/team/s2cj1izlam7yrdcevtz2.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://apidocs.shipway.com/view/metadata/TW74hQ7r"}