The following API endpoints provide customers with the ability to create logistics projects, add consignments and instruct manifest.
\nLive URL: https://clicksc.rsa.global
\nUse your provided API key to Request an Access Token and include as an Authorization Header on every endpoint request.
\n\n\nAuthorization : \"Bearer {{access_token}}\"
\n
Create a new shipment project. Returns the Project Reference ID used in subsequent API calls.
\n\n\n{{Mode}} = Integer
\n
{url}/api/projects/create/shipment/1
Query all projects.
\n\n\n{{type}} = String
\n
{url}/api/projects/outbound/drafts/0
Query project.
\n\n\n{{ref}} = String
\n
{url}/api/projects/RS1234-123/1/2
Query all projects.
\n\n\n{{type}} = String
\n
{url}/api/projects/outbound/drafts/0
{url}/api/projects/R3876M1P7/7/add/consignment
| Parameter | \nRequired | \nType | \nDescription | \n
| origin.identifier destination.identifier | \n Optional | \nString max:255 | \nOrigin Reference | \n
| origin.person destination.person | \n Required | \nString max:255 | \nSender Name | \n
| origin.phone destination.phone | \n Optional | \nString max:255 | \nPhone Number | \n
| origin.email destination.email | \n Optional | \nString max:255 | \nEmail Address | \n
| origin.pickup_instructions destination.delivery_instructions | \n Optional | \nString max:255 | \nSpecial Instructions | \n
| origin.address.building_name destination.address.building_name | \n Optional | \nString max:255 | \nBuilding Name | \n
| origin.address.street_address destination.address.street_address | \n Required | \nString max:255 | \nStreet Address | \n
| origin.address.suburb destination.address.suburb | \n Required | \nString max:255 | \nSuburb / Locality | \n
| origin.address.city destination.address.city | \n Required | \nString max:255 | \nCity / Town | \n
| origin.address.postcode destination.address.postcode | \n Required | \nString max:255 | \nPostcode / Zip | \n
| origin.address.country_code destination.address.country_code | \n Required | \nString max:255 | \nTwo letter Code | \n
| origin.address.country destination.address.country | \n Required | \nString max:255 | \nCountry Name | \n
| origin.address.lat destination.address.lat | \n Optional | \nString max:255 | \nLatitude | \n
| origin.address.long destination.address.long | \n Optional | \nString max:255 | \nLongitude | \n
| origin.address.port_code destination.address.port_code | \n Optional | \nString max:255 | \nInternational Port Code | \n
| origin.address.airport destination.address.airport | \n Optional | \nBoolean | \nAirport Terminal | \n
| origin.address.seaport destination.address.seaport | \n Optional | \nBoolean | \nSeaport Terminal | \n
| origin.address.warehouse destination.address.warehouse | \n Optional | \nBoolean | \nWarehouse Address | \n
| origin.address.warehouse_code destination.address.warehouse_code | \n Optional | \nString max:255 | \nWarehouse Address | \n
| supplier_id | \nOptional | \nString max:255 | \nSupplier ID | \n
| delivery_reference | \nOptional | \nString max:255 | \nDelivery Reference | \n
| commodities.description | \nRequired | \nString max:255 | \nDescription | \n
| commodities.units | \nRequired | \nNumeric | \nNumber of Units | \n
| commodities.unit_value | \nRequired | \nNumeric | \nValue of Commodity | \n
| commodities.unit_measurement | \nRequired | \nString max:55 | \nE.g. \"1.5\" | \n
| commodities.unit_measure | \nRequired | \nString max:55 | \nE.g. \"KG\" | \n
| commodities.currency | \nRequired | \nString max:55 | \nE.g. \"USD\" | \n
| commodities.country | \nRequired | \nString max:55 | \nTwo letter E.g. \"GB\" | \n
| packages.name | \nRequired | \nString max:255 | \nE.g. \"PARCEL\" | \n
| packages.type | \nRequired | \nString max:255 | \nE.g. \"Box\" | \n
| packages.height | \nRequired | \nNumeric max:55 | \nE.g. \"100\" | \n
| packages.length | \nRequired | \nNumeric max:55 | \nE.g. \"100\" | \n
| packages.width | \nRequired | \nNumeric max:55 | \nE.g. \"100\" | \n
| packages.measure | \nRequired | \nString max:55 | \nE.g. \"CM\" | \n
| packages.weight | \nRequired | \nString max:55 | \nE.g. \"5\" | \n
| packages.weight_measure | \nRequired | \nString max:55 | \nE.g. \"KG\" | \n
| packages.overlabel_barcode | \nOptional | \nString max:555 | \nE.g. \"ABC1234567878\" | \n
| signature | \nOptional | \nBoolean | \nDestination Signature Req. | \n
| carrier_logo | \nOptional | \nBoolean | \nInclude Carrier Logo | \n
| label_output | \nOptional | \nArray | \nLabel Output Dimensions [\"LABEL_PDF_100X150\"] | \n
| total_value | \nOptional | \nString max:255 | \nTotal Declared Value | \n
| total_value_currency | \nOptional | \nString max:255 | \n3 letter Currency E.g. \"USD\" | \n
| invoice_data | \nOptional | \nString | \nBase64 Encoded PDF | \n
This endpoint will publish the project immediatley consignments will be booked on the supplied contract ID.
\n{url}/api/projects/R3876M1P6/6/publish/book/contract/1
This endpoint will publish the project manifest.
\n{url}/api/projects/R3876M1P6/6/publish/manifest
Removes a consignment from the project.
\n{url}/api/projects/R3876M1P7/7/remove/consignment/33
This endpoint will publish the project immediatley, consignments will be booked on the supplied rate card ID.
\n","urlObject":{"path":["api","projects","{{ref}}","publish","book","rate","{{rate}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be14b1c6-4be6-4504-b717-08962434571c"},{"name":"/rate/query/{ref}","id":"1dcb8bc3-38df-4db2-9b52-886a6554aee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{customer_access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"}],"url":"{{url}}/api/projects/rate/query/{{ref}}","description":"Query available rates against the project reference.
\n","urlObject":{"path":["api","projects","rate","query","{{ref}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1dcb8bc3-38df-4db2-9b52-886a6554aee0"},{"name":"/contract/query/{ref}","id":"00f606a0-b590-4b59-9c13-87b4c10089ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{customer_access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-Requested-With","type":"text","value":"XMLHttpRequest"}],"url":"{{url}}/api/projects/contract/query/{{ref}}","description":"Query available contract rates against this Project Reference.
\n","urlObject":{"path":["api","projects","contract","query","{{ref}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"00f606a0-b590-4b59-9c13-87b4c10089ff"},{"name":"/{ref}/quotes","id":"78ff50da-06c3-4eea-b7b3-cbf6c3c8cb48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{customer_access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/api/projects/{{ref}}/quotes","description":"This endpoint will return any quotes recieved and attached on this project.
\n","urlObject":{"path":["api","projects","{{ref}}","quotes"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"78ff50da-06c3-4eea-b7b3-cbf6c3c8cb48"}],"id":"8bd288c3-1786-4b48-afaa-e622220f91cb","_postman_id":"8bd288c3-1786-4b48-afaa-e622220f91cb","description":""},{"name":"/api/webhooks/","item":[{"name":"/register","id":"ee84e229-4e18-4746-b55b-26f04d4d83a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"register\" : [\n\t{\n\t\t\"name\" : \"tracking.events\",\n\t\t\"target_url\" : \"https://myurl.com\"\n\t\t\n\t},\n\t\t{\n\t\t\"name\" : \"projects.dimdata\",\n\t\t\"target_url\" : \"https://myurl.com\"\n\t\t\n\t}\n\t]\n}"},"url":"{{url}}/api/webhooks/register","description":"See example request.
\n","urlObject":{"path":["api","webhooks","register"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"e322ee49-63a6-4cda-9651-e94808e18894","name":"/register","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"register\" : [\n\t{\n\t\t\"name\" : \"tracking.events\",\n\t\t\"target_url\" : \"https://myurl.com\"\n\t\t\n\t},\n\t\t{\n\t\t\"name\" : \"projects.dimdata\",\n\t\t\"target_url\" : \"https://myurl.com\"\n\t\t\n\t}\n\t]\n}"},"url":"{{url}}/api/webhooks/register"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Feb 2020 21:09:47 GMT"},{"key":"Server","value":"Apache/2.4.41 (Amazon) OpenSSL/1.0.2k-fips PHP/7.3.13"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Set-Cookie","value":"buytasker_session=voE516v50fk8s9Emwd9PWXs1do2JJO93aWcaD6nC; expires=Wed, 26-Feb-2020 23:09:47 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Length","value":"275"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"success\",\n \"results\": [\n {\n \"success\": {\n \"name\": \"tracking.events\",\n \"target_url\": \"https://myurl.com\",\n \"signature\": \"C8trIqSGTdzrOaDNPY3j9Cdj3BSfLovp\"\n }\n },\n {\n \"success\": {\n \"name\": \"projects.dimdata\",\n \"target_url\": \"https://myurl.com\",\n \"signature\": \"nGvELLklQODFSjnNElNbT6sewEs8MTpy\"\n }\n }\n ]\n}"}],"_postman_id":"ee84e229-4e18-4746-b55b-26f04d4d83a0"},{"name":"/test/{webhook}","id":"57ce6377-5d22-42cc-9701-135f23956319","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[{ \n\n \"example\":\"payload\"\n\n}]"},"url":"{{url}}/api/webhooks/test/{{webhook}}","description":"\n{\n \"events\": [\n {\n \"id\": 465,\n \"code\": null,\n \"part\": 1,\n \"location\": \"HEATHROW,LONDON,GB\",\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:23\",\n \"event_date\": \"2020-02-25T23:16:34.113\",\n \"updated_at\": \"2020-03-01 17:53:23\",\n \"description\": \"Tracking number allocated & order ready\"\n },\n {\n \"id\": 466,\n \"code\": null,\n \"part\": 2,\n \"location\": \"HEATHROW,LONDON,GB\",\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:23\",\n \"event_date\": \"2020-02-25T23:16:34.113\",\n \"updated_at\": \"2020-03-01 17:53:23\",\n \"description\": \"Tracking number allocated & order ready\"\n },\n {\n \"id\": 467,\n \"code\": \"20\",\n \"part\": 1,\n \"location\": \"GB\",\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:24\",\n \"event_date\": \"2020-02-26T10:10:28\",\n \"updated_at\": \"2020-03-01 17:53:24\",\n \"description\": \"ACCEPTED\"\n },\n {\n \"id\": 468,\n \"code\": \"21\",\n \"part\": 1,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:24\",\n \"event_date\": \"2020-02-26T13:49:00\",\n \"updated_at\": \"2020-03-01 17:53:24\",\n \"description\": \"IN TRANSIT\"\n },\n {\n \"id\": 469,\n \"code\": \"2101\",\n \"part\": 1,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:24\",\n \"event_date\": \"2020-02-26T15:25:00\",\n \"updated_at\": \"2020-03-01 17:53:24\",\n \"description\": \"IN TRANSIT - EXPORTED\"\n },\n {\n \"id\": 470,\n \"code\": \"2101\",\n \"part\": 1,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:24\",\n \"event_date\": \"2020-02-27T16:42:00\",\n \"updated_at\": \"2020-03-01 17:53:24\",\n \"description\": \"IN TRANSIT - EXPORTED\"\n },\n {\n \"id\": 471,\n \"code\": \"2101\",\n \"part\": 1,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:25\",\n \"event_date\": \"2020-02-27T19:12:00\",\n \"updated_at\": \"2020-03-01 17:53:25\",\n \"description\": \"IN TRANSIT - EXPORTED\"\n },\n {\n \"id\": 472,\n \"code\": \"21\",\n \"part\": 1,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:25\",\n \"event_date\": \"2020-02-27T15:56:00\",\n \"updated_at\": \"2020-03-01 17:53:25\",\n \"description\": \"IN TRANSIT\"\n },\n {\n \"id\": 473,\n \"code\": \"100\",\n \"part\": 1,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:25\",\n \"event_date\": \"2020-02-28T17:31:00\",\n \"updated_at\": \"2020-03-01 17:53:25\",\n \"description\": \"DELIVERED\"\n },\n {\n \"id\": 474,\n \"code\": \"20\",\n \"part\": 2,\n \"location\": \"GB\",\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:25\",\n \"event_date\": \"2020-02-26T10:10:28\",\n \"updated_at\": \"2020-03-01 17:53:25\",\n \"description\": \"ACCEPTED\"\n },\n {\n \"id\": 475,\n \"code\": \"21\",\n \"part\": 2,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:25\",\n \"event_date\": \"2020-02-26T13:49:00\",\n \"updated_at\": \"2020-03-01 17:53:25\",\n \"description\": \"IN TRANSIT\"\n },\n {\n \"id\": 476,\n \"code\": \"2101\",\n \"part\": 2,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:26\",\n \"event_date\": \"2020-02-26T15:25:00\",\n \"updated_at\": \"2020-03-01 17:53:26\",\n \"description\": \"IN TRANSIT - EXPORTED\"\n },\n {\n \"id\": 477,\n \"code\": \"2101\",\n \"part\": 2,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:26\",\n \"event_date\": \"2020-02-27T16:42:00\",\n \"updated_at\": \"2020-03-01 17:53:26\",\n \"description\": \"IN TRANSIT - EXPORTED\"\n },\n {\n \"id\": 478,\n \"code\": \"2101\",\n \"part\": 2,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:26\",\n \"event_date\": \"2020-02-27T19:12:00\",\n \"updated_at\": \"2020-03-01 17:53:26\",\n \"description\": \"IN TRANSIT - EXPORTED\"\n },\n {\n \"id\": 479,\n \"code\": \"21\",\n \"part\": 2,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:26\",\n \"event_date\": \"2020-02-27T15:56:00\",\n \"updated_at\": \"2020-03-01 17:53:26\",\n \"description\": \"IN TRANSIT\"\n },\n {\n \"id\": 480,\n \"code\": \"100\",\n \"part\": 2,\n \"location\": null,\n \"reference\": \"BT3866M1P18/22/63\",\n \"created_at\": \"2020-03-01 17:53:26\",\n \"event_date\": \"2020-02-28T17:31:00\",\n \"updated_at\": \"2020-03-01 17:53:26\",\n \"description\": \"DELIVERED\"\n }\n ],\n \"picked\": \"2020-02-28T17:31:00\",\n \"status\": \"DELIVERED\",\n \"delivery_date\": \"2020-02-28T17:31:00\"\n}\n","urlObject":{"path":["api","webhooks","test","{{webhook}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"200dcaeb-ad02-497f-bb08-e053b316bbb2","name":"/test/{webhook}","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"[{ \n\n \"example\":\"payload\"\n\n}]"},"url":"{{url}}/api/webhooks/test/{{webhook}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Feb 2020 21:33:43 GMT"},{"key":"Server","value":"Apache/2.4.41 (Amazon) OpenSSL/1.0.2k-fips PHP/7.3.13"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Set-Cookie","value":"buytasker_session=voE516v50fk8s9Emwd9PWXs1do2JJO93aWcaD6nC; expires=Wed, 26-Feb-2020 23:33:43 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Length","value":"196"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"success\",\n \"details\": [\n {\n \"date\": \"2020-02-26T21:33:43+00:00\",\n \"webhook\": \"test\",\n \"target_url\": \"https://api.prod.rsa.global/api/projects/webhooks/test\",\n \"payload\": [\n {\n \"example\": \"payload\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"57ce6377-5d22-42cc-9701-135f23956319"}],"id":"e5c65782-574e-4039-802c-d472a294f12d","description":"Register and manage webhooks.
\n","_postman_id":"e5c65782-574e-4039-802c-d472a294f12d"},{"name":"/api/collections","item":[{"name":"/collection/webhooks","id":"99296547-940c-4f72-9028-fb831967b982","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/api/collections/collection/webhooks","description":"Returns a list of available webhooks to configure.
\n","urlObject":{"path":["api","collections","collection","webhooks"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4fa0a144-f9b5-44c2-ac95-aba88fcd698b","name":"/collection/webhooks","originalRequest":{"method":"GET","header":[],"url":"{{url}}/api/collections/collection/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Feb 2020 21:07:16 GMT"},{"key":"Server","value":"Apache/2.4.41 (Amazon) OpenSSL/1.0.2k-fips PHP/7.3.13"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Set-Cookie","value":"buytasker_session=voE516v50fk8s9Emwd9PWXs1do2JJO93aWcaD6nC; expires=Wed, 26-Feb-2020 23:07:16 GMT; Max-Age=7200; path=/; httponly"},{"key":"Content-Length","value":"666"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"success\",\n \"model\": [\n {\n \"id\": 5,\n \"webhook_name\": \"projects.contract.received\",\n \"description\": \"An agreed contract rate has been attached to your account.\"\n },\n {\n \"id\": 6,\n \"webhook_name\": \"projects.dimdata\",\n \"description\": \"A collection of confirmed parcel dimension data and image.\"\n },\n {\n \"id\": 3,\n \"webhook_name\": \"projects.rate.accepted\",\n \"description\": \"Your attached rate was used to make a booking.\"\n },\n {\n \"id\": 2,\n \"webhook_name\": \"projects.rate.received\",\n \"description\": \"An rate card has been attached to your quote request or account.\"\n },\n {\n \"id\": 1,\n \"webhook_name\": \"tracking.events\",\n \"description\": \"A collection of tracking events broadcast throughout the lifecycle of a project shipment.\"\n }\n ]\n}"}],"_postman_id":"99296547-940c-4f72-9028-fb831967b982"},{"name":"/collection/tracking","id":"5e4ee43f-a8db-4238-a5a9-13a49cc9100c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/api/collections/collection/tracking","description":"Returns a list of available tracking events and definitions.
\n","urlObject":{"path":["api","collections","collection","tracking"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"931aae93-7cff-4a0b-bb9e-ae443d2917c5","name":"/tracking","originalRequest":{"method":"GET","header":[],"url":"{{url}}/api/collections/collection/tracking"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Mar 2020 00:51:05 GMT"},{"key":"Server","value":"Apache/2.4.41 (Amazon) OpenSSL/1.0.2k-fips PHP/7.3.13"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/7.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Set-Cookie","value":"buytasker_session=KEF8ous13FTtEO0MtECJHCxWzoPpOeGFhQiARm3G; expires=Tue, 03-Mar-2020 02:51:05 GMT; Max-Age=7200; path=/; httponly"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"success\",\n \"model\": [\n {\n \"code\": \"CAT-1\",\n \"description\": \"Tracking number allocated & order ready\",\n \"definition\": \"The parcel has been created but is waiting to be manifested (i.e. despatched)\"\n },\n {\n \"code\": \"CAT-2\",\n \"description\": \"Held at Export Hub\",\n \"definition\": \"The parcel has been held Customs at origin\"\n },\n {\n \"code\": \"CAT-3\",\n \"description\": \"Processed through Export Hub\",\n \"definition\": \"The parcel has passed through an Origin Facility\"\n },\n {\n \"code\": \"CAT-4\",\n \"description\": \"International transit to destination country\",\n \"definition\": \"The parcel has started its International Transit\"\n },\n {\n \"code\": \"CAT-5\",\n \"description\": \"Customs cleared\",\n \"definition\": \"The parcel has been cleared for delivery\"\n },\n {\n \"code\": \"CAT-6\",\n \"description\": \"Customs held for inspection and clearance\",\n \"definition\": \"The parcel has been held by Customs at destination\"\n },\n {\n \"code\": \"CAT-7\",\n \"description\": \"Picked up by Delivery Courier\",\n \"definition\": \"The carrier has successfully collected a parcel from a customer\"\n },\n {\n \"code\": \"CAT-8\",\n \"description\": \"Manifest Received by Carrier\",\n \"definition\": \"The carrier has received an electronic (manifest for this parcel\"\n },\n {\n \"code\": \"CAT-9\",\n \"description\": \"Not yet received by carrier\",\n \"definition\": \"The carrier has yet to receive the parcel into their network\"\n },\n {\n \"code\": \"CAT-10\",\n \"description\": \"Received by carrier\",\n \"definition\": \"The carrier has acknowledged receipt of the parcel into their network\"\n },\n {\n \"code\": \"CAT-11\",\n \"description\": \"Received by carrier – no manifest sent\",\n \"definition\": \"The carrier has acknowledged receipt of the parcel into their network but did not receive the required electronic manifest\"\n },\n {\n \"code\": \"CAT-12\",\n \"description\": \"Collection request received by carrier\",\n \"definition\": \"A collection request has been acknowledged by the carrier\"\n },\n {\n \"code\": \"CAT-13\",\n \"description\": \"Misdirected\",\n \"definition\": \"The parcel has been misrouted by the carrier due to incorrect routing on the label\"\n },\n {\n \"code\": \"CAT-14\",\n \"description\": \"\",\n \"definition\": \"\"\n },\n {\n \"code\": \"CAT-15\",\n \"description\": \"Parcel lost\",\n \"definition\": \"The parcel has been advised as lost within the carriers network\"\n },\n {\n \"code\": \"CAT-16\",\n \"description\": \"Parcel Delayed\",\n \"definition\": \"The parcel has been delayed\"\n },\n {\n \"code\": \"CAT-17\",\n \"description\": \"Parcel Damaged\",\n \"definition\": \"The parcel has been damaged\"\n },\n {\n \"code\": \"CAT-18\",\n \"description\": \"In transit\",\n \"definition\": \"The parcel is in transit\"\n },\n {\n \"code\": \"CAT-19\",\n \"description\": \"Awaiting Collection\",\n \"definition\": \"The parcel has been left at the local Collection Point / Post Office for collection\"\n },\n {\n \"code\": \"CAT-20\",\n \"description\": \"Sub-contractor update\",\n \"definition\": \"The parcel is with a 3rd party / sub-contractor and a tracking update has occurred\"\n },\n {\n \"code\": \"CAT-21\",\n \"description\": \"Out for delivery\",\n \"definition\": \"The parcel is on its way to be delivered\"\n },\n {\n \"code\": \"CAT-22\",\n \"description\": \"Received by Sub-contractor\",\n \"definition\": \"The parcel has been received by a sub-contractor / 3rd party carrier\"\n },\n {\n \"code\": \"CAT-23\",\n \"description\": \"Invalid / Insufficent Address\",\n \"definition\": \"The parcel has an invalid or insufficent address on it\"\n },\n {\n \"code\": \"CAT-24\",\n \"description\": \"Attempted Delivery - Receiver carded\",\n \"definition\": \"The carrier has left a card for the receiver as they were unable to deliver the parcel\"\n },\n {\n \"code\": \"CAT-25\",\n \"description\": \"Customer to collect from carrier\",\n \"definition\": \"The parcel is available to collect from the carriers facility\"\n },\n {\n \"code\": \"CAT-26\",\n \"description\": \"Held by carrier\",\n \"definition\": \"The parcel is being held by the delivery carrier\"\n },\n {\n \"code\": \"CAT-27\",\n \"description\": \"Attempted Delivery - Customer not known at address\",\n \"definition\": \"The receiver is not known at the address\"\n },\n {\n \"code\": \"CAT-28\",\n \"description\": \"Attempted Delivery - Refused by customer\",\n \"definition\": \"The receiver refused to take delivery of the parcel\"\n },\n {\n \"code\": \"CAT-29\",\n \"description\": \"Return to sender\",\n \"definition\": \"The parcel is to be returned to the sender\"\n },\n {\n \"code\": \"CAT-30\",\n \"description\": \"Non delivery\",\n \"definition\": \"The carrier was unable to deliver the parcel\"\n },\n {\n \"code\": \"CAT-31\",\n \"description\": \"Information\",\n \"definition\": \"The carrier has provided some information about the delivery or parcel\"\n },\n {\n \"code\": \"CAT-32\",\n \"description\": \"\",\n \"definition\": \"\"\n },\n {\n \"code\": \"CAT-33\",\n \"description\": \"\",\n \"definition\": \"\"\n },\n {\n \"code\": \"CAT-34\",\n \"description\": \"Cancelled\",\n \"definition\": \"The delivery / collection has requested to be cancelled\"\n },\n {\n \"code\": \"CAT-35\",\n \"description\": \"Mis sorted by carrier\",\n \"definition\": \"The parcel was mis sorted by the carrier and sent to the incorrect delivery depot\"\n },\n {\n \"code\": \"CAT-36\",\n \"description\": \"Delivery arranged with receiver\",\n \"definition\": \"The receiver has arranged a delivery with the carrier\"\n },\n {\n \"code\": \"CAT-37\",\n \"description\": \"Attempted Delivery - No access to receivers address\",\n \"definition\": \"The carrier attempted to deliver the parcel but was unable to access the receivers address\"\n },\n {\n \"code\": \"CAT-38\",\n \"description\": \"Attempted Delivery - Customer Identification failed\",\n \"definition\": \"The receivers identification failed when checked by carrier\"\n },\n {\n \"code\": \"CAT-39\",\n \"description\": \"Package repacked\",\n \"definition\": \"The parcel has been reboxed / repacked\"\n },\n {\n \"code\": \"CAT-40\",\n \"description\": \"Package disposed\",\n \"definition\": \"The parcel has been requested to be disposed\"\n },\n {\n \"code\": \"CAT-41\",\n \"description\": \"Incorrect details declared by sender\",\n \"definition\": \"The sender has declared incorrect weight of the parcel which does not match actual weight\"\n },\n {\n \"code\": \"CAT-42\",\n \"description\": \"Awaiting collection\",\n \"definition\": \"The parcel is awaiting to be collected by the recepient\"\n },\n {\n \"code\": \"CAT-43\",\n \"description\": \"Not collected from store\",\n \"definition\": \"The parcel has not been collected from the collection point\"\n },\n {\n \"code\": \"CAT-44\",\n \"description\": \"\",\n \"definition\": \"\"\n },\n {\n \"code\": \"CAT-45\",\n \"description\": \"Attempted delivery\",\n \"definition\": \"The carrier attempted delivering the parcel but could not deliver.\"\n },\n {\n \"code\": \"CAT-46\",\n \"description\": \"Customer Enquiry lodged\",\n \"definition\": \"A customer Investigation has been lodged for this parcel\"\n },\n {\n \"code\": \"CAT-47\",\n \"description\": \"Processed through Sorting Facility\",\n \"definition\": \"The parcel has processed through a carrier facility\"\n },\n {\n \"code\": \"CAT-48\",\n \"description\": \"With Delivery Courier\",\n \"definition\": \"The parcel is with Delivery Courier\"\n },\n {\n \"code\": \"CAT-49\",\n \"description\": \"Held by Delivery Courier\",\n \"definition\": \"The parcel has been held by delivery courier\"\n },\n {\n \"code\": \"CAT-50\",\n \"description\": \"Parcel arrived to courier processing facility\",\n \"definition\": \"The parcel has arrived to a delivery courier processing facility\"\n },\n {\n \"code\": \"CAT-51\",\n \"description\": \"Parcel departed courier processing facility\",\n \"definition\": \"The parcel has departed a delivery courier processing facility\"\n },\n {\n \"code\": \"CAT-52\",\n \"description\": \"Parcel Redirection Requested\",\n \"definition\": \"A parcel redirection has been requested\"\n },\n {\n \"code\": \"CAT-53\",\n \"description\": \"Parcel Redirected\",\n \"definition\": \"A parcel has been redirected\"\n },\n {\n \"code\": \"CAT-54\",\n \"description\": \"Transferred to Collection Point\",\n \"definition\": \"A parcel has been transferred to a Post Office/Collection Point\"\n },\n {\n \"code\": \"CAT-55\",\n \"description\": \"Attempted Delivery - Returned to Sender\",\n \"definition\": \"Attempted Delivery - Returned to Sender\"\n },\n {\n \"code\": \"CAT-56\",\n \"description\": \"Transferred to delivery provider\",\n \"definition\": \"The parcel has been transferred to the delivery provider\"\n },\n {\n \"code\": \"CAT-57\",\n \"description\": \"RTS Received - Authorised Return\",\n \"definition\": \"The parcel has been returned and received by our warehouse. The parcel was returned due to being an Authorised Return\"\n },\n {\n \"code\": \"CAT-58\",\n \"description\": \"RTS Received - Cancelled Order\",\n \"definition\": \"The parcel has been returned and received by our warehouse. The parcel was returned due to being an Cancelled Order\"\n },\n {\n \"code\": \"CAT-59\",\n \"description\": \"RTS Received - Card Left, Never Collected\",\n \"definition\": \"The parcel has been returned and received by our warehouse. The parcel was returned due to card left, never collected\"\n },\n {\n \"code\": \"CAT-60\",\n \"description\": \"RTS - Fraudulant\",\n \"definition\": \"Return to Sender due to Fraudulant order\"\n },\n {\n \"code\": \"CAT-61\",\n \"description\": \"RTS Received - Invalid or Insufficient Address\",\n \"definition\": \"The parcel has been returned and received by our warehouse. The parcel was returned due to invalid or insufficient address received\"\n },\n {\n \"code\": \"CAT-62\",\n \"description\": \"RTS Received- No Reason Given\",\n \"definition\": \"The parcel has been returned and received by our warehouse. The parcel was returned but no reason was given by domestic carrier\"\n },\n {\n \"code\": \"CAT-63\",\n \"description\": \"RTS - High Value Rejected\",\n \"definition\": \"Return to Sender due to High Value rejected by receiver\"\n },\n {\n \"code\": \"CAT-64\",\n \"description\": \"RTS Received - Refused\",\n \"definition\": \"The parcel has been returned and received by our warehouse. The parcel was returned due to the receiver refused parcel\"\n },\n {\n \"code\": \"CAT-65\",\n \"description\": \"RTS Received - Unclaimed\",\n \"definition\": \"The parcel has been returned and received by our warehouse. The parcel was returned due to being unclaimed\"\n },\n {\n \"code\": \"CAT-66\",\n \"description\": \"Return to Sender\",\n \"definition\": \"Returned to Sender\"\n },\n {\n \"code\": \"CAT-67\",\n \"description\": \"RTS - Cancelled Order\",\n \"definition\": \"The parcel has will be Returned to Sender due to Cancelled Order\"\n },\n {\n \"code\": \"CAT-68\",\n \"description\": \"RTS Received\",\n \"definition\": \"The parcel as been returned and received by our warehouse\"\n },\n {\n \"code\": \"CAT-69\",\n \"description\": \"RTS Received - Damaged Parcel\",\n \"definition\": \"The parcel as been returned and received by our warehouse. The parcel was returned due to being damaged\"\n },\n {\n \"code\": \"CAT-70\",\n \"description\": \"Parcel Blocked\",\n \"definition\": \"The parcel was blocked and has been held\"\n },\n {\n \"code\": \"CAT-71\",\n \"description\": \"Delivered in part\",\n \"definition\": \"The carrier has delivered only part of the consignment\"\n },\n {\n \"code\": \"CAT-72\",\n \"description\": \"Delivered\",\n \"definition\": \"The parcel has been successfully delivered\"\n },\n {\n \"code\": \"CAT-73\",\n \"description\": \"Delivered to neighbour\",\n \"definition\": \"The parcel has been delivered to a neighbour's address\"\n },\n {\n \"code\": \"CAT-74\",\n \"description\": \"Delivered - Authority to Leave / Safe Drop\",\n \"definition\": \"The parcel has been delivered to a safe place or has had authority to leave\"\n },\n {\n \"code\": \"CAT-75\",\n \"description\": \"Delivered - Parcel Collected\",\n \"definition\": \"The parcel has been collected by the receiver\"\n },\n {\n \"code\": \"CAT-76\",\n \"description\": \"Delivered to locker/collection point\",\n \"definition\": \"The parcel has been delivered to a locker or collection point and is ready to be collected by the receiver\"\n },\n {\n \"code\": \"CAT-77\",\n \"description\": \"Delivered to alternate delivery point\",\n \"definition\": \"The parcel has been delivered to the receivers preferred point instead of collecting from depot or re-delivery or return\"\n }\n ]\n}"}],"_postman_id":"5e4ee43f-a8db-4238-a5a9-13a49cc9100c"}],"id":"dba66e5c-bf66-4b36-b44b-6fe6fa1614ce","description":"A selection of collections pertaining to /projects.
\n","_postman_id":"dba66e5c-bf66-4b36-b44b-6fe6fa1614ce"},{"name":"Request Access Token","id":"b1c2b8ee-e633-4e4c-be95-ffc8c0c134e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apikey}}","type":"text"}],"url":"{{url}}/api/customers/request/token","description":"Use your provided API key to request and store you APi Access Token.
\n","urlObject":{"path":["api","customers","request","token"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1c2b8ee-e633-4e4c-be95-ffc8c0c134e2"}],"event":[{"listen":"prerequest","script":{"id":"8a89171c-c093-495f-af88-e141a0d7ec3f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"146bdef3-632e-4d47-b378-edd89354cd47","type":"text/javascript","exec":[""]}}]}