Collection of out-of-the-box requests to use for custom integrations with Parcel Tracker.
\nOur external-facing API uses an api key to authenticate requests. Please ask your point of contact for an API key
\nYou can then authenticate all requests including the following header
\nAuthorization: ApiKey {apikey}\n\nThe id of the development where the parcels are located
\n","type":"text/plain"},"key":"development_id","value":"1"},{"description":{"content":"[Optional] Filter parcels to only include those added to the system after this timestamp
\n","type":"text/plain"},"key":"logged_in_since","value":null},{"description":{"content":"[Optional] Filter parcels to only include those updated after this timestamp. An update includes any action on the parcel (e.g. log in, log out, details change, etc.)
\n","type":"text/plain"},"key":"updated_since","value":null},{"description":{"content":"[Optional] Filter parcels to only include those whose recipient external id matches the filter
\n","type":"text/plain"},"key":"recipient_external_id","value":null},{"description":{"content":"[Optional] Filter parcels to only include those whose recipient email matches the filter
\n","type":"text/plain"},"key":"recipient_email","value":null},{"description":{"content":"Page used for navigation
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Size of the page. The value should be between 1 and 100
\n","type":"text/plain"},"key":"page_size","value":"10"}],"variable":[]}},"response":[{"id":"10e3d8a4-bbcd-4d33-a927-b97bffd18347","name":"New Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}"}],"url":{"raw":"https://api.parceltracker.com/api/v2/public/parcels?development_id=1&logged_in_since&updated_since&recipient_external_id&recipient_email&page=1&page_size=10","protocol":"https","host":["api","parceltracker","com"],"path":["api","v2","public","parcels"],"query":[{"key":"development_id","value":"1"},{"key":"logged_in_since","value":null},{"key":"updated_since","value":null},{"key":"recipient_external_id","value":null},{"key":"recipient_email","value":null},{"key":"page","value":"1"},{"key":"page_size","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 09 Jun 2024 14:51:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1507"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ARRAffinity=06dece71727ab2c9a75506862155277ef8948b1004ad39e70a73eb837c7bf7ad;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=06dece71727ab2c9a75506862155277ef8948b1004ad39e70a73eb837c7bf7ad;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Security-Policy","value":"default-src 'none'; frame-ancestors 'none'; sandbox"},{"key":"x-azure-ref","value":"20240609T145100Z-175dcb64d5cwhp5qe0cp5tns4n0000000h3g000000005tfc"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"Page\": 1,\n \"PageSize\": 10,\n \"TotalPages\": 1,\n \"TotalResults\": 4,\n \"Elements\": [\n {\n \"Id\": \"b0cbc013-25bf-4398-a2df-c92ef68def7c\",\n \"TrackingNumber\": null,\n \"Courier\": null,\n \"Barcode\": \"26038\",\n \"LoggedIn\": \"2024-03-30T19:59:03.903Z\",\n \"LoggedOut\": null,\n \"Notes\": null,\n \"CollectionNotes\": null,\n \"Quantity\": 1,\n \"DocId\": null,\n \"Size\": null,\n \"LastUpdated\": \"2024-03-30T19:59:07.387Z\",\n \"Status\": \"Received\",\n \"Recipient\": {\n \"Id\": \"00b68908-6843-4c62-9c0c-e8016d0dae32\",\n \"ExternalId\": null,\n \"FirstName\": \"Eric\",\n \"LastName\": \"Lucas\",\n \"Alias\": null,\n \"Email\": \"test@test.test\",\n \"Phone\": null,\n \"Location\": \"Edison 1\"\n }\n },\n {\n \"Id\": \"cac35a93-57c5-4dba-b345-869e76f78de9\",\n \"TrackingNumber\": null,\n \"Courier\": null,\n \"Barcode\": \"69223\",\n \"LoggedIn\": \"2024-03-30T19:58:23.997Z\",\n \"LoggedOut\": null,\n \"Notes\": null,\n \"CollectionNotes\": null,\n \"Quantity\": 1,\n \"DocId\": null,\n \"Size\": null,\n \"LastUpdated\": \"2024-03-30T19:58:26.707Z\",\n \"Status\": \"Received\",\n \"Recipient\": {\n \"Id\": \"00b68908-6843-4c62-9c0c-e8016d0dae32\",\n \"ExternalId\": null,\n \"FirstName\": \"Eric\",\n \"LastName\": \"Lucas\",\n \"Alias\": null,\n \"Email\": \"test@test.test\",\n \"Phone\": null,\n \"Location\": \"Edison 1\"\n }\n },\n {\n \"Id\": \"e9369eb5-1359-4e81-9b79-fd59c987f429\",\n \"TrackingNumber\": \"9505510041018320003872\",\n \"Courier\": \"United States Postal Service\",\n \"Barcode\": \"]C142020121\\u001d9505510041018320003872\",\n \"LoggedIn\": \"2023-06-15T10:22:08.433Z\",\n \"LoggedOut\": \"2023-06-15T10:35:30.210Z\",\n \"Notes\": null,\n \"CollectionNotes\": \"\",\n \"Quantity\": null,\n \"DocId\": null,\n \"Size\": null,\n \"LastUpdated\": \"2023-06-15T10:35:38.420Z\",\n \"Status\": \"Collected\",\n \"Recipient\": {\n \"Id\": \"8eb755cd-c086-43ed-adf9-2afe6c7048fa\",\n \"ExternalId\": null,\n \"FirstName\": \"Isaac\",\n \"LastName\": \"Newton\",\n \"Alias\": null,\n \"Email\": \"isaac@parceltracker.com\",\n \"Phone\": \"\",\n \"Location\": \"Trinity\"\n }\n },\n {\n \"Id\": \"40fd2778-e033-482c-ae94-5bae984f8674\",\n \"TrackingNumber\": \"QE0017326078\",\n \"Courier\": \"Amazon\",\n \"Barcode\": \"Q80559948883\",\n \"LoggedIn\": \"2023-06-15T10:22:00.367Z\",\n \"LoggedOut\": \"2023-06-15T10:35:30.210Z\",\n \"Notes\": null,\n \"CollectionNotes\": \"\",\n \"Quantity\": null,\n \"DocId\": null,\n \"Size\": null,\n \"LastUpdated\": \"2023-06-15T10:35:38.093Z\",\n \"Status\": \"Collected\",\n \"Recipient\": {\n \"Id\": \"8eb755cd-c086-43ed-adf9-2afe6c7048fa\",\n \"ExternalId\": null,\n \"FirstName\": \"Isaac\",\n \"LastName\": \"Newton\",\n \"Alias\": null,\n \"Email\": \"isaac@parceltracker.com\",\n \"Phone\": \"\",\n \"Location\": \"Trinity\"\n }\n }\n ]\n}"}],"_postman_id":"90e13e0f-350d-4574-9784-171362897d65"},{"name":"Check-out parcels","id":"369bef97-a4b0-4005-ab05-74624917d742","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ParcelIds\": [ \"30d5eadb-c983-45d7-820f-015b7af1fe60\" ],\r\n \"CollectionNotes\": \"Left on the porch\",\r\n \"SendNotifications\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.parceltracker.com/api/v2/public/parcels/collect","description":"Mark one or more parcels as checked out (collected) based on their Id. Optionally specify the collection notes to be shown in the parcel record and whether to send notifications to the recipient about checking-out
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b834d77e-4f4c-4307-a990-fee8b5b79087","id":"b834d77e-4f4c-4307-a990-fee8b5b79087","name":"v2","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v2","public","parcels","collect"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"b5d4ba5c-72a2-4a9c-b83f-3b75f08b6b4e","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ParcelIds\": [ \"30d5eadb-c983-45d7-820f-015b7af1fe60\" ],\r\n \"CollectionNotes\": \"Left on the porch\",\r\n \"SendNotifications\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.parceltracker.com/api/v2/public/parcels/collect"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 08 Jan 2025 10:26:42 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ARRAffinity=9a8f0e0000b8e644978be53e4421da1aa8e6895923dacdc15da621f88ed4a71c;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=9a8f0e0000b8e644978be53e4421da1aa8e6895923dacdc15da621f88ed4a71c;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Security-Policy","value":"default-src 'none'; frame-ancestors 'none'; sandbox"},{"key":"x-azure-ref","value":"20250108T102641Z-15996d9d69drp4b5hC1PAR6xag00000003pg000000003rhn"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"369bef97-a4b0-4005-ab05-74624917d742"}],"id":"b1325301-ae9e-4af2-9c3a-acc56ff3c21a","_postman_id":"b1325301-ae9e-4af2-9c3a-acc56ff3c21a","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b834d77e-4f4c-4307-a990-fee8b5b79087","id":"b834d77e-4f4c-4307-a990-fee8b5b79087","name":"v2","type":"folder"}}}],"id":"b834d77e-4f4c-4307-a990-fee8b5b79087","description":"This version introduces a number of improvements over the legacy version.
\nThe main changes and improvement include:
\nMore operations and filtering options (no longer limited to CRUD)
\nCustomer-supplied ExternalIds are now the default way of accessing recipients (previously called tenants)
Related entities are now included in the response body
\nMultimailroom is fully supported
\nThe id of the recipient (tenant)
\n","type":"text/plain"},"key":"tenant_id","value":"8EB755CD-C086-43ED-ADF9-2AFE6C7048FA"},{"description":{"content":"Page number (starts at 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of results per page (default 200, max 20000)
\n","type":"text/plain"},"key":"page_size","value":"3"},{"description":{"content":"(optional) if true returns a url to the signature image of the tenant, when available
\n","type":"text/plain"},"key":"include_signature","value":"true"},{"description":{"content":"(optional) if true returns a url to the photo of the parcel box, when available
\n","type":"text/plain"},"key":"include_photo","value":"true"}],"variable":[]}},"response":[{"id":"ed6f83fd-5031-47f0-aa59-399264e3a60c","name":"Get parcels by tenant","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":{"raw":"https://api.parceltracker.com/api/public/parcels?tenant_id=8EB755CD-C086-43ED-ADF9-2AFE6C7048FA&page=1&page_size=3&include_signature=true&include_photo=true","protocol":"https","host":["api","parceltracker","com"],"path":["api","public","parcels"],"query":[{"key":"tenant_id","value":"8EB755CD-C086-43ED-ADF9-2AFE6C7048FA"},{"key":"page","value":"1"},{"key":"page_size","value":"3"},{"key":"include_signature","value":"true"},{"key":"include_photo","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1336"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"0Xng4ZAAAAAB6xfckF+j4Spmr/RpiNi48TUlMMzBFREdFMDYxNQBmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 21:47:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Page\": 1,\n \"PageSize\": 3,\n \"TotalPages\": 3,\n \"TotalResults\": 9,\n \"Elements\": [\n {\n \"PhotoUrl\": \"https://parceltrackerstore.s3.eu-west-2.amazonaws.com/parcels/3e52747e-12ee-44e0-9ea6-07d161285901.png?X-Amz-Expires=604800&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARFIFG5ENEEMQELHV/20230413/eu-west-2/s3/aws4_request&X-Amz-Date=20230413T214710Z&X-Amz-SignedHeaders=host&X-Amz-Signature=e8ddb492cc40e6c6e62e20d10b55aed47b509c24b0b764087e305b7baeb49e64\",\n \"SignatureUrl\": \"https://parceltrackerstore.s3.eu-west-2.amazonaws.com/signatures/032d30fe-6222-44d8-a7eb-8b475e5bf2fe.png?X-Amz-Expires=604800&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARFIFG5ENEEMQELHV/20230413/eu-west-2/s3/aws4_request&X-Amz-Date=20230413T214711Z&X-Amz-SignedHeaders=host&X-Amz-Signature=c18b453c1241361c79034451eb0735224774d724a3fa75acb0f8f822c8901b07\",\n \"Id\": \"3e52747e-12ee-44e0-9ea6-07d161285901\",\n \"SessionId\": \"032d30fe-6222-44d8-a7eb-8b475e5bf2fe\",\n \"Source\": null,\n \"Courier\": \"United States Postal Service\",\n \"LoggedIn\": \"2023-01-19T15:06:43.273\",\n \"Data\": \"SD1yz13WvN_001_v\",\n \"Data2\": \"]C142020121\\u001d9505510041018320003872\",\n \"Data3\": \"\",\n \"LoggedInBy\": \"3ef8dccc-f6a8-4674-a082-94c6188520de\",\n \"LoggedOutBy\": \"3ef8dccc-f6a8-4674-a082-94c6188520de\",\n \"TenantId\": \"8eb755cd-c086-43ed-adf9-2afe6c7048fa\",\n \"Collected\": null\n },\n {\n \"PhotoUrl\": \"https://parceltrackerstore.s3.eu-west-2.amazonaws.com/parcels/5924e26b-acd6-4102-96c6-6254f8ae6749.png?X-Amz-Expires=604800&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARFIFG5ENEEMQELHV/20230413/eu-west-2/s3/aws4_request&X-Amz-Date=20230413T214711Z&X-Amz-SignedHeaders=host&X-Amz-Signature=70a8d88a64bb40d795d477d0d7495da884f7a75496c92a777541117dde54f3dd\",\n \"SignatureUrl\": null,\n \"Id\": \"5924e26b-acd6-4102-96c6-6254f8ae6749\",\n \"SessionId\": \"88a43476-2b95-4256-9aa1-e9a67e45e0a9\",\n \"Source\": null,\n \"Courier\": \"Amazon\",\n \"LoggedIn\": \"2023-03-13T10:25:50.263\",\n \"Data\": \"Q80559948883\",\n \"Data2\": \"QE0017326078\",\n \"Data3\": \"SDlFRRCw8N_001_v\",\n \"LoggedInBy\": \"3ef8dccc-f6a8-4674-a082-94c6188520de\",\n \"LoggedOutBy\": \"3ef8dccc-f6a8-4674-a082-94c6188520de\",\n \"TenantId\": \"8eb755cd-c086-43ed-adf9-2afe6c7048fa\",\n \"Collected\": null\n },\n {\n \"PhotoUrl\": \"https://parceltrackerstore.s3.eu-west-2.amazonaws.com/parcels/b13b93da-5e2c-405d-838e-7660998418dc.png?X-Amz-Expires=604800&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARFIFG5ENEEMQELHV/20230413/eu-west-2/s3/aws4_request&X-Amz-Date=20230413T214711Z&X-Amz-SignedHeaders=host&X-Amz-Signature=4f91f080722f36395d510dc1b17be91f46d5837434fbf90d81fa39d67542176f\",\n \"SignatureUrl\": \"https://parceltrackerstore.s3.eu-west-2.amazonaws.com/signatures/a44578d4-89ef-44a7-a789-bfec352a12c8.png?X-Amz-Expires=604800&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARFIFG5ENEEMQELHV/20230413/eu-west-2/s3/aws4_request&X-Amz-Date=20230413T214711Z&X-Amz-SignedHeaders=host&X-Amz-Signature=c23739242158a7a185b4715a04d1a46f149edce9f66550c83cb6aa798c88d108\",\n \"Id\": \"b13b93da-5e2c-405d-838e-7660998418dc\",\n \"SessionId\": \"a44578d4-89ef-44a7-a789-bfec352a12c8\",\n \"Source\": null,\n \"Courier\": \"Amazon\",\n \"LoggedIn\": \"2023-03-14T15:07:54.303\",\n \"Data\": \"Q80559948883\",\n \"Data2\": \"QE0017326078\",\n \"Data3\": \"SDlFRRCw8N_001_v\",\n \"LoggedInBy\": \"3ef8dccc-f6a8-4674-a082-94c6188520de\",\n \"LoggedOutBy\": \"3ef8dccc-f6a8-4674-a082-94c6188520de\",\n \"TenantId\": \"8eb755cd-c086-43ed-adf9-2afe6c7048fa\",\n \"Collected\": null\n }\n ]\n}"}],"_postman_id":"8f34f8e3-664c-4cfe-acdb-4943973b557d"},{"name":"Delete parcel","id":"61c20b1d-1325-4986-b8b2-f94b6635926c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"ApiKey {{apikey}}"}],"url":"https://api.parceltracker.com/api/public/parcels/5924e26b-acd6-4102-96c6-6254f8ae6749","description":"This operation cannot be undone, all the parcel's details will be permanently deleted
\n","urlObject":{"protocol":"https","path":["api","public","parcels","5924e26b-acd6-4102-96c6-6254f8ae6749"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"3679e4a3-9546-4904-a6c9-f14428b9021a","name":"Delete parcel","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"ApiKey {{apikey}}"}],"url":"https://api.parceltracker.com/api/public/parcels/5924e26b-acd6-4102-96c6-6254f8ae6749"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"428"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"0rHg4ZAAAAAAPTTdtdnEbS720HcvixoNlTUlMMzBFREdFMDYxOQBmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 21:48:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"5924e26b-acd6-4102-96c6-6254f8ae6749\",\n \"SessionId\": \"88a43476-2b95-4256-9aa1-e9a67e45e0a9\",\n \"Source\": null,\n \"Courier\": \"Amazon\",\n \"LoggedIn\": \"2023-03-13T10:25:50.263\",\n \"Data\": \"Q80559948883\",\n \"Data2\": \"QE0017326078\",\n \"Data3\": \"SDlFRRCw8N_001_v\",\n \"LoggedInBy\": \"3ef8dccc-f6a8-4674-a082-94c6188520de\",\n \"LoggedOutBy\": \"3ef8dccc-f6a8-4674-a082-94c6188520de\",\n \"TenantId\": \"8eb755cd-c086-43ed-adf9-2afe6c7048fa\",\n \"Collected\": null\n}"}],"_postman_id":"61c20b1d-1325-4986-b8b2-f94b6635926c"},{"name":"Create parcel","id":"37c51975-705b-4c6b-b0ea-5218ad2b8aa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Recipient\": {\r\n \"ExternalId\": \"1234567890\"\r\n },\r\n \"Barcode\": \"barcode\",\r\n \"SiteId\": 1, \r\n \"Expected\": true,\r\n \"TrackingNumber\": \"GB123456789A\",\r\n \"Notes\": \"A not on the parcel\",\r\n \"Size\": \"SMALL\",\r\n \"Tags\": [1,2],\r\n \"MailroomLocation\": \"34b65b19-c285-4344-ada2-34ee93ea9364\",\r\n \"DocId\": \"PO1234\",\r\n \"Quantity\": 1.2,\r\n \"Courier\": \"Amazon\",\r\n \"ExternalSenderId\": \"96780a62-7b76-48da-86b9-97dbffe913ab\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.parceltracker.com/api/public/parcels","description":"We strongly recommend contacting support on how to structure this API call based on the specific scenario.
\nRecipient (required) can be identified by its ExternalId (equivalent to Id2 in the Tenant endpoint), or by Id , which is the internal UUID generated by Parcel Tracker. The two fields are mutually exclusive.
Barcode (required) is the barcode or unique identifier of the package being logged in
SiteId is the id of the building where the parcel is being created. The recipient needs to have access to this building
Expected (required) if true, the parcel will be created as expected, otherwise as held (multimailroom only)
TrackingNumber the tracking number of the parcel (optional)
Notes - notes on the parcel (max 512 chars, optional)
Size The size of the parcel. Needs to be created beforehand in the portal (optional)
Tags The ids of the tags to assign (optional)
MailroomLocation The id of the mailroom location to assign (optional)
DocId a field to store the id of a document, such as the PO number (optional)
Quantity a field to store a quantity (floating point, optional)
Courier the courier of the parcel (optional)
Get the parcel tags that can be assigned to parcels
\n","urlObject":{"protocol":"https","path":["api","public","parcel-tags"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"cad58218-4fa2-4696-9ece-1ded10ee1c6c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":"https://api.parceltracker.com/api/public/parcel-tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Jan 2025 19:39:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"375"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ARRAffinity=9a8f0e0000b8e644978be53e4421da1aa8e6895923dacdc15da621f88ed4a71c;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=9a8f0e0000b8e644978be53e4421da1aa8e6895923dacdc15da621f88ed4a71c;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Security-Policy","value":"default-src 'none'; frame-ancestors 'none'; sandbox"},{"key":"x-azure-ref","value":"20250107T193918Z-1777998d8f96l7fhhC1DUS0g0800000012t000000000yctv"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": 1,\n \"Name\": \"Damaged\",\n \"ColourHex\": \"#FFB13D\",\n \"Enabled\": true\n },\n {\n \"Id\": 828,\n \"Name\": \"Key Held\",\n \"ColourHex\": \"#f7da4b\",\n \"Enabled\": true\n },\n {\n \"Id\": 829,\n \"Name\": \"Key Released\",\n \"ColourHex\": \"#f7da4b\",\n \"Enabled\": true\n },\n {\n \"Id\": 4,\n \"Name\": \"Large item\",\n \"ColourHex\": \"#C0C1C4\",\n \"Enabled\": true\n },\n {\n \"Id\": 328,\n \"Name\": \"Loading Bay - Collect\",\n \"ColourHex\": \"#6092C0\",\n \"Enabled\": true\n },\n {\n \"Id\": 863,\n \"Name\": \"Parking Slip\",\n \"ColourHex\": \"#6092C0\",\n \"Enabled\": true\n },\n {\n \"Id\": 3,\n \"Name\": \"Perishable\",\n \"ColourHex\": \"#6070C7\",\n \"Enabled\": true\n },\n {\n \"Id\": 379,\n \"Name\": \"Regalo\",\n \"ColourHex\": \"#9170B8\",\n \"Enabled\": true\n },\n {\n \"Id\": 2,\n \"Name\": \"Rejected\",\n \"ColourHex\": \"#FF5E6B\",\n \"Enabled\": true\n },\n {\n \"Id\": 378,\n \"Name\": \"Tajeta\",\n \"ColourHex\": \"#f7da4b\",\n \"Enabled\": true\n }\n]"}],"_postman_id":"ed378cd8-2988-4c86-9f05-5199988b9736"},{"name":"Get Parcel Dimensions","id":"9a5b9919-2705-4186-9315-c8a758344377","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"Get the available parcel dimensions for this account
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"5a03306b-87ad-427a-ba2b-9dd9d512d854","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":"https://api.parceltracker.com/api/public/parcel-dimensions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Jan 2025 15:30:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"185"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ARRAffinity=9a8f0e0000b8e644978be53e4421da1aa8e6895923dacdc15da621f88ed4a71c;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=9a8f0e0000b8e644978be53e4421da1aa8e6895923dacdc15da621f88ed4a71c;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Security-Policy","value":"default-src 'none'; frame-ancestors 'none'; sandbox"},{"key":"x-azure-ref","value":"20250107T153022Z-166954b7664d9m5vhC1PARp4zw0000000x9g00000000b6t8"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": 1,\n \"Name\": \"LETTER\"\n },\n {\n \"Id\": 2,\n \"Name\": \"SMALL\"\n },\n {\n \"Id\": 3,\n \"Name\": \"MEDIUM\"\n },\n {\n \"Id\": 4,\n \"Name\": \"LARGE\"\n }\n]"}],"_postman_id":"9a5b9919-2705-4186-9315-c8a758344377"}],"id":"131e4f40-28ac-4710-9c63-d4ab67f3ce4f","description":"In this section you will find methods to add or manage existing parcels.
\n","_postman_id":"131e4f40-28ac-4710-9c63-d4ab67f3ce4f"},{"name":"Users","item":[{"name":"Create user","id":"4c88896c-39c0-4c12-a874-1536125b5cca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"ApiKey {{apikey}}"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"test4@test.com\",\r\n \"type\": 0,\r\n \"developmentIds\": [ 1 ]\r\n}"},"url":"https://api.parceltracker.com/api/public/users","description":"type determines the level of access that the user has. Refer to the table below for information on this
developmentId is the id of the building. It's provided together with the API credentials and can be requested any time from our customer service. This field is used as the default building for the user.
NB When a user is signed up, an email is sent to them asking to set their own password, passwords won't be exchanged over API requests
\n","urlObject":{"protocol":"https","path":["api","public","users"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"133b6cf1-80b8-4a78-99b0-fc7d9caa820d","name":"Create user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"ApiKey {{apikey}}"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"test4@test.com\",\r\n \"type\": 0,\r\n \"developmentIds\": [ 1 ]\r\n}"},"url":"https://api.parceltracker.com/api/public/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"128"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Location","value":"https://parcel-tracker-api-uk.azurewebsites.net/api/public/users?id=1a46e8be-ae98-45b7-9fd2-769ddde716d1"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"0mfY3ZAAAAACysOSI4NirSJ2F5Z1/+ZpCTUlMMzBFREdFMDYxNABmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 12:33:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"1a46e8be-ae98-45b7-9fd2-769ddde716d1\",\n \"Id2\": null,\n \"FirstName\": \"James\",\n \"LastName\": \"Test\",\n \"Email\": \"test4@test.com\",\n \"Type\": 0\n}"}],"_postman_id":"4c88896c-39c0-4c12-a874-1536125b5cca"},{"name":"Edit user","id":"cd5b85e7-9627-4b68-b835-7302d7719da1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"ApiKey {{apikey}}"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"1a46e8be-ae98-45b7-9fd2-769ddde716d1\",\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"test7@test.com\",\r\n \"type\": 1,\r\n \"developmentIds\": [1]\r\n}"},"url":"https://api.parceltracker.com/api/public/users/1a46e8be-ae98-45b7-9fd2-769ddde716d1","description":"type determines the level of access that the user has. Refer to the table below for information on this
developmentId is the id of the building. It's provided together with the API credentials and can be requested any time from our customer service. This field is used as the default building for the user.
NB When a user is signed up, an email is sent to them asking to set their own password, passwords won't be exchanged over API requests
\nNB It's not possible to change the Id
\n","urlObject":{"protocol":"https","path":["api","public","users","1a46e8be-ae98-45b7-9fd2-769ddde716d1"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"44426236-eaf8-4326-bfee-bd8ff3d37ef8","name":"Edit user","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"ApiKey {{apikey}}"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"1a46e8be-ae98-45b7-9fd2-769ddde716d1\",\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Test\",\r\n \"email\": \"test7@test.com\",\r\n \"type\": 1,\r\n \"developmentIds\": [1]\r\n}"},"url":"https://api.parceltracker.com/api/public/users/1a46e8be-ae98-45b7-9fd2-769ddde716d1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"224"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"0B/c3ZAAAAADUqIHXuqtST5hBQ47/BtbNTUlMMzBFREdFMDYxNABmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 12:35:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"1a46e8be-ae98-45b7-9fd2-769ddde716d1\",\n \"Id2\": null,\n \"FirstName\": \"James\",\n \"LastName\": \"Test\",\n \"Email\": \"test7@test.com\",\n \"Type\": 1\n}"}],"_postman_id":"cd5b85e7-9627-4b68-b835-7302d7719da1"},{"name":"Get users","id":"cb923591-54a5-4389-80a2-de78dc7240ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":"https://api.parceltracker.com/api/public/users?development_id=1&page=2&page_size=2","description":"development_id is the id of the building. It's provided together with the API credentials and can be requested any time from our customer service
page the page number, starts from 1 (default 1)
page_size the number of users per page (default 200, max 20000)
This operation cannot be undone, all the users's history will be erased together with their development access information
\n","urlObject":{"protocol":"https","path":["api","public","users","1a46e8be-ae98-45b7-9fd2-769ddde716d1"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"165209b5-e404-4ea6-b5bc-dc02752617b3","name":"Delete user","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":"https://api.parceltracker.com/api/public/users/1a46e8be-ae98-45b7-9fd2-769ddde716d1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"224"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"0+nE4ZAAAAABjdDMdmgUEQb6NqyJwPLIlTUlMMzBFREdFMDYxMABmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 21:19:54 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"1a46e8be-ae98-45b7-9fd2-769ddde716d1\",\n \"Id2\": null,\n \"FirstName\": \"James\",\n \"LastName\": \"Test\",\n \"Email\": \"test7@test.com\",\n \"Type\": 1\n}"}],"_postman_id":"9b0b8f7d-4ebd-4cc4-980b-6ac8eafd9a7c"}],"id":"b7fd834f-728c-4dd7-b5a0-6ea642e769b5","description":"In this section you will find methods to create or manage existing users.
\n","event":[{"listen":"prerequest","script":{"id":"56c7b5bd-8698-4154-b668-93b4f9eaab3c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"95ebcecb-a10a-4cdb-bcbf-b5ca806c9865","type":"text/javascript","exec":[""]}}],"_postman_id":"b7fd834f-728c-4dd7-b5a0-6ea642e769b5"},{"name":"Recipients","item":[{"name":"Create tenant","id":"5ff75862-6757-4a41-88ca-f52327129171","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"ApiKey {{apikey}}"}],"body":{"mode":"raw","raw":"{\r\n \"id2\": \"1234567890\",\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Williams\",\r\n \"alias\": \"Jay\",\r\n \"email\": \"test@test.test\",\r\n \"phone\": null,\r\n \"developmentId\": 1,\r\n \"room\": \"Flat 704\"\r\n}"},"url":"https://api.parceltracker.com/api/public/tenants","description":"alias (nullable) is the nickname of the resident. If the resident has an alias associate with them, the OCR algorithm will try to match that as well
developmentId is the id of the building. It's provided together with the API credentials and can be requested any time from our customer service
notificationOptions determines what notifications a resident will receive according to the table below
NB The request will be rejected if the building is not enabled to send SMS notifications and options 1 or 2 are selected
\nNB This request will send an email to the tenant that has been created with credentials to access the data management portal
\n","urlObject":{"protocol":"https","path":["api","public","tenants"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"0c259e73-a996-4e12-9cd3-320f794c9d17","name":"Create tenant","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"ApiKey {{apikey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Id2\": \"1234567890\",\r\n \"FirstName\": \"James\",\r\n \"LastName\": \"Williams\",\r\n \"Alias\": \"Jay\",\r\n \"Email\": \"test@test.test\",\r\n \"Phone\": null,\r\n \"DevelopmentId\": 1,\r\n \"Room\": \"Flat 704\"\r\n}"},"url":"https://api.parceltracker.com/api/public/tenants"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"237"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Location","value":"https://parcel-tracker-api-uk.azurewebsites.net/api/public/tenants?id=b99d41d5-d697-45be-af9d-b5fc092abc8c"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"04eE3ZAAAAADqbs9Z8KgUT6KdpPIB012jTUlMMzBFREdFMDYwNwBmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 11:05:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"b99d41d5-d697-45be-af9d-b5fc092abc8c\",\n \"Id2\": \"1234567890\",\n \"FirstName\": \"James\",\n \"LastName\": \"Williams\",\n \"Alias\": \"Jay\",\n \"Email\": \"test@test.test\",\n \"Phone\": null,\n \"DevelopmentId\": 1,\n \"Room\": \"Flat 704\",\n \"NotificationOptions\": 0,\n \"DateOfBirth\": null\n}"}],"_postman_id":"5ff75862-6757-4a41-88ca-f52327129171"},{"name":"Edit tenant","id":"c662caba-5b70-4f7a-8f79-69ab5f156d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"ApiKey {{apikey}}"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"b99d41d5-d697-45be-af9d-b5fc092abc8c\",\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Williams\",\r\n \"alias\": \"Jay\",\r\n \"email\": \"test@test.test\",\r\n \"phone\": null,\r\n \"developmentId\": 1,\r\n \"room\": \"Flat 704\"\r\n}"},"url":"https://api.parceltracker.com/api/public/tenants/b99d41d5-d697-45be-af9d-b5fc092abc8c","description":"alias (nullable) is the nickname of the resident. If the resident has an alias associate with them, the OCR algorithm will try to match that as well
developmentId is the id of the building. It's provided together with the API credentials and can be requested any time from our customer service
notificationOptions determines what notifications a resident will receive according to the table below
NB The request will be rejected if the building is not enabled to send SMS notifications and options 1 or 2 are selected
\nNB It's not possible to change the Id
\n","urlObject":{"protocol":"https","path":["api","public","tenants","b99d41d5-d697-45be-af9d-b5fc092abc8c"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"52027831-afc4-48be-8b39-112551a21d2c","name":"Edit tenant","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"ApiKey {{apikey}}"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"b99d41d5-d697-45be-af9d-b5fc092abc8c\",\r\n \"firstName\": \"James\",\r\n \"lastName\": \"Williams\",\r\n \"alias\": \"Jay\",\r\n \"email\": \"test@test.test\",\r\n \"phone\": null,\r\n \"developmentId\": 1,\r\n \"room\": \"Flat 704\"\r\n}"},"url":"https://api.parceltracker.com/api/public/tenants/b99d41d5-d697-45be-af9d-b5fc092abc8c"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"294"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"0aeM3ZAAAAABcWVc7R/olSIWyi1ltEQ1STUlMMzBFREdFMDYxNABmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 11:11:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"b99d41d5-d697-45be-af9d-b5fc092abc8c\",\n \"Id2\": null,\n \"FirstName\": \"James\",\n \"LastName\": \"Williams\",\n \"Alias\": \"Jay\",\n \"Email\": \"test@test.test\",\n \"Phone\": null,\n \"DevelopmentId\": 1,\n \"Room\": \"Flat 704\",\n \"NotificationOptions\": 0,\n \"DateOfBirth\": null\n}"}],"_postman_id":"c662caba-5b70-4f7a-8f79-69ab5f156d2c"},{"name":"Get tenants","id":"76743e38-6959-495b-b63a-9bce27f82013","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":"https://api.parceltracker.com/api/public/tenants?development_id=1&page=1&page_size=20&updated_since=","description":"development_id is the id of the building. It's provided together with the API credentials and can be requested any time from our customer service
page the page number, starts from 1 (default 1)
page_size the number of tenants per page (default 200, max 20000)
Required - The Id of the development (site) where to fetch recipients from
\n","type":"text/plain"},"key":"development_id","value":"1"},{"description":{"content":"Page number (starts at 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of recipients per page
\n","type":"text/plain"},"key":"page_size","value":"20"},{"description":{"content":"Optional - Get only recipients that have been created or updated before the given date (UTC)
\n","type":"text/plain"},"key":"updated_since","value":""}],"variable":[]}},"response":[{"id":"654439e5-9677-4fe9-9bcf-e200408cf477","name":"Get tenants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":{"raw":"https://api.parceltracker.com/api/public/tenants?development_id=1&page=1&page_size=2","protocol":"https","host":["api","parceltracker","com"],"path":["api","public","tenants"],"query":[{"key":"development_id","value":"1"},{"key":"page","value":"1"},{"key":"page_size","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"410"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"0leM3ZAAAAAC+iZ7OIOUiSaN5Tj42X4gaTUlMMzBFREdFMDYxNABmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 11:12:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Page\": 1,\n \"PageSize\": 2,\n \"TotalPages\": 299,\n \"TotalResults\": 597,\n \"Elements\": [\n {\n \"Id\": \"acd5a232-ec29-44dd-8f8b-012b3a21fb37\",\n \"Id2\": null,\n \"FirstName\": \"Mike\",\n \"LastName\": \"Pryll\",\n \"Alias\": null,\n \"Email\": \"test@test.test\",\n \"Phone\": null,\n \"DevelopmentId\": 1,\n \"Room\": \"Edison 1\",\n \"NotificationOptions\": 0,\n \"DateOfBirth\": null\n },\n {\n \"Id\": \"9e3ef29f-ea36-417f-8882-017a5d3331e8\",\n \"Id2\": null,\n \"FirstName\": \"Patricia\",\n \"LastName\": \"Manhardt\",\n \"Alias\": null,\n \"Email\": \"test@test.test\",\n \"Phone\": null,\n \"DevelopmentId\": 1,\n \"Room\": \"Edison 2\",\n \"NotificationOptions\": 0,\n \"DateOfBirth\": null\n }\n ]\n}"}],"_postman_id":"76743e38-6959-495b-b63a-9bce27f82013"},{"name":"Get tenant","id":"13637cd0-30f8-449d-8ebf-5c75d5dc4eff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":"https://api.parceltracker.com/api/public/tenants/b99d41d5-d697-45be-af9d-b5fc092abc8c","description":"This operation cannot be undone, all the tenant's personal data and deliveries history will be permanently deleted
\n","urlObject":{"protocol":"https","path":["api","public","tenants","b99d41d5-d697-45be-af9d-b5fc092abc8c"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"2cfec235-9ed8-4a08-8194-288bcbb118d0","name":"Delete tenant","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":"https://api.parceltracker.com/api/public/tenants/b99d41d5-d697-45be-af9d-b5fc092abc8c"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"294"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"ARRAffinity=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=d4a5801c53a42ad08846742838b4d9842642314ed59d7eca7f13771a75217710;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"03+M3ZAAAAAC0tYQdUWEfSqT41bhI0UJ6TUlMMzBFREdFMDYxNABmMjEwNGI5Yy1lMGRjLTQ1ZDktOTkwYS05ZGJiZmJhYWE3MmI="},{"key":"Date","value":"Thu, 13 Apr 2023 11:13:34 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"b99d41d5-d697-45be-af9d-b5fc092abc8c\",\n \"Id2\": null,\n \"FirstName\": \"James\",\n \"LastName\": \"Williams\",\n \"Alias\": \"Jay\",\n \"Email\": \"test@test.test\",\n \"Phone\": null,\n \"DevelopmentId\": 1,\n \"Room\": \"Flat 704\",\n \"NotificationOptions\": 0,\n \"DateOfBirth\": null\n}"}],"_postman_id":"0c5abc4b-6fbf-4240-a9e9-25b0be2605c3"}],"id":"96eaac3c-8098-4ef3-9a1f-6d5c9b37c1a8","description":"In this section you will find methods to create or manage existing tenants. Tenants are the residents who will receive notifications by the system
\n","_postman_id":"96eaac3c-8098-4ef3-9a1f-6d5c9b37c1a8"},{"name":"Sites","item":[{"name":"Get Sites","id":"fbfa7a2a-a57e-4a99-ad09-70321dfc12a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"List all the sites that the api key can access.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[{"id":"07d65466-6b70-4400-ad27-ebd04d3d5def","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"url":{"raw":"https://api.parceltracker.com/api/public/sites","protocol":"https","host":["api","parceltracker","com"],"path":["api","public","sites"],"query":[{"key":"","value":"","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Jan 2025 15:36:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"527"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ARRAffinity=9a8f0e0000b8e644978be53e4421da1aa8e6895923dacdc15da621f88ed4a71c;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=9a8f0e0000b8e644978be53e4421da1aa8e6895923dacdc15da621f88ed4a71c;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Security-Policy","value":"default-src 'none'; frame-ancestors 'none'; sandbox"},{"key":"x-azure-ref","value":"20250107T153637Z-1777998d8f9js487hC1DUSb54s00000013xg00000000crue"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": 1,\n \"BuildingName\": \"Office\",\n \"ClientId\": 1,\n \"AddressLine1\": \"30 Aldwych\",\n \"AddressLine2\": \"Bush House\",\n \"Postcode\": \"WC2B 4BG\",\n \"City\": \"London\",\n \"Country\": \"UK\"\n },\n {\n \"Id\": 40,\n \"BuildingName\": \"Warehouse\",\n \"ClientId\": 1,\n \"AddressLine1\": \"31 Aldwych\",\n \"AddressLine2\": null,\n \"Postcode\": \"WC2B 4BG\",\n \"City\": \"London\",\n \"Country\": \"UK\"\n }\n]"}],"_postman_id":"fbfa7a2a-a57e-4a99-ad09-70321dfc12a2"}],"id":"3592ded3-322f-4a01-ae48-624b7955fb56","_postman_id":"3592ded3-322f-4a01-ae48-624b7955fb56","description":""},{"name":"External Senders","item":[{"name":"Create External Sender","id":"ff86ce3d-ef67-410a-8dbc-9692e04f607c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"Sender name\",\r\n \"Email\": \"sender@test.com\",\r\n \"AddressLine1\": \"Road Avenue\",\r\n \"AddressLine2\": \"AL2\",\r\n \"Postcode\": \"11170\",\r\n \"City\": \"Chicago\",\r\n \"State\": \"IL\",\r\n \"Country\": \"USA\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.parceltracker.com/api/public/external-senders","description":"Create an external sender. Name is mandatory, all the other fields are not.
\nSenders with duplicate names will throw 409 (conflict).
\n","urlObject":{"protocol":"https","path":["api","public","external-senders"],"host":["api","parceltracker","com"],"query":[],"variable":[]}},"response":[{"id":"a318c73a-81c0-4412-9027-cc7328fedfd3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"Sender name\",\r\n \"Email\": \"sender@test.com\",\r\n \"AddressLine1\": \"Road Avenue\",\r\n \"AddressLine2\": \"AL2\",\r\n \"Postcode\": \"11170\",\r\n \"City\": \"Chicago\",\r\n \"State\": \"IL\",\r\n \"Country\": \"USA\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.parceltracker.com/api/public/external-senders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Feb 2025 18:30:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"281"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ARRAffinity=70f7f0a2b1d3699ef167efa969867b6fb6e753200fe626af24c7171bfb39fbd2;Path=/;HttpOnly;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=70f7f0a2b1d3699ef167efa969867b6fb6e753200fe626af24c7171bfb39fbd2;Path=/;HttpOnly;SameSite=None;Secure;Domain=parcel-tracker-api-uk.azurewebsites.net"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Request-Context","value":"appId=cid-v1:d3c5874b-9a39-4e50-a1cd-0afd40d357cc"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Security-Policy","value":"default-src 'none'; frame-ancestors 'none'; sandbox"},{"key":"x-azure-ref","value":"20250224T183056Z-1546558b9d9dpwrjhC1AMSsk8c0000000we000000000gg53"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"Accept-Ranges","value":"bytes"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"78a0eec5-f9c4-46e1-8999-87ab5cb950b3\",\n \"Name\": \"Sender name\",\n \"Email\": \"sender@test.com\",\n \"AddressLine1\": \"Road Avenue\",\n \"AddressLine2\": \"AL2\",\n \"Postcode\": \"11170\",\n \"City\": \"Chicago\",\n \"State\": \"IL\",\n \"Country\": \"USA\"\n}"}],"_postman_id":"ff86ce3d-ef67-410a-8dbc-9692e04f607c"}],"id":"4c190c2b-b309-46c5-9ee1-3e388ef06352","description":"An external sender is an entity used to capture the sender of a package coming from outside the organisation.
\n","_postman_id":"4c190c2b-b309-46c5-9ee1-3e388ef06352"}],"id":"c3e8e155-96bd-4d0d-8046-6e2b8ce64a01","description":"The v1 (legacy) API relies on system-generated IDs and entity navigation (e.g. accessing the recipient for a parcel) requires additional API calls.
\nFor new projects we recommend the v2 endpoints for tenants (which are now called recipients) and parcels.
v1 API is still being maintained.
\n","_postman_id":"c3e8e155-96bd-4d0d-8046-6e2b8ce64a01"}],"event":[{"listen":"prerequest","script":{"id":"95a56ac1-86d0-4e4f-b221-4231f8469f68","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"951d2d35-9dc6-4029-a03c-1f2eb7d119ee","type":"text/javascript","exec":[""]}}]}