This is the official documentation for the consumption of ShaQ Express Public API.
\nIt covers the authentication, request and responses.
\nIn order to be able to consume this API, you will need to first create an account by downloading the shaQ Express app from AppStore or Google Play Store then send an email to info@shaqexpress.com which contains your ShaQ Express account phone number and email address stating your reason to use our API.
\nOnce your account is approved to use the API, we will send you an email containing your API Token and API Url
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32202651","collectionId":"ceb4a3de-557c-40dd-aa8e-0fc33e440772","publishedId":"2sAYQWLuLm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-13T12:26:25.000Z"},"item":[{"name":"Trips","item":[{"name":"Book Trip","id":"9d43e0f0-c53b-446a-9e24-d6b0441742a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tracking_number\": \"25-10-31-37O3VL\",\n \"price_id\": 71412\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/trips/book-trip","description":"Book a trip
\n","urlObject":{"path":["trips","book-trip"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"717b587c-2440-4f91-a3df-4a32c37daf35","name":"Book Trip","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tracking_number\": \"25-01-13-ZS3XSB\",\n \"price_id\": 41181\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/book"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2025 15:39:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=GfxsYTqmdO15A%2BwmVqkYp6%2FkyiHA%2BzQvrYrUToQBT2fvE1XICOpDOJkfWHrHP0IwOZPEsGHyNXVOVeliXXuqK8jM21VoFhpsz4NcVU8%2F76Ir3Tp4bnrGrVCNHkgrQyaUPfsyHGg8WA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90167a001f24ee04-ACC"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=175149&min_rtt=45324&rtt_var=247251&sent=73&recv=71&lost=0&retrans=3&sent_bytes=8413&recv_bytes=2217&delivery_rate=91871&cwnd=4&unsent_bytes=0&cid=b2a4804f34fef729&ts=73464&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"trip booked\",\n \"data\": {\n \"tracking_number\": \"25-01-13-ZS3XSB\",\n \"client_reference\": \"1234567890\",\n \"tracking_url\": \"https://www.shaqexpress.com/tracking/25-01-13-ZS3XSB\",\n \"amount\": 229,\n \"status\": \"booked\"\n }\n}"}],"_postman_id":"9d43e0f0-c53b-446a-9e24-d6b0441742a8"},{"name":"Book Trip Copy","id":"f6a4e055-c1fe-4f61-94d7-43dc2926306a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tracking_number\": \"25-10-31-37O3VL\",\n \"price_id\": 71412\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/trips","description":"Book a trip
\n","urlObject":{"path":["trips"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"17c2ccef-4b93-4e21-b523-2c144a2faba6","name":"Book Trip","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tracking_number\": \"25-01-13-ZS3XSB\",\n \"price_id\": 41181\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/book"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2025 15:39:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=GfxsYTqmdO15A%2BwmVqkYp6%2FkyiHA%2BzQvrYrUToQBT2fvE1XICOpDOJkfWHrHP0IwOZPEsGHyNXVOVeliXXuqK8jM21VoFhpsz4NcVU8%2F76Ir3Tp4bnrGrVCNHkgrQyaUPfsyHGg8WA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90167a001f24ee04-ACC"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=175149&min_rtt=45324&rtt_var=247251&sent=73&recv=71&lost=0&retrans=3&sent_bytes=8413&recv_bytes=2217&delivery_rate=91871&cwnd=4&unsent_bytes=0&cid=b2a4804f34fef729&ts=73464&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"trip booked\",\n \"data\": {\n \"tracking_number\": \"25-01-13-ZS3XSB\",\n \"client_reference\": \"1234567890\",\n \"tracking_url\": \"https://www.shaqexpress.com/tracking/25-01-13-ZS3XSB\",\n \"amount\": 229,\n \"status\": \"booked\"\n }\n}"}],"_postman_id":"f6a4e055-c1fe-4f61-94d7-43dc2926306a"},{"name":"Cancel Trip","id":"91116f21-1576-4c97-a8ac-562953eff586","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tracking_number\": \"25-03-10-YHT6RZ\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/trips/cancel","description":"Cancel trip before they are started
\n","urlObject":{"path":["trips","cancel"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4c93cae8-dfa2-42b8-a3db-c070e6f47d1e","name":"Cancel Trip","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tracking_number\": \"25-01-13-ZS3XSB\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2025 15:39:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=xNC4yM88X%2BNbEbGteVGkkHvOOKROIWdmGw5kOkSVcLTXdwFS0kflmI7%2Bs5e5h4gCEyKlLCLxpBCT%2FEqvy7eHXxyj8lgfRkmslr05KtsJw5h9Q%2BhuNXL0S%2FZreZt83R8%2FYGm1tYz4dw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90167b0778bdee04-ACC"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=142185&min_rtt=45324&rtt_var=113720&sent=112&recv=110&lost=0&retrans=3&sent_bytes=10681&recv_bytes=3109&delivery_rate=91871&cwnd=4&unsent_bytes=0&cid=b2a4804f34fef729&ts=115392&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"trip cancelled\",\n \"data\": {\n \"tracking_number\": \"25-01-13-ZS3XSB\",\n \"client_reference\": \"1234567890\",\n \"amount\": 229,\n \"status\": \"cancelled\"\n }\n}"}],"_postman_id":"91116f21-1576-4c97-a8ac-562953eff586"},{"name":"Check Trip Status","id":"8f858624-38e5-425a-af77-79d801cfb701","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/trips/status?tracking_number=26-01-22-LJ79UJ","description":"Cancel trip before they are started
\n","urlObject":{"path":["trips","status"],"host":["{{base_url}}"],"query":[{"key":"tracking_number","value":"26-01-22-LJ79UJ"}],"variable":[]}},"response":[{"id":"630aad49-fba0-4aae-b7e5-2493bff5174c","name":"Cancel Trip","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tracking_number\": \"25-01-13-ZS3XSB\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2025 15:39:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=xNC4yM88X%2BNbEbGteVGkkHvOOKROIWdmGw5kOkSVcLTXdwFS0kflmI7%2Bs5e5h4gCEyKlLCLxpBCT%2FEqvy7eHXxyj8lgfRkmslr05KtsJw5h9Q%2BhuNXL0S%2FZreZt83R8%2FYGm1tYz4dw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90167b0778bdee04-ACC"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=142185&min_rtt=45324&rtt_var=113720&sent=112&recv=110&lost=0&retrans=3&sent_bytes=10681&recv_bytes=3109&delivery_rate=91871&cwnd=4&unsent_bytes=0&cid=b2a4804f34fef729&ts=115392&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"trip cancelled\",\n \"data\": {\n \"tracking_number\": \"25-01-13-ZS3XSB\",\n \"client_reference\": \"1234567890\",\n \"amount\": 229,\n \"status\": \"cancelled\"\n }\n}"}],"_postman_id":"8f858624-38e5-425a-af77-79d801cfb701"}],"id":"f8ff9355-9cb1-4415-a103-5967341e17c2","description":"This covers the documentation of all request concerning trips bookings.
\n","_postman_id":"f8ff9355-9cb1-4415-a103-5967341e17c2"},{"name":"Check Available Pricing","id":"94c23e8c-102b-4cc1-8bc3-9e2e2fd4820b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"package_type\": \"bike\",\n \"delivery_notes\": \"test\",\n \"pickup_phone_number\": \"0549632604\",\n\n \"pickup_lng\": \"-0.173\",\n \"pickup_lat\": \"5.622\",\n \"reference\": \"34245234\",\n \"drop_offs\": [\n {\n \"lng\": \"-0.173\",\n \"lat\": \"5.622\",\n \"phone\": \"0202009791\"\n }\n ]\n}\n// \"amount_paid\": \"20\",\n// \"pickup_lng\": \"0.255939\",\n// \"pickup_lat\": \"5.711032\",\n\n// {\n// \"package_type\":\"bike\",\n// \"delivery_notes\":\"test\",\n// \"pickup_phone_number\":\"0202009791\",\n \n// \"pickup_lat\":\"5.5682665\",\n// \"pickup_lng\":\"-0.1717396\",\n// \"reference\":\"34245234\",\n// \"drop_offs\":[ \n// {\n// \"lat\":\"5.681543433789159\",\n// \"lng\":\"0.19312680142973326\",\n// \"phone\":\"0202009791\"\n// }\n// ]\n// // \"drop_offs\": [\n// // \"hello\"\n// // ]\n// }","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/trips/trip-pricing","description":"Check all available pricing and delivery methods of a trip
\n","urlObject":{"path":["trips","trip-pricing"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ca9f6633-ffed-4a3a-bf5c-aa06474781c5","name":"Check Available Pricing","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"// {\n// \"package_type\": \"bike\",\n// \"delivery_notes\": \"test\",\n// \"pickup_phone_number\": \"02020097911\",\n// \"pickup_lng\": \"-0.201163\",\n// \"pickup_lat\": \"5.545797\",\n// // \"pickup_lng\": \"-0.20771\",\n// // \"pickup_lat\": \"5.66937\",\n// \"reference\": \"34245234\",\n// // \"amount_paid\": \"20\",\n// \"drop_offs\": [\n// {\n// \"lng\": \"0.0041014\",\n// \"lat\": \"5.740598\",\n// \"phone\": \"0202009791\"\n// }\n// ]\n// }\n\n{\n \"package_type\":\"bike\",\n \"delivery_notes\":\"test\",\n \"pickup_phone_number\":\"0202009791\",\n \"pickup_lat\":\"5.545797\",\n \"pickup_lng\":\"-0.201163\",\n \"reference\":\"34245234\",\n \"drop_offs\":[ \n {\n \"lat\":\"5.591299\",\n \"lng\":\"-0.198539\",\n \"phone\":\"0202009791\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/trips/trip-pricing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 Mar 2025 16:41:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=7JuPQ7%2Beoplmf2SH7n0J9L75wrq3RXKBkKtGEnCbDbQaXd%2FNBL0h1yzfqg7q5dYI%2BNjjOFdX%2Fl5LXUpM6QbzRlfU%2BMi0a7ofuho%2BuvB%2BwdsIwTLLA%2BWnSq1egrQ4UWjgnuk9Sj5epsuG\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"927892b7c9a84ec6-JNB"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=183943&min_rtt=96151&rtt_var=67464&sent=80&recv=77&lost=0&retrans=0&sent_bytes=6309&recv_bytes=3854&delivery_rate=30092&cwnd=256&unsent_bytes=0&cid=884c6f51c682c276&ts=80532&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"trip created\",\n \"data\": {\n \"tracking_number\": \"25-03-28-NWENH7\",\n \"client_reference\": \"34245234\",\n \"status\": null,\n \"prices\": [\n {\n \"id\": 50176,\n \"delivery_type\": \"Express\",\n \"vehicle_type\": \"Motor\",\n \"charge\": 60,\n \"is_available\": false,\n \"expiration\": \"2025-03-28T16:56:07.000000Z\"\n },\n {\n \"id\": 50177,\n \"delivery_type\": \"Express\",\n \"vehicle_type\": \"Car\",\n \"charge\": 183,\n \"is_available\": false,\n \"expiration\": \"2025-03-28T16:56:07.000000Z\"\n },\n {\n \"id\": 50178,\n \"delivery_type\": \"Normal\",\n \"vehicle_type\": \"Motor\",\n \"charge\": 35,\n \"is_available\": true,\n \"expiration\": \"2025-03-28T16:56:07.000000Z\"\n },\n {\n \"id\": 50179,\n \"delivery_type\": \"Normal\",\n \"vehicle_type\": \"Car\",\n \"charge\": 148,\n \"is_available\": true,\n \"expiration\": \"2025-03-28T16:56:07.000000Z\"\n }\n ]\n }\n}"}],"_postman_id":"94c23e8c-102b-4cc1-8bc3-9e2e2fd4820b"},{"name":"Callback Request","id":"206f3f9f-90a9-46e3-9954-a8beafb23f7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"event\": \"trips/assigned\",\n\"tracking_number\": \"26-01-14-UWEP2C\",\n\"client_reference\": \"000256\",\n\"status\": \"assigned\"\n}","options":{"raw":{"language":"json"}}},"url":"https://test.weiveshop.com/api/shipping/shaq/webhook","description":"Request made to the user's callback url when a trip is updated
\n","urlObject":{"protocol":"https","path":["api","shipping","shaq","webhook"],"host":["test","weiveshop","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"206f3f9f-90a9-46e3-9954-a8beafb23f7f"}],"event":[{"listen":"prerequest","script":{"id":"c9b7f59a-dcfc-4c12-8999-f51d264da38f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b73cdb76-8cac-4fbe-8b8e-bdbd8409ba4a","type":"text/javascript","packages":{},"exec":[""]}}]}