{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a74f1cfd-2b69-4a79-916a-5bda1b84050d","name":"InPost UK API V4 Official","description":"\r\n\r\n# Overall\r\n\r\n\r\n## Parcel LifeCycle\r\n\r\nStatuses listed below are the components of the basic parcel life cycle:\r\n\r\n- #### Created\r\n  After receiving the correct required parameters, which are necessary for the parcel object to be created, the InPost System creates a parcel object. If the 'Pay' resource has not been called the parcel will not be processed any further.\r\n\r\n- #### Prepared\r\n  The consignment is 'Payed' for within the InPost system. As part of this step the user will need to print the label from the InPost System or produce their own label (Self Labelling) to put on the package. This is the first step of the dispatch process, the parcel is now ready for shipping.\r\n\r\n- #### Sent\r\n\r\n  The parcel is now at the beginning of the shipment process, the courier has picked up the parcel.\r\n\r\n- #### InTransit\r\n\r\n  The parcel is being transported from the source point to the target parcel machine (locker terminal).\r\n\r\n- #### Stored\r\n\r\n  The parcel has reached the target parcel machine (locker terminal) and is ready to be collected by the recipient. A notification (SMS and/or e-mail if held) is sent to the customer with the collection code and location of the parcel machine (locker terminal) to be picked up.\r\n\r\n- #### Delivered\r\n\r\n  Once the customer picks up the parcel from the parcel machine (locker terminal), the status is set to delivered and the life cycle is complete.\r\n\r\n  Other statuses that can be returned by the InPost API:\r\n\r\n- #### CustomerDelivering\r\n\r\n  The parcel is ready to be delivered to parcel machine (locker terminal) by the individual client (only applicable for Locker to Address scenario).\r\n\r\n- #### CustomerStored\r\n\r\n  The parcel has been stored by the customer. Used in Locker to Address scenario only.\r\n\r\n- #### Avizo\r\n\r\n  The parcel has not been collected in the specified time period. This triggers a reminder notification advising the parcel is waiting to be collected.\r\n\r\n- #### Expired\r\n\r\n  The parcel has not been collected by the recipient and it cannot be collected from the parcel machine (locker terminal) any more. Therefore, the parcel will be collected by the courier and returned to sender.\r\n\r\n- #### ReturnedToAgency\r\n\r\n  An uncollected parcel has been taken by the courier from the parcel machine (locker terminal) and returned to sender.\r\n\r\n- #### DeliveredToAgency\r\n\r\n  An uncollected parcel has been delivered back to the sender.\r\n\r\n- #### Cancelled\r\n\r\n  Parcel in the 'Sent' status has been cancelled. It is no longer available for collection.\r\n\r\n- #### LabelExpired\r\n\r\n  When the label is expired, the parcel machine (locker terminal) will not accept the parcel.\r\n\r\n- #### NotDelivered\r\n\r\n  When it is not possible to deliver the parcel into the parcel machine (locker terminal).\r\n\r\n- #### Claimed\r\n\r\n  Parcel status changed manually to claimed to stop collection.\r\n\r\n- #### Missing\r\n\r\n  Parcel was not found inside the machine (locker terminal).\r\n\r\n\r\n## Locker Sizes\r\n\r\n  The machine (locker terminal) is fitted with 3 locker sizes.\r\n\r\n- ##### Size A (SMALL)\r\n\r\n  ##### 8 cm x 38 cm x 64 cm\r\n\r\n- ##### Size B (MEDIUM)\r\n\r\n  ##### 19 cm x 38 cm x 64 cm\r\n\r\n- ##### Size C (LARGE)\r\n\r\n  ##### 41 cm x 38 cm x 64 cm\r\n\r\n## Endpoints\r\nThe InPost API can be found via the following endpoints: \r\n**Live/Production**: https://api-uk.easypack24.net/v4/\r\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"10555029","team":760305,"collectionId":"a74f1cfd-2b69-4a79-916a-5bda1b84050d","publishedId":"SzS2w8BR","public":true,"publicUrl":"https://documenter-api.postman.tech/view/10555029/SzS2w8BR","privateUrl":"https://go.postman.co/documentation/10555029-a74f1cfd-2b69-4a79-916a-5bda1b84050d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FECD03"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2020-03-13T20:18:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"InPost UK Prod Test","id":"43a80ef4-563c-4f5d-9ff9-83e3159052b9","owner":"10555029","values":[{"key":"token","value":"Bearer YOUR_TOKEN","enabled":true},{"key":"parcelId","value":"5934024283154413","enabled":true},{"key":"endpoint","value":"https://api-uk.easypack24.net/v4/","enabled":true},{"key":"customerId","value":"InteTestProd@inpost.co.uk","enabled":true},{"key":"machineId","value":"UKPEN10374","enabled":true}],"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/f3aa75e1fbaa4599a9a43f42e86050f24f4ea905b2ec4994623f7c0a2b59f777","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":"InPost UK Prod Test","value":"10555029-43a80ef4-563c-4f5d-9ff9-83e3159052b9"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SzS2w8BR"}