{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ec16962a-b8e9-4d6b-b4f0-94245d862b40","name":"NoParcels API documentation","description":"Before you read the whole documentation you need to know the standard procedure to fully make a shipment:\n\n1. [Create ](https://documentation.noparcels.com/#fc758a12-c30c-4789-a852-2008ad7f1dc2) a shipment.\n    \n2. [Confirm ](https://documentation.noparcels.com/#50dd2f3a-33de-45b7-96b3-9f4a8921e6b6) the created shipment.\n    \n3. [Download ](https://documentation.noparcels.com/#d444731d-f434-44fb-aca8-8b16f2021843) the label.\n    \n4. [Create a manifest](https://documentation.noparcels.com/#f793cc53-b4d6-4060-9368-94fc107e4c70) and call the courier for pickup if required.\n    \n5. [Download](https://documentation.noparcels.com/#ed74c624-f7e0-4f78-95b3-6690eb9c8372) manifest if required.\n    \n\n## Examples\n\nPHP example - [our Github page](https://github.com/Multiparcels/api-example-php).\n\n**Usage Overview**  \nHere are some information that should help you understand the basic usage of our RESTful API. Including info about authenticating users, making requests, responses, pagination, query parameters and more.\n\n## **Headers**\n\nCertain API calls require you to send data in a particular format as part of the API call. By default, all API calls expect input in `JSON` format, however you need to inform the server that you are sending a JSON-formatted payload. And to do that you must include the `Accept => application/json` HTTP header with every call.\n\n| **Header** | **Value Sample** | When to send it |\n| --- | --- | --- |\n| Accept | `application/json` | MUST be sent with every endpoint. |\n| Content-Type | `application/x-www-form-urlencoded` | MUST be sent when passing Data. |\n| Authorization | `Bearer {Api-Token-Here}` | MUST be sent with every endpoint. |\n\n## Pagination\n\nBy default, all fetch requests return the first `10` items in the list. Check the **Query Parameters** for how to control the pagination.\n\n## **Limit:**\n\nThe `?limit=` parameter can be applied to define, how many record should be returned by the endpoint (see also `Pagination`!).\n\n**Usage:**\n\n`https://app.noparcels.com/endpoint?limit=100`\n\nThe above example returns 100 resources.\n\nThe `limit` and `page` query parameters can be combined in order to get the next 100 resources:\n\n`https://app.noparcels.com/endpoint?limit=100&page=2`\n\nYou can skip the pagination limit to get all the data, by adding `?limit=0`, this will only work if 'skip pagination' is enabled on the server.\n\n## **Responses**\n\nUnless otherwise specified, all of API endpoints will return the information that you request in the JSON data format.\n\n## **Query Parameters**\n\nQuery parameters are optional, you can apply them to some endpoints whenever you need them.\n\n### Ordering\n\nThe `?orderBy=` parameter can be applied to any **`GET`** HTTP request responsible for ordering the listing of the records by a field.\n\n**Usage:**\n\n`https://app.noparcels.com/endpoint?orderBy=created_at`\n\n### Sorting\n\nThe `?sortedBy=` parameter is usually used with the `orderBy` parameter.\n\nBy default the `orderBy` sorts the data in **ascending** order, if you want the data sorted in **descending** order, you can add `&sortedBy=desc`.\n\n**Usage:**\n\n`https://app.noparcels.com/endpoint?orderBy=name&sortedBy=desc`\n\nOrder By Accepts:\n\n- `asc` for Ascending\n    \n- `desc` for Descending\n    \n\n### Searching\n\nThe `?search=` parameter can be applied to any **`GET`** HTTP request.\n\n**Usage:**\n\n`https://app.noparcels.com/endpoint?search=keywordhere`\n\n> Space should be replaced with (search=keyword here). \n  \n\nSearch any field for multiple keywords:\n\n`https://app.noparcels.com/endpoint?search=field:firstkeyword;secondkeyword`\n\nSearch in specific field:\n\n`https://app.noparcels.com/endpoint?search=field:keywordhere`\n\nSearch in specific fields for multiple keywords:\n\n`https://app.noparcels.com/endpoint?search=field1:first field keyword;field2:second field keyword`\n\nDefine query condition:\n\n`https://app.noparcels.com/endpointsearch=field:keyword&searchFields=name:like`\n\nAvailable Conditions:\n\n- `like`: string like the field. (SQL query `%keyword%`).\n    \n- `=`: string exact match.\n    \n\nDefine query condition for multiple fields:\n\n`https://app.noparcels.com/endpoint?search=field1:first keyword;field2:secondkeyword&searchFields=field1:like;field2:=;`\n\n### Filtering\n\nThe `?filter=` parameter can be applied to any HTTP request. And is used to control the response size, by defining what data you want back in the response.\n\n**Usage:**\n\nReturn only ID and Name from that Model, (everything else will be returned as `null`).\n\n`https://app.noparcels.com/endpoint?filter=id;status`\n\nExample Response, including only id and status:\n\n``` json\n{\n  \"data\": [\n    {\n      \"id\": \"0one37vjk49rp5ym\",\n      \"status\": \"approved\",\n      \"products\": {\n        \"data\": [\n          {\n            \"id\": \"bmo7y84xpgeza06k\",\n            \"status\": \"pending\"\n          },\n          {\n            \"id\": \"o0wzxbg0q4k7jp9d\",\n            \"status\": \"fulfilled\"\n          }\n        ]\n      },\n      \"recipients\": {\n        \"data\": [\n          {\n            \"id\": \"r6lbekg8rv5ozyad\"\n          }\n        ]\n      },\n      \"store\": {\n        \"data\": {\n          \"id\": \"r6lbekg8rv5ozyad\"\n        }\n      }\n    }...\n\n ```\n\n### Paginating\n\nThe `?page=` parameter can be applied to any **`GET`** HTTP request responsible for listing records (mainly for Paginated data).\n\n**Usage:**\n\n`https://app.noparcels.com/endpoint?page=200`\n\n_The pagination object is always returned in the_ _**meta**_ _when pagination is available on the endpoint._\n\n``` json\n\"data\": [...],\n  \"meta\": {\n    \"pagination\": {\n      \"total\": 2000,\n      \"count\": 30,\n      \"per_page\": 30,\n      \"current_page\": 22,\n      \"total_pages\": 1111,\n      \"links\": {\n        \"previous\": \"http://https://api.test/endpoint?page=21\"\n      }\n    }\n  }\n\n ```\n\n### Relationships\n\nThe `?include=` parameter can be used with any endpoint, only if it supports it.\n\nHow to use it: let's say there's a Driver object and Car object. And there's an endpoint `/cars` that returns all the cars objects. The include allows getting the cars with their drivers `/cars?include=drivers`.\n\nHowever, for this parameter to work, the endpoint `/cars` should clearly define that it accepts `driver` as relationship (in the **Available Relationships** section).\n\n**Usage:**\n\n`https://app.noparcels.com/endpoint?include=relationship`\n\nEvery response contain an `include` in its `meta` as follow:\n\n``` json\n  \"meta\":{\n      \"include\":[\n         \"relationship-1\",\n         \"relationship-2\",\n      ],\n\n ```\n\n## Error codes\n\nExample error response\n\n``` json\n{\n    \"status\": \"error\",\n    \"code\": 101001,\n    \"message\": \"Shipment already confirmed\",\n    \"status_code\": 400\n}\n\n ```\n\n| **Error code** | **Title** | **Description** |\n| --- | --- | --- |\n| 405 | Method Not Allowed! | Method Not Allowed! |\n| 404 | Not found | Not found |\n| 1121 | This action is unauthorized. | You are not allowed to access this resource. |\n| 1501 | The given data was invalid. | One or more validation rules have failed. Check errors field |\n| 100001 | Shipment already confirmed | The shipment has already been confirmed and cannot be confirmed again |\n| 100002 | Shipment confirmation failed | Something went wrong with the confirmation. Try again or contact us. This incident has been reported. |\n| 100003 | Not all labels are downloaded | Please try again in few seconds to allow few seconds for download |\n| 100004 | Selected location not found | Selected terminal or pickup point not found |\n| 200001 | Invalid shipments cannot be added to manifest. | The shipments must be confirmed and can not be in other manifests. |\n| 200002 | Manifest has not been downloaded yet | Please try again in few seconds to allow few seconds for download |\n| 200003 | This manifest has already been canceled. | No need to cancel it two times. |\n| 200004 | Multiple carrier shipments have been selected | Please select only one carrier shipments |\n| 200005 | Manifest was not closed | Please read the error message for more details |\n\n### Failed validation rules\n\nExample validation error response\n\n``` json\n{\n    \"status\": \"error\",\n    \"code\": 1501,\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"identifier\": [\n            {\n                \"text\": \"The identifier has already been taken.\",\n                \"rule\": \"UNIQUE\"\n            }\n        ]\n    },\n    \"status_code\": 422\n}\n\n ```\n\nIf for example you see rule `UNIQUE` means the unique check failed.\n\n| **Error code** | **Title** |\n| --- | --- |\n| UNIQUE | The field value already exists. Select a different value. |\n| REQUIRED | This field always required. |\n| REQUIRED_IF | This field is required with other fields. For example COD value and currency must be provided when COD service is enabled. |\n| MAYBE_REQUIRED | This field is required unless shipment picked up/delivered to terminal/pickup point. |\n| VALID_POSTAL_CODE_RULE | Provided postal code is not valid for specified country or does not exist. |\n| VALID_PHONE_NUMBER_RULE | Provided mobile phone number not valid for specified country or not mobile number. |\n| EMAIL | The provided email does not validate as a valid email. |\n| EXISTS | The selected value does not exist or is not valid. |\n| INTEGER | The value must be an integer. |\n| NUMERIC | The value must be an numeric. |\n| MIN | The value may not be less than specified length. |\n| MAX | The value may not be greater than specified length. |\n| ARRAY | The filed must be an array |\n| PACKAGE_SIZES_VALIDATE | The value is not extra-small, small, medium, large, extra-large or does not met 1x1x1 dimensions format. |\n| COD_CURRENCY_VALIDATE | Invalid currency specified for COD. The currency must match the currency of the reveiver's country. |\n| ALLOWED_COURIER_FOR_COMPANY_RULE | Your company is not allowed to use this courier. |\n| FIND_ROUTE | Route not found. Such pickup/delivery/services/packages combination is not enabled. If you believe it should be - please contact us. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"46383575","team":8618554,"collectionId":"ec16962a-b8e9-4d6b-b4f0-94245d862b40","publishedId":"2sB34eKhmV","public":true,"publicUrl":"https://documentation.noparcels.com","privateUrl":"https://go.postman.co/documentation/46383575-ec16962a-b8e9-4d6b-b4f0-94245d862b40","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2dba74"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"2dba74"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2dba74"}}]}},"version":"8.10.1","publishDate":"2025-08-12T09:44:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/f393ad763f44478a0ab15e7f28a524e6b42e3101f65c77fd5d408e9d93cfcbb1","favicon":"https://noparcels.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://documentation.noparcels.com/view/metadata/2sB34eKhmV"}