Verify the payload validity according to job's creation requirements.
\nWe recommend to read through the setup for success guide to avoid common errors when setting up the integration.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"Request the price for a job by using the same request payload used to create a job.
\nThe minimal details required to get the pricing are the pickup and dropoff address, and package_type information.
The response will detail the price of the job both including and excluding tax and the currency.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"This endpoint allows you to get an estimated time in seconds of arrival at the origin address using exactly the same request body as the Create a job endpoint.
Read more about how you might use this endpoint on our Developer Portal guide.
This endpoint allows you to get an estimated time of arrival in seconds at the destination address for a given Job.
\nPlease note that if you wish to provide coordinates, you must also provide the textual address.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"Update some details of a job in accordance with the restrictions detailed below.
When the delivery status is pending, picking, almost_picking, waiting_at_pickup you can update:
client_reference
package_description
pickup.comment
pickup.contact.firstname
pickup.contact.lastname
pickup.contact.phone
pickup.contact.email
pickup.contact.company_name
dropoff.comment
dropoff.contact.firstname
dropoff.contact.lastname
dropofff.contact.phone
dropoff.contact.email
dropoff.contact.company
When the delivery status is delivering, almost_delivering, waiting_at_dropoff you can update:
client_reference
package_description
dropoff.comment
dropoff.contact.firstname
dropoff.contact.lastname
dropoff.contact.phone
dropoff.contact.email
dropoff.contact.company
When the delivery status is delivered you can only update the client_reference
(Required) Job's id returned in the job creation response
\n","type":"text/plain"},"type":"any","value":"100202989","key":"jobId"}]}},"response":[{"id":"8577148c-ebc2-4805-8a02-647e6b014e2f","name":"200 - OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"job\": {\n \"deliveries\": [\n {\n \"id\": [delivery_id],\n \"client_reference\": \"124356789\",\n \"comment\": \"New comment\",\n \"package_description\": \"Small green package\",\n \"pickup\": {\n \"comment\": \"Updated pickup comment\",\n \"contact\": {\n \"company_name\": \"Updated Company Name\",\n \"firstname\": \"My firstname\",\n \"lastname\": \"My last name\",\n \"phone\": \"+33610101010\",\n \"email\": \"pickup@company.com\"\n }\n },\n \"dropoff\": {\n \"comment\": \"Updated dropoff comment\",\n \"contact\": {\n \"company_name\": \"Dropoff Company Name\",\n \"firstname\": \"Customer's firstname\",\n \"lastname\": \"Customer's lastname\",\n \"phone\": \"+33620202020\",\n \"email\": \"dropoff@company.com\"\n }\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/jobs/[job_id]"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Sep 2022 15:44:36 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Status","value":"200 OK","enabled":true},{"key":"Vary","value":"Accept-Encoding, Origin","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Stuart-Stack","value":"V3","enabled":true},{"key":"X-Request-Id","value":"5c9edbd6-5b65-44ee-b3a5-20198ba57872","enabled":true},{"key":"X-MinuteRateLimit-Limit","value":"1000","enabled":true},{"key":"X-MinuteRateLimit-Remaining","value":"999","enabled":true},{"key":"X-DailyRateLimit-Identifier","value":"ratelimit:89.91.9.3:2022-09-09","enabled":true},{"key":"ETag","value":"W/\"bef6d06e8ad5509818a5bdec2fbc48ad\"","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","enabled":true},{"key":"X-DailyRateLimit-Limit","value":"500000","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-MinuteRateLimit-Identifier","value":"ratelimit:89.91.9.3:2022-09-09-17-44","enabled":true},{"key":"X-DailyRateLimit-Remaining","value":"499940","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Runtime","value":"0.586481","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Powered-By","value":"Phusion Passenger 5.2.3","enabled":true},{"key":"Server","value":"nginx/1.12.2 + Phusion Passenger 5.2.3","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 100307763,\n \"created_at\": \"2022-09-09T17:41:50.000+02:00\",\n \"status\": \"in_progress\",\n \"package_type\": \"medium\",\n \"transport_type\": \"walk\",\n \"assignment_code\": null,\n \"pickup_at\": null,\n \"dropoff_at\": null,\n \"ended_at\": null,\n \"comment\": null,\n \"distance\": 0.919,\n \"duration\": 5,\n \"traveled_time\": 0,\n \"traveled_distance\": 0,\n \"deliveries\": [\n {\n \"id\": 100355015,\n \"status\": \"picking\",\n \"picked_at\": null,\n \"delivered_at\": null,\n \"tracking_url\": \"https://stuart.sandbox.followmy.delivery/100355015/8ebdcbf85f1279527670d385c750d5f0\",\n \"client_reference\": \"124356789\",\n \"package_description\": \"Small green package\",\n \"package_type\": \"medium\",\n \"fleet_ids\": [\n 42,\n 1\n ],\n \"pickup\": {\n \"id\": 2277299,\n \"address\": {\n \"street\": \"32 Coombe Lane\",\n \"postcode\": \"SW20 0LA\",\n \"city\": \"London\",\n \"zone\": \"london\",\n \"country\": \"The United Kingdom\",\n \"formatted_address\": \"32 Coombe Lane, SW20 0LA, London, The United Kingdom\"\n },\n \"latitude\": 51.4096757,\n \"longitude\": -0.2301377,\n \"comment\": \"Updated pickup comment\",\n \"contact\": {\n \"firstname\": \"My firstname\",\n \"lastname\": \"My last name\",\n \"phone\": \"+33610101010\",\n \"company_name\": \"Updated Company Name\",\n \"email\": \"pickup@company.com\"\n },\n \"access_codes\": [\n {\n \"code\": \"your_access_code_1\",\n \"type\": \"text\",\n \"title\": \"access code title\",\n \"instructions\": \"please put your instructions here\"\n }\n ]\n },\n \"dropoff\": {\n \"id\": 2277300,\n \"address\": {\n \"street\": \"23 Ethelbert Road\",\n \"postcode\": \"SW20 8QD\",\n \"city\": \"London\",\n \"zone\": \"london\",\n \"country\": \"The United Kingdom\",\n \"formatted_address\": \"23 Ethelbert Road, SW20 8QD, London, The United Kingdom\"\n },\n \"latitude\": 51.4133427,\n \"longitude\": -0.2208565,\n \"comment\": \"Updated dropoff comment\",\n \"contact\": {\n \"firstname\": \"Customer's firstname\",\n \"lastname\": \"Customer's lastname\",\n \"phone\": \"+33620202020\",\n \"company_name\": \"Dropoff Company Name\",\n \"email\": \"dropoff@company.com\"\n },\n \"access_codes\": [\n {\n \"code\": \"your_access_code_2\",\n \"type\": \"text\",\n \"title\": \"access code title\",\n \"instructions\": \"please put your instructions here\"\n }\n ]\n },\n \"cancellation\": {\n \"canceled_by\": null,\n \"reason_key\": null,\n \"comment\": null\n },\n \"eta\": {\n \"pickup\": \"2022-09-09T17:54:31.000+02:00\",\n \"dropoff\": \"2022-09-09T18:05:12.000+02:00\"\n },\n \"proof\": {\n \"signature_url\": null\n },\n \"package_image_url\": null\n }\n ],\n \"driver\": {\n \"id\": 422498,\n \"display_name\": \"Hassan D.\",\n \"phone\": \"+33445734156\",\n \"picture_url\": null,\n \"transport_type\": \"walk\",\n \"latitude\": 51.41294861,\n \"longitude\": -0.22125\n },\n \"pricing\": {\n \"price_tax_included\": 8.81,\n \"price_tax_excluded\": 8.81,\n \"tax_amount\": 0,\n \"invoice_url\": null,\n \"tax_percentage\": 0.2,\n \"currency\": \"GBP\"\n },\n \"rating\": null\n}"},{"id":"c4baaa85-7d0d-45e0-8ceb-546d82b62e1a","name":"404 - Job not found","originalRequest":{"method":"PATCH","header":[{"name":"Content-Type","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job\": {\n \"deliveries\": [\n {\n \"id\": [delivery_id],\n \"package_description\": \"Big red package\",\n \"pickup\": {\n \"comment\": \"test comment\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/jobs/1223456"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"NOT_FOUND\",\n \"message\": \"Not found\"\n}"},{"id":"3e60a42f-5bb0-4393-9f18-f4d33d234e88","name":"404 - Delivery not found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"job\": {\n \"deliveries\": [\n {\n \"id\": 1000001,\n \"client_reference\": \"124356789\",\n \"comment\": \"New comment\",\n \"package_description\": \"Small green package\",\n \"pickup\": {\n \"comment\": \"Updated pickup comment\",\n \"contact\": {\n \"company_name\": \"Updated Company Name\",\n \"firstname\": \"My firstname\",\n \"lastname\": \"My last name\",\n \"phone\": \"+33610101010\",\n \"email\": \"pickup@company.com\"\n }\n },\n \"dropoff\": {\n \"comment\": \"Updated dropoff comment\",\n \"contact\": {\n \"company_name\": \"Dropoff Company Name\",\n \"firstname\": \"Customer's firstname\",\n \"lastname\": \"Customer's lastname\",\n \"phone\": \"+33620202020\",\n \"email\": \"dropoff@company.com\"\n }\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/jobs/[job_id]"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Sep 2022 14:13:38 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Status","value":"404 Not Found","enabled":true},{"key":"Vary","value":"Accept-Encoding, Origin","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Stuart-Stack","value":"V3","enabled":true},{"key":"X-Request-Id","value":"3fa16e52-fea1-4e5d-82c2-c90062a4a086","enabled":true},{"key":"X-MinuteRateLimit-Limit","value":"1000","enabled":true},{"key":"X-MinuteRateLimit-Remaining","value":"997","enabled":true},{"key":"X-DailyRateLimit-Identifier","value":"ratelimit:89.91.9.3:2022-09-12","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"X-DailyRateLimit-Limit","value":"500000","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-MinuteRateLimit-Identifier","value":"ratelimit:89.91.9.3:2022-09-12-16-13","enabled":true},{"key":"X-DailyRateLimit-Remaining","value":"499947","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Runtime","value":"0.055481","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Powered-By","value":"Phusion Passenger 5.2.3","enabled":true},{"key":"Server","value":"nginx/1.12.2 + Phusion Passenger 5.2.3","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"NOT_FOUND\",\n \"message\": \"Couldn't find Delivery with 'id'=(0)\"\n}"},{"id":"31fa397c-bcbc-45bf-a53b-8ca701495937","name":"422 - Cannot update","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"job\": {\n \"deliveries\": [\n {\n \"id\": 100336065,\n \"client_reference\": \"124356789\",\n \"comment\": \"New comment\",\n \"package_description\": \"Small green package\",\n \"pickup\": {\n \"comment\": \"Updated pickup comment\",\n \"contact\": {\n \"company_name\": \"Updated Company Name\",\n \"firstname\": \"My firstname\",\n \"lastname\": \"My last name\",\n \"phone\": \"+33610101010\",\n \"email\": \"pickup@company.com\"\n }\n },\n \"dropoff\": {\n \"comment\": \"Updated dropoff comment\",\n \"contact\": {\n \"company_name\": \"Dropoff Company Name\",\n \"firstname\": \"Customer's firstname\",\n \"lastname\": \"Customer's lastname\",\n \"phone\": \"+33620202020\",\n \"email\": \"dropoff@company.com\"\n }\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/jobs/[job_id]"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Sep 2022 12:59:51 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Status","value":"422 Unprocessable Entity","enabled":true},{"key":"Vary","value":"Accept-Encoding, Origin","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Stuart-Stack","value":"V3","enabled":true},{"key":"X-Request-Id","value":"df2845d1-4f56-493a-972a-36f5b0b58c65","enabled":true},{"key":"X-MinuteRateLimit-Limit","value":"1000","enabled":true},{"key":"X-MinuteRateLimit-Remaining","value":"998","enabled":true},{"key":"X-DailyRateLimit-Identifier","value":"ratelimit:89.91.9.3:2022-09-12","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"X-DailyRateLimit-Limit","value":"500000","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-MinuteRateLimit-Identifier","value":"ratelimit:89.91.9.3:2022-09-12-14-59","enabled":true},{"key":"X-DailyRateLimit-Remaining","value":"499955","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Runtime","value":"0.073302","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Powered-By","value":"Phusion Passenger 5.2.3","enabled":true},{"key":"Server","value":"nginx/1.12.2 + Phusion Passenger 5.2.3","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"JOB_UPDATE_ERROR\",\n \"message\": \"Job can't be updated\"\n}"}],"variable":[{"key":"jobId","value":"100202989","description":"(Required) Job's id returned in the job creation response"}],"_postman_id":"07b3f6b6-8598-4464-a6f2-6cfb718dc038"},{"name":"Get a job","event":[{"listen":"test","script":{"id":"a1570e73-a0fc-4a17-8a97-6e46f382162d","type":"text/javascript","exec":["tests[\"Response HTTP status should be 200\"] = responseCode.code === 200;"]}}],"id":"abf5c056-9683-4711-9c37-0f5557f3d0b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v2/jobs/:jobId","description":"This endpoint allows you to get the details of a job using the id found in the response of your job creation request.
The following url's provide access to s3 resources for a limited period of time as highlighted below. To access these contents at any time we recommend storing the image in your systems.
\nsignature_url and proof_of_delivery_url proof of delivery images have a 48 hours TTL.
invoive_url invoicing images have a 1 hour TTL.
⚠️ Please note that URL links can be up to 2000 characters in length.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"(Required) Job id
\n","type":"text/plain"},"type":"any","value":"77073746","key":"jobId"}]}},"response":[{"id":"440176cc-63c5-4037-ac6f-45f337a4bc5f","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/jobs/[job_id]"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 100202989,\n \"created_at\": \"2021-12-22T15:14:59.000+01:00\",\n \"status\": \"finished\",\n \"package_type\": \"medium\",\n \"transport_type\": \"walk\",\n \"assignment_code\": null,\n \"pickup_at\": null,\n \"dropoff_at\": null,\n \"ended_at\": \"2021-12-22T15:30:57.000+01:00\",\n \"comment\": null,\n \"distance\": 0.919,\n \"duration\": 4,\n \"traveled_time\": 0,\n \"traveled_distance\": 0,\n \"deliveries\": [\n {\n \"id\": 100247860,\n \"status\": \"delivered\",\n \"picked_at\": \"2021-12-22T15:15:10.000+01:00\",\n \"delivered_at\": \"2021-12-22T15:30:56.000+01:00\",\n \"tracking_url\": \"https://stuart.sandbox.followmy.delivery/100247860/d629f0b981204c930fe2fdeaed69c1c9\",\n \"client_reference\": \"1640182499\",\n \"package_description\": \"Big red package\",\n \"package_type\": \"medium\",\n \"fleet_ids\": [\n 1\n ],\n \"pickup\": {\n \"id\": 2062855,\n \"address\": {\n \"street\": \"32 Coombe Lane\",\n \"postcode\": \"SW20 0LA\",\n \"city\": \"London\",\n \"zone\": \"london\",\n \"country\": \"The United Kingdom\",\n \"formatted_address\": \"32 Coombe Lane, SW20 0LA, London, The United Kingdom\"\n },\n \"latitude\": 51.4096757,\n \"longitude\": -0.2301377,\n \"comment\": \"test comment\",\n \"contact\": {\n \"firstname\": \"Bobby\",\n \"lastname\": \"Brown\",\n \"phone\": \"+33610101010\",\n \"company_name\": \"Pizza Shop\",\n \"email\": \"bobby.brown@pizzashop.com\"\n },\n \"access_codes\": [\n {\n \"code\": \"your_access_code_1\",\n \"type\": \"text\",\n \"title\": \"access code title\",\n \"instructions\": \"please put your instructions here\"\n }\n ]\n },\n \"dropoff\": {\n \"id\": 2062856,\n \"address\": {\n \"street\": \"23 Ethelbert Road\",\n \"postcode\": \"SW20 8QD\",\n \"city\": \"London\",\n \"zone\": \"london\",\n \"country\": \"The United Kingdom\",\n \"formatted_address\": \"23 Ethelbert Road, SW20 8QD, London, The United Kingdom\"\n },\n \"latitude\": 51.4133427,\n \"longitude\": -0.2208565,\n \"comment\": \"3nd floor on the right\",\n \"contact\": {\n \"firstname\": \"Julia\",\n \"lastname\": \"Moore\",\n \"phone\": \"+33712222222\",\n \"company_name\": \"Sample Company Inc.\",\n \"email\": \"client3@email.com\"\n },\n \"access_codes\": [\n {\n \"code\": \"your_access_code_2\",\n \"type\": \"text\",\n \"title\": \"access code title\",\n \"instructions\": \"please put your instructions here\"\n }\n ]\n },\n \"cancellation\": {\n \"canceled_by\": \"operations\",\n \"reason_key\": \"customer_cancellation_requested\",\n \"comment\": null\n },\n \"eta\": {\n \"pickup\": \"2021-12-22T15:15:04.000+01:00\",\n \"dropoff\": null\n },\n \"proof\": {\n \"signature_url\": \"https://stuart-bucket-sandbox.s3.eu-central-1.amazonaws.com/uploads/signatures/d-100810923-067b7f788c.jpg\"\n },\n \"package_image_url\": null,\n \"proof_of_delivery_url\": \"https://stuart-bucket-sandbox.s3.eu-central-1.amazonaws.com/uploads/task_report_pictures/trp-453c13ddc1d86f8e07c4.jpeg\",\n \"client_tracking_url\": \"https://stuart.sandbox.followmy.delivery/28aec4040c2e2cb15a9166d34467c01f/100739880/cf02f815dd177ba4c125965c8a9fb242\"\n }\n ],\n \"driver\": {\n \"id\": 410206,\n \"display_name\": \"Jermey W.\",\n \"phone\": \"+33727173259\",\n \"picture_url\": null,\n \"transport_type\": \"walk\",\n \"latitude\": 51.40956116,\n \"longitude\": -0.23012\n },\n \"pricing\": {\n \"price_tax_included\": 12.96,\n \"price_tax_excluded\": 10.8,\n \"tax_amount\": 2.16,\n \"invoice_url\": \"https://stuart-bucket-sandbox.s3.eu-central-1.amazonaws.com/uploads/grouped_invoices/4c4c7c9b-0ded-46dd-b4df-ffc94bea7f4a/67246/invoice.pdf\",\n \"tax_percentage\": 0.2,\n \"currency\": \"GBP\"\n },\n \"rating\": null\n}"},{"id":"ebc3f8c2-2399-4918-8688-73acf788abc7","name":"200 - Job returned","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/jobs/[job_id]"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 100645682,\n \"created_at\": \"2024-07-24T10:15:42.000+02:00\",\n \"status\": \"canceled\",\n \"package_type\": \"medium\",\n \"transport_type\": \"motorbike\",\n \"assignment_code\": null,\n \"pickup_at\": null,\n \"dropoff_at\": null,\n \"ended_at\": \"2024-09-27T10:46:43.000+02:00\",\n \"comment\": null,\n \"distance\": 0.919,\n \"duration\": 4,\n \"traveled_time\": 0,\n \"traveled_distance\": 0,\n \"deliveries\": [\n {\n \"id\": 100790428,\n \"status\": \"cancelled\",\n \"picked_at\": \"2024-07-24T10:17:14.000+02:00\",\n \"delivered_at\": null,\n \"tracking_url\": \"https://stuart.sandbox.followmy.delivery/100790428/c134f90d3d31fbca4bcb9fb78381aeb9\",\n \"client_reference\": \"1721808941\",\n \"package_description\": \"yellow package\",\n \"package_type\": \"medium\",\n \"fleet_ids\": [\n 1\n ],\n \"pickup\": {\n \"id\": 3148232,\n \"address\": {\n \"street\": \"32 Coombe Lane\",\n \"postcode\": \"SW20 0LA\",\n \"city\": \"London\",\n \"zone\": \"london\",\n \"country\": \"The United Kingdom\",\n \"formatted_address\": \"32 Coombe Lane, SW20 0LA, London, The United Kingdom\"\n },\n \"latitude\": 51.4096757,\n \"longitude\": -0.2301377,\n \"comment\": \"Ask Bobby\",\n \"contact\": {\n \"firstname\": \"Bobby\",\n \"lastname\": \"Brown\",\n \"phone\": \"+33610101010\",\n \"company_name\": \"Pizza Shop\",\n \"email\": \"bobby.brown@pizzashop.com\"\n },\n \"access_codes\": []\n },\n \"dropoff\": {\n \"id\": 3148233,\n \"address\": {\n \"street\": \"23 Ethelbert Road\",\n \"postcode\": \"SW20 8QD\",\n \"city\": \"London\",\n \"zone\": \"london\",\n \"country\": \"The United Kingdom\",\n \"formatted_address\": \"23 Ethelbert Road, SW20 8QD, London, The United Kingdom\"\n },\n \"latitude\": 51.4133427,\n \"longitude\": -0.2208565,\n \"comment\": \"3nd floor on the right\",\n \"contact\": {\n \"firstname\": \"Julia\",\n \"lastname\": \"Moore\",\n \"phone\": \"+33712222222\",\n \"company_name\": \"Sample Company Inc.\",\n \"email\": \"client3@email.com\"\n },\n \"access_codes\": []\n },\n \"cancellation\": {\n \"canceled_by\": \"client\",\n \"reason_key\": \"incorrect_package\",\n \"comment\": null\n },\n \"eta\": {\n \"pickup\": \"2024-07-24T10:17:50.000+02:00\",\n \"dropoff\": null\n },\n \"proof\": {\n \"signature_url\": null\n },\n \"package_image_url\": null,\n \"proof_of_delivery_url\": null,\n \"client_tracking_url\": \"https://stuart.sandbox.followmy.delivery/7eb8a9e3ce14b84acd0ad182ed7d5f7a/100790428/c134f90d3d31fbca4bcb9fb78381aeb9\",\n \"return_reason\": \"Incorrect package\"\n }\n ],\n \"driver\": null,\n \"pricing\": {\n \"price_tax_included\": 6.48,\n \"price_tax_excluded\": 5.4,\n \"tax_amount\": 1.08,\n \"invoice_url\": null,\n \"tax_percentage\": 0.2,\n \"currency\": \"GBP\"\n },\n \"rating\": null\n}"},{"id":"45d2e911-2293-4274-bd21-ca9656d62d56","name":"404 - Job not found","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/jobs/1232435"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Dec 2021 15:11:51 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Status","value":"404 Not Found","enabled":true},{"key":"Vary","value":"Accept-Encoding, Origin","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"Stuart-Stack","value":"V3","enabled":true},{"key":"X-Request-Id","value":"e8da748e-fab4-4501-ad5d-040dab39c054","enabled":true},{"key":"X-MinuteRateLimit-Limit","value":"1000","enabled":true},{"key":"X-MinuteRateLimit-Remaining","value":"998","enabled":true},{"key":"X-DailyRateLimit-Identifier","value":"ratelimit:82.124.113.255:2021-12-22","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"X-DailyRateLimit-Limit","value":"500000","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-MinuteRateLimit-Identifier","value":"ratelimit:82.124.113.255:2021-12-22-16-11","enabled":true},{"key":"X-DailyRateLimit-Remaining","value":"499948","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Runtime","value":"0.031723","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Powered-By","value":"Phusion Passenger Enterprise 5.2.3","enabled":true},{"key":"Server","value":"nginx/1.12.2 + Phusion Passenger 5.2.3","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"NOT_FOUND\",\n \"message\": \"Not found\"\n}"}],"variable":[{"key":"jobId","value":"77073746","description":"(Required) Job id"}],"_postman_id":"abf5c056-9683-4711-9c37-0f5557f3d0b2"},{"name":"Get jobs","event":[{"listen":"test","script":{"id":"37685753-5337-4529-b36f-c873f891d848","exec":["tests[\"Response HTTP status should be 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"fa326cf4-43a0-43c0-98bd-f616e5902b85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v2/jobs?status=in_progress&page=1&per_page=1&client_reference=[your_client_ref]&active=true","description":"This endpoint allows you to retrieve all the jobs created in your Stuart account from the last 90 days.
The results will come back paginated in descending order of the 'pickup_at' job scheduling value.
The following url's provide access to s3 resources for a limited period of time as highlighted below. To access these contents at any time we recommend storing the image in your systems.
\nsignature_url and proof_of_delivery_url proof of delivery images have a 48 hours TTL.
invoive_url invoicing images have a 1 hour TTL.
⚠️ Please note that URL links can be up to 2000 characters in length.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"Filter result using a comma separated list of statuses.\nAllowed Values: new, scheduled, searching, in_progress, finished, canceled, expired
\n","type":"text/plain"},"key":"status","value":"in_progress"},{"description":{"content":"The page number you want to retrieve
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Max number of result you want per page.
\n","type":"text/plain"},"key":"per_page","value":"1"},{"description":{"content":"The client_reference you used during the Job creation.
\n","type":"text/plain"},"key":"client_reference","value":"[your_client_ref]"},{"description":{"content":"Boolean: Overrides the status to give only currently active orders.
\n","type":"text/plain"},"key":"active","value":"true"}],"variable":[]}},"response":[{"id":"e2c9910a-548c-4aec-8614-105f6799491e","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/v2/jobs?status=finished&page=1&per_page=1&client_reference=1640181124&active=false&order=start_inviting_at:desc","host":["{{api_url}}"],"path":["v2","jobs"],"query":[{"key":"status","value":"finished","description":"Filter result using a comma separated list of statuses.\nAllowed Values: new, scheduled, searching, in_progress, finished, canceled, expired"},{"key":"page","value":"1","description":"The page number you want to retrieve"},{"key":"per_page","value":"1","description":"Max number of result you want per page."},{"key":"client_reference","value":"1640181124","description":"The client_reference you used during the Job creation."},{"key":"active","value":"false","description":"Boolean: Overrides the status to give only currently active orders."},{"key":"order","value":"start_inviting_at:desc","description":"Allowed Values: start_inviting_at:desc, pickup_at:desc, pickup_at:asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 100202968,\n \"created_at\": \"2021-12-22T14:52:04.000+01:00\",\n \"status\": \"finished\",\n \"package_type\": \"medium\",\n \"transport_type\": \"walk\",\n \"assignment_code\": null,\n \"pickup_at\": null,\n \"dropoff_at\": null,\n \"ended_at\": \"2021-12-22T15:08:03.000+01:00\",\n \"comment\": null,\n \"distance\": 0.919,\n \"duration\": 4,\n \"traveled_time\": 0,\n \"traveled_distance\": 0,\n \"deliveries\": [\n {\n \"id\": 100247837,\n \"status\": \"delivered\",\n \"picked_at\": \"2021-12-22T14:52:54.000+01:00\",\n \"delivered_at\": \"2021-12-22T15:08:01.000+01:00\",\n \"tracking_url\": \"https://stuart.sandbox.followmy.delivery/100247837/ae5ff497d3c66d79627371f695a3a107\",\n \"client_reference\": \"1640181124\",\n \"package_description\": \"yellow package\",\n \"package_type\": \"medium\",\n \"fleet_ids\": [\n 1\n ],\n \"pickup\": {\n \"id\": 2062809,\n \"address\": {\n \"street\": \"32 Coombe Lane\",\n \"postcode\": \"SW20 0LA\",\n \"city\": \"London\",\n \"zone\": \"london\",\n \"country\": \"The United Kingdom\",\n \"formatted_address\": \"32 Coombe Lane, SW20 0LA, London, The United Kingdom\"\n },\n \"latitude\": 51.4096757,\n \"longitude\": -0.2301377,\n \"comment\": \"Ask Bobby\",\n \"contact\": {\n \"firstname\": \"Bobby\",\n \"lastname\": \"Brown\",\n \"phone\": \"+33610101010\",\n \"company_name\": \"Pizza Shop\",\n \"email\": \"bobby.brown@pizzashop.com\"\n },\n \"access_codes\": [\n {\n \"code\": \"your_access_code_1\",\n \"type\": \"text\",\n \"title\": \"access code title\",\n \"instructions\": \"please put your instructions here\"\n }\n ]\n },\n \"dropoff\": {\n \"id\": 2062810,\n \"address\": {\n \"street\": \"23 Ethelbert Road\",\n \"postcode\": \"SW20 8QD\",\n \"city\": \"London\",\n \"zone\": \"london\",\n \"country\": \"The United Kingdom\",\n \"formatted_address\": \"23 Ethelbert Road, SW20 8QD, London, The United Kingdom\"\n },\n \"latitude\": 51.4133427,\n \"longitude\": -0.2208565,\n \"comment\": \"3nd floor on the right\",\n \"contact\": {\n \"firstname\": \"Julia\",\n \"lastname\": \"Moore\",\n \"phone\": \"+33712222222\",\n \"company_name\": \"Sample Company Inc.\",\n \"email\": \"client3@email.com\"\n },\n \"access_codes\": [\n {\n \"code\": \"your_access_code_2\",\n \"type\": \"text\",\n \"title\": \"access code title\",\n \"instructions\": \"please put your instructions here\"\n }\n ]\n },\n \"cancellation\": {\n \"canceled_by\": \"operations\",\n \"reason_key\": \"customer_cancellation_requested\",\n \"comment\": null\n },\n \"eta\": {\n \"pickup\": \"2021-12-22T14:53:08.000+01:00\",\n \"dropoff\": null\n },\n \"proof\": {\n \"signature_url\": \"https://stuart-bucket-sandbox.s3.eu-central-1.amazonaws.com/uploads/signatures/d-100810923-067b7f788c.jpg\"\n },\n \"package_image_url\": null,\n \"proof_of_delivery_url\": \"https://stuart-bucket-sandbox.s3.eu-central-1.amazonaws.com/uploads/task_report_pictures/trp-453c13ddc1d86f8e07c4.jpeg\"\n }\n ],\n \"driver\": {\n \"id\": 410206,\n \"display_name\": \"Jermey W.\",\n \"phone\": \"+33727173259\",\n \"picture_url\": null,\n \"transport_type\": \"walk\",\n \"latitude\": 51.40956116,\n \"longitude\": -0.23012\n },\n \"pricing\": {\n \"price_tax_included\": 12.96,\n \"price_tax_excluded\": 10.8,\n \"tax_amount\": 2.16,\n \"invoice_url\": \"https://stuart-bucket-sandbox.s3.eu-central-1.amazonaws.com/uploads/grouped_invoices/558d796d-8919-41aa-8225-60bfac64b1bb/67233/invoice.pdf\",\n \"tax_percentage\": 0.2,\n \"currency\": \"GBP\"\n },\n \"rating\": null\n }\n]"},{"id":"d6a95d99-34cc-4caa-ad4d-5016a1187d03","name":"200 - OK empty","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/v2/jobs?status=active&page=1&per_page=1&client_reference=1640181124&active=false&order=start_inviting_at:desc","host":["{{api_url}}"],"path":["v2","jobs"],"query":[{"description":"Filter result using a comma separated list of statuses.\nAllowed Values: new, scheduled, searching, in_progress, finished, canceled, expired","key":"status","value":"active"},{"description":"The page number you want to retrieve","key":"page","value":"1"},{"description":"Max number of result you want per page.","key":"per_page","value":"1"},{"description":"The client_reference you used during the Job creation.","key":"client_reference","value":"1640181124"},{"description":"Boolean: Overrides the status to give only currently active orders.","key":"active","value":"false"},{"description":"Allowed Values: start_inviting_at:desc, pickup_at:desc, pickup_at:asc","key":"order","value":"start_inviting_at:desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"fa326cf4-43a0-43c0-98bd-f616e5902b85"},{"name":"Get courier's anonymous phone number.","event":[{"listen":"test","script":{"id":"11158ea3-dc19-4ef7-a955-264b721ff410","type":"text/javascript","exec":["tests[\"Response HTTP status should be 200\"] = responseCode.code === 200;"]}}],"id":"6ed291b2-2cb5-4f53-9cdf-cfaa7820928d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/v2/deliveries/[delivery_id]/phone_number","description":"Once your delivery is assigned to a courier, you can request their anonymous phone number. Once the delivery is complete, the phone number will expire.
Read more about our two-way anonymised calling.
(Required) Delivery id received in job creation response
\n","type":"text/plain"},"type":"any","value":"100317494","key":"delivery_id"}]}},"response":[{"id":"d6bb2c55-43c4-40a2-8154-663a4bf0bb56","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/deliveries/[delivery_id]/phone_number"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"phone_number\": \"+33728934950\"\n}"},{"id":"07f21619-1865-4421-8334-1ffcf03136fc","name":"422 - no current delivery","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/deliveries/[delivery_id]/phone_number"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"NO_CURRENT_DELIVERY\",\n \"message\": \"You need a delivery to create a phone call session.\"\n}"},{"id":"20444027-5a7d-40a2-a3b1-46df6d4c6991","name":"422 - phone call not available","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/deliveries/[delivery_id]/phone_number"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"PHONE_CALL_NOT_AVAILABLE\",\n \"message\": \"Cannot create a phone call for the given delivery.\"\n}"}],"variable":[{"key":"delivery_id","value":"100317494","description":"(Required) Delivery id received in job creation response"}],"_postman_id":"6ed291b2-2cb5-4f53-9cdf-cfaa7820928d"}],"id":"b338dee2-f8ac-4da6-94f6-ad9010df7dd1","description":"The job is the primary object you’ll encounter in our API and webhook payloads. A job consists of one pickup task and at least one dropoff task.
\nA delivery is a sub-component of a job and represents the assignment to pick up and drop off a package. A job contains at least one delivery, but it can include multiple deliveries if it involves several packages (multiple dropoffs).
\nA package refers to an item or group of items that you want it to be collected from a specified pickup point and deliver to a designated dropoff location. While a package is a more detailed object compared to a delivery, they are functionally equivalent when comparing webhook updates between versions 2 and 3.
\n- \n
- This means that
deliveries.idfrom job creation response (and webhooks v2) is equal topackage.idin webhooks v3, hence we encourage you to store its value along withjob.id. \n
Below, you’ll find the different statuses a job, delivery, or package may go through. These statuses can be tracked via the Stuart dashboard, real-time webhook updates, or the \"Get a Job\" endpoint.
\nJob Statuses
\nDelivery Statuses
\nPackage Statuses
\nYou can find detailled flow in the webhooks section of this documentation.
\n","_postman_id":"b338dee2-f8ac-4da6-94f6-ad9010df7dd1","auth":{"type":"oauth2","oauth2":{"client_authentication":"This endpoint enables you to inform us when an order is ready for pickup.
\nYou can either explicitly include the time in your request or, by default, the system will use the server’s time.
\nPlease ensure to send us the signal through this endpoint only when the order is fully prepared and ready for pickup.
\nDelivery ready Payload Fields
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"This endpoint allows you to notify us when an order (or multiple orders) under a single job ID is ready for pickup.
\nYou can either explicitly include the time in your request or, by default, the system will use the server’s time.
\nPlease ensure to send us the signal through this endpoint only when the order is fully prepared and ready for pickup.
\nJob ready Payload Fields
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"When an order is ready, you can notify us to help us streamline the pick-up process and minimise any potential friction during the pick-up. This notification can be sent at either the delivery or job level, depending on how your system identifies and manages orders.
\nYou can send the signal:
\n- \n
At the delivery level – when a specific delivery (package) is ready.
\n \nAt the job level – when all deliveries in the job are ready for pickup.
\n \n
We recommend sending the signal at the delivery level for more granular tracking, unless your system handles all packages together and they’re always ready at the same time.
\n","_postman_id":"7f9ac0b9-d908-4bd0-a87f-c0f07c9170d8","auth":{"type":"oauth2","oauth2":{"client_authentication":"Cancel a job including all of its deliveries. We advise providing your reason for cancelling to provide visibility for reporting, the allowed values are detailed in the table below.
\nJob Cancellation Payload Fields
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"(Required) Job id
\n","type":"text/plain"},"type":"any","value":"44999047","key":"jobId"}]}},"response":[{"id":"25c94433-d171-4a19-a93f-6a8810d7b1d3","name":"204 - no content (OK)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"The customer doesn't want the package anymore\",\n \"public_reason_key\": \"customer_cancellation_requested\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/jobs/[job_id]/cancel"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8d3f5238-931a-440e-90cc-a4acfa20e923","name":"422 - already picked up","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"The customer doesn't want the package anymore\",\n \"public_reason_key\": \"customer_cancellation_requested\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/jobs/[job_id]/cancel"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"CANCELLATION_ERROR\",\n \"message\": \"Job already picked up\"\n}"},{"id":"a460890d-cf6e-419c-b6c9-6ae754719a26","name":"404 - not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"comment\": \"The customer doesn't want the package anymore\",\n \"public_reason_key\": \"customer_cancellation_requested\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/v2/jobs/[job_id]/cancel","host":["{{api_url}}"],"path":["v2","jobs","[job_id]","cancel"],"variable":[{"key":"jobId","value":"44999047","description":"(Required) Job id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"NOT_FOUND\",\n \"message\": \"Not found\"\n}"}],"variable":[{"key":"jobId","value":"44999047","description":"(Required) Job id"}],"_postman_id":"c250d9ca-2fb9-4d71-8d96-d9b8792f34c6"},{"name":"Delivery cancellation","id":"bc4d68ce-6ce5-49db-a4f9-e1a91764df8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"public_reason_key\": \"customer_cancellation_requested\",\n \"comment\": \"The customer doesn't want the product anymore\"\n}"},"url":"{{api_url}}/v2/deliveries/[delivery_id]/cancel","description":"Cancel a single delivery of your job. We advise providing your reason for cancelling to provide visibility for reporting, the allowed values are detailed in the table below.
\nDelivery Cancellation Payload Fields
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"(Required) Delivery id
\n","type":"text/plain"},"type":"any","value":"44999047","key":"deliveryId"}]}},"response":[{"id":"d8e83fd3-05a1-4c6c-a3db-8486e22f37af","name":"204 - no content (OK)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"public_reason_key\": \"pu_closed\",\n \"comment\": \"The shop is currently closed\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/deliveries/[delivery_id]/cancel"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"ad65c9fc-077d-45b9-ad86-2b0ab5494c79","name":"422 - already picked up","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"public_reason_key\": \"customer_cancellation_requested\",\n \"comment\": \"The customer doesn't want the product anymore\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/deliveries/[delivery_id]/cancel"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"CANCELLATION_ERROR\",\n \"message\": \"Delivery already picked up\"\n}"},{"id":"a9ed886d-ca60-42f6-b305-0cc00121ae6c","name":"404 - not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"public_reason_key\": \"customer_cancellation_requested\",\n \"comment\": \"The customer doesn't want the product anymore\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/v2/deliveries/[delivery_id]/cancel","host":["{{api_url}}"],"path":["v2","deliveries","[delivery_id]","cancel"],"variable":[{"key":"deliveryId","value":"44999047","description":"(Required) Delivery id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"NOT_FOUND\",\n \"message\": \"Not found\"\n}"}],"variable":[{"key":"deliveryId","value":"44999047","description":"(Required) Delivery id"}],"_postman_id":"bc4d68ce-6ce5-49db-a4f9-e1a91764df8d"}],"id":"119a8667-d4e4-499f-937d-c0c122c00199","description":"At any time before your package is picked up, signified by the 'delivering' status, you can cancel the job or delivery by API. Any cancellation requests made after this point will result in an error. To cancel a job after this stage in the delivery lifecycle, contact Stuart Support to cancel it for you.
\nWhen cancelling your order, we recommend providing the reason for reporting and analytics purposes.
\nNote, cancellation fees apply when the job has been accepted by a courier for more than 2 minutes.
\n","_postman_id":"119a8667-d4e4-499f-937d-c0c122c00199","auth":{"type":"oauth2","oauth2":{"client_authentication":"What is the cancellation object?
\nThe cancellation object was created to signify the cancellation of a Stuart job, with details of who cancelled it and the reason. This cancellation object information can be found at any time using our get a job endpoints and our webhooks.
\nWhen tracking orders to see what's happening to them in real-time, we recommend using our delivery update webhooks. Here's an example of the cancellation object of a webhook event:
\n\"cancellation\":\n{\n \"canceledBy\":\"operations\",\n \"reasonKey\":\"end-customer_unreachable\",\n \"comment\":\"\"\n}\n\n*canceledBy is one of [client, operations, system] where:
- \n
Client: Refers to the integrator (in this case, your system) that initiates a cancellation request via the API.
\n \nOperations: Refers to our operations team, which performs a manual cancellation, even if the request originated from the courier or client.
\n \nSystem: Refers to our system, where cancellations occur automatically based on the expiration interval configured for the account.
\n \n
What can cancellation updates tell me?
\nAs the Stuart architecture has evolved, this cancellation object has adapted to signal some other use cases than just the simple cancel. These are: courier reassignment, return and manual stacking.
You may need to identify these use cases to integrate our updates into your own internal tracking system, or to trigger some actions based on the identified use case.
If you have any questions or concerns around these topics for your integration, feel free to ask or seek answers to your questions on our Community Forum. For example, here's a Q&A post answering how to identify a failed delivery for refunding the customer.
\nWhat cancellation reasons are there?
\nLet's look at the cancellation reason key's that could come with each of these scenarios and whether they'll lead to a charge. For more detail on each, check out this post.
\n⚠️Update:
There is a new reason key wrong_weight which doesn't sit in any of the categories below, for more information see this announcement.
Cancellation
\nWhen your order is truly cancelled no further action will be taken. When this happens your delivery will have a cancelled status alongside one of the following statuses:
Courier reassigned
\nWhen tracking via webhooks and your order cancellation.reasonKey changes to one from the below list and the status of the delivery is pending, this signifies a courier reassignment.
This means that the current courier will not continue to fulfil this order and our dispatcher will assign a new courier. Find out more about recognising a courier unassign event through webhooks.
\nReturn
\nIf your package is being returned to the pickup location you'll receive acancelled delivery status and associated reason key after which you'll receive the usual delivery statuses from picking through to delivered - allowing you to track this return leg.
Here are the reasons that a package may be returned:
\nManually Stacked
\nWhen your delivery status is cancelled and the reason key is manually_stacked, your order has been stacked with another by our Support team. Read more about manual stacking on our forum.
In the diagrams below you will find representations of the different possible flow of events you may receive assuming all possible events are subscribed to.
\n![\"v3%20webhooks%20reference%20keys\"](\"https://lh7-qw.googleusercontent.com/docsz/AD_4nXeSPotXDT2csleHGGnpEpF29zGolIXGIXRISh6UiBE1sAVq9iJ0ItiI6e96n6UdpLQvvE5HCYL760Rw3PYRqggkhML9FOYn-P92DWHNRZwwhZ9N4b3PGDdRLlF7B78z8eGfaSlA?key=fq77slujjbwzJEcqlnHGQnGa\")
\n\nHappy Path
\nCourier Reassignment
\nThe courier handling your package could be changed at any time after initial assignment, though most likely period for courier reassignment is before the package is collected.
\nReturn
\nIn the case that your package cannot be delivered, it may be returned to the location where it was origionally collected.
\nCancelation
\nYour package may be canceled at any time following it's creation. This is a final status meaning that no further action will be taken on your package.
\nBelow you will find the list of all possible fields that can be sent in the different webhook events.
\nSome fields will be returned for each webhook topic, while others are specific to certain topics.
\n","_postman_id":"c459c180-1b02-4814-866d-c5f91c00ddc7","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}}},{"name":"Webhook events","item":[{"name":"Package created webhook","id":"a16c968b-7c24-4b51-9176-de3600cf00d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\": \"v3\",\n \"occurred_at\": \"2023-02-13T15:29:36.000+01:00\",\n \"event_id\": \"93ce4c52-5b27-4cec-9baf-68cfcdd4da46\",\n \"webhook_id\": 2359,\n \"topic\": \"package_created\",\n \"details\": {\n \"account\": {\n \"id\": 451871\n },\n \"package\": {\n \"id\": \"10000000001\",\n \"reference\": \"1676298576\",\n \"client_tracking_url\": \"https://stuart.sandbox.followmy.delivery/2edc9e7032023929f3a5c61170a5a68e/100803824/331e0a2e57e570ffc87a8ddef166707f\",\n \"end_customer_tracking_url\": \"https://stuart.sandbox.followmy.delivery/100803824/331e0a2e57e570ffc87a8ddef166707f\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your.domain.com/your-package-created-webhooks-endpoint","description":"This webhook is sent when a package is created.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["your-package-created-webhooks-endpoint"],"host":["your","domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a16c968b-7c24-4b51-9176-de3600cf00d5"},{"name":"Courier assigned webhook","id":"2ec9fdb1-907e-4856-b144-971c279d91e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\": \"v3\",\n \"occurred_at\": \"2023-04-28T15:41:29.000+02:00\",\n \"event_id\": \"49b42175-8c53-4003-aac0-8558876b422b\",\n \"webhook_id\": 2510,\n \"topic\": \"courier_assigned\",\n \"details\": {\n \"account\": {\n \"id\": 451871\n },\n \"courier\": {\n \"name\": \"Adriel Pfeffer\"\n },\n \"package\": {\n \"id\": \"10000000001\",\n \"reference\": \"1682689274\",\n \"client_tracking_url\": \"https://stuart.sandbox.followmy.delivery/2edc9e7032023929f3a5c61170a5a68e/100803824/331e0a2e57e570ffc87a8ddef166707f\",\n \"end_customer_tracking_url\": \"https://stuart.sandbox.followmy.delivery/100803824/331e0a2e57e570ffc87a8ddef166707f\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your.domain.com/your-courier-assigned-webhooks-endpoint","description":"This webhook is sent when a courier is assigned to a package. If multiple packages are stacked together, the payload will include the details.packages field containing the package identifiers.
This webhook is sent when a courier is on the way to a specific place in the delivery process. This can be either the place of pickup or dropoff of the package. In the payload, the subfield details.task specifies the type of location (either “pickup” or “dropoff”).
This webhook is sent when a package is split into two or more packages with the purpose of being delivered by multiple couriers.
\nIn the event of a split, you will receive this webhook for each newly created package. For example, if a package is split to be delivered by three different couriers, you will receive this webhook twice, with the new_package field indicating the ID of each newly created package.
This webhook is sent when a courier is waiting at a specific place in the delivery process. This can be either the place of pickup or dropoff of the package. In the payload the subfield details.task specifies the type of location (one of “pickup” or “dropoff”).
This webhook is sent right after a courier retrieved a package (at pickup).
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["your-package-delivering-webhook-endpoint"],"host":["your","domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"366ec670-dec4-4b50-9c52-f2ed85c5485d"},{"name":"Package delivered webhook","id":"33e9de5d-f5ff-487d-b9f0-30066427ad93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\": \"v3\",\n \"occurred_at\": \"2023-05-02T16:08:57.000+02:00\",\n \"event_id\": \"ab1f8bcc-7eb8-48e7-9ba6-5f0c720dd231\",\n \"webhook_id\": 2515,\n \"topic\": \"package_delivered\",\n \"details\": {\n \"account\": {\n \"id\": 451871\n },\n \"package\": {\n \"id\": \"10000000001\",\n \"reference\": \"1683036378\",\n \"client_tracking_url\": \"https://stuart.sandbox.followmy.delivery/2edc9e7032023929f3a5c61170a5a68e/100803824/331e0a2e57e570ffc87a8ddef166707f\",\n \"end_customer_tracking_url\": \"https://stuart.sandbox.followmy.delivery/100803824/331e0a2e57e570ffc87a8ddef166707f\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your.domain.com/your-package-delivered-webhook-endpoint","description":"This webhook is sent when a package delivery is completed.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["your-package-delivered-webhook-endpoint"],"host":["your","domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"33e9de5d-f5ff-487d-b9f0-30066427ad93"},{"name":"Package canceled webhook","id":"62fd2825-051f-485b-a7d7-0b53420b82b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\": \"v3\",\n \"occurred_at\": \"2023-02-13T15:58:42.000+01:00\",\n \"event_id\": \"e8dc1cb4-2e75-4b11-9255-770cebcecd82\",\n \"webhook_id\": 2359,\n \"topic\": \"package_canceled\",\n \"details\": {\n \"account\": {\n \"id\": 451871\n },\n \"package\": {\n \"id\": \"10000000001\",\n \"reference\": \"1676300282\"\n },\n \"cancelation\": {\n \"actor\": \"client\",\n \"reason\": \"Address error\",\n \"key\": \"address_error\",\n \"comment\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your.domain.com/your-package-canceled-webhook-endpoint","description":"This webhook is sent when a package is canceled.
\nactor is one of [client, operations, system]
cancelation.key is one of:
[ end-customer_unreachable, duplicate_package, customer_cancellation_requested, pu_closed, address_error, no_supply, wrong_package_size, incorrect_package, technical_issue, courier_issue, package_not_ready, package_damaged, other, job_expired, cold_chain, end-customer_refused_package, or end-customer_underaged]
Find out more about our cancellation reasons.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["your-package-canceled-webhook-endpoint"],"host":["your","domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"62fd2825-051f-485b-a7d7-0b53420b82b1"},{"name":"Package returning webhook","id":"4be1df53-1bcc-45af-aab6-3ea93f3c3294","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"version\": \"v3\",\n \"occurred_at\": \"2023-02-13T16:00:36.000+01:00\",\n \"event_id\": \"515b417c-49d1-460b-867c-00c6bd1ce6fe\",\n \"webhook_id\": 2359,\n \"topic\": \"package_returning\",\n \"details\": {\n \"account\": {\n \"id\": 451871\n },\n \"return\": {\n \"key\": \"end-customer_unreachable\",\n \"reason\": \"End-customer unreachable\"\n },\n \"package\": {\n \"id\": \"10000000001\",\n \"reference\": \"1676300384\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your.domain.com/your-package-returning-webhook-endpoint","description":"This webhook is sent when a package has been requested to be returned to its origin.
\n⚠️ Please note that the 'returning' status may not be triggered in all cases, though we aim in the future to ensure accuracy in triggering this event for every occurance that a package is returning to the pickup location. If this inconsistency can cause a critical issue for you integration please reach out for guidance through the Developer Community Forum.
\nList of possible keys: end-customer_unreachable, address_error, package_damaged, end-customer_refused_package, cash_or_equipment_return, incorrect_package, cold_chain, end-customer_underaged or customer_cancellation_requested
This webhook is sent when a package return is completed.
\n⚠️ Please note that the 'returned' status may not be triggered in all cases, though we aim in the future to ensure accuracy in triggering this event for every occurance that a package has been returned to the pickup location. If this inconsistency can cause a critical issue for you integration please reach out for guidance through the Developer Community Forum.
\nList of possible keys: end-customer_unreachable, address_error, package_damaged, end-customer_refused_package, cash_or_equipment_return, incorrect_package, cold_chain, end-customer_underaged or customer_cancellation_requested
This webhook is sent when a package delivery has been reassigned to another courier.
\nList of possible keys: package_not_ready, customer_cancellation_requested, courier_issue, package_damaged, reassigned_to_better_courier, manually_stacked, no_supply or wrong_package_size or wrong_weight
This webhook is sent while the courier is en route from pickup to dropoff.
\nIt is sent every 30 seconds if the courier has moved since the last update.
\nThe payload includes the coordinates of the courier's position in real time.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["your-courier-reassigning-webhook-endpoint"],"host":["your","domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"10c6dcfa-2c5e-41bc-a129-94b477b3b3c7"}],"id":"af3dda10-59b5-45e2-98c8-0e52bb1a532f","description":"The following events can each be subscribed to in order to receive real-time updates.
\nTo understand the flow of events you can expect to receive for various scenarios, please see event flows documentation.
\n","_postman_id":"af3dda10-59b5-45e2-98c8-0e52bb1a532f","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}}}],"id":"131cf619-71cd-4f0c-a595-dbd6e9c54938","description":"This section details version three (v3) of Stuart on-demand webhooks. These webhooks are the latest version which improve upon our previous (v2) offering.
\nPlease pay attention to the usage guidelines below when implementing these webhooks to avoid experiencing breaking changes in the future.
\nUsage Guidelines
\n- \n
- v3 webhooks may be subject to change in the future. \n
- New webhook events can be created in the future. \n
- New attributes may be added to the webhook's payloads in the future. \n
- The length of specific fields may change in the future. \n
- Field validation checks should consider the field type noted in the payload fields table. \n
Note: In case of an unsuccessful webhook event reception, our system can attempt to retry sending the same webhook event up to 5 times.
\nTo keep up to date with changes coming be sure to subscribe to our announcement notifications here.
\n","_postman_id":"131cf619-71cd-4f0c-a595-dbd6e9c54938","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}}},{"name":"Version 2 [Deprecated]","item":[{"name":"Event flows","item":[],"id":"7c3c54ce-fa45-400a-8aec-5c80dca97990","description":"Webhook v2 enables subscription to both job status updates and delivery status updates. The diagrams below illustrate the various possible event flows that may be received, assuming all available events are subscribed to.
\n\n\nHappy Path
\n- \n
- Job update webhooks: \n
Assuming you subscribed to both job/create and job/update events, you’ll receive the following webhook events:
\n![\"v2%20job/update%20webhooks%20-%20happy%20path%20flow\"](\"https://lh7-qw.googleusercontent.com/docsz/AD_4nXeA4vcd7DhiLPMLP3t85-c9ktqgyV3SGfYyrfy6HTRs3foocrpjRaR_zi7l4FwXiMQX-2d18Et-btCjFtgpXANR4erV_G2Zw0Ulp3_DxGoPVjnbP3GyuReeggY-jYGURIgEISRmlw?key=fq77slujjbwzJEcqlnHGQnGa\")
\n\n- \n
- Delivery update webhooks: \n
Assuming you subscribed to both delivery/create and delivery/update events, you’ll receive the following webhook events:
\n![\"v2%20delivery/update%20webhooks%20-%20happy%20path%20flow\"](\"https://lh7-qw.googleusercontent.com/docsz/AD_4nXfwOFsY-OHUNMyhkzqZPcFixHK9R8lORI20j2ze5w3wWRNlmk9C5-c20Bjf5bnwf1INRv_qZuX07Z1D-4UkGpTHJhl4X_VdxdI4Jrl8g0u-9Dmj72YlPeZSWW0mJ2_XkEBn-fFG?key=fq77slujjbwzJEcqlnHGQnGa\")
\n\nFor the purpose of clarity and conciseness, the following sections will specifically address delivery update webhooks.
\nCourier Reassignment
\n![\"v2%20delivery/update%20webhooks%20-%20courier%20reassignment%20flow\"](\"https://lh7-qw.googleusercontent.com/docsz/AD_4nXcLMQRPjqp-VY3E_86YrWcZJSSNQfRbUd8OXBRnaunywSTesCqtCRlwF8EA7UY0XXLDXiOaYjRknczP52wWQLmT8iVDQVvuHK4irvJSdt-Pp1qu-Pf2Y0UinRrcI06vSEXAfa-T8A?key=fq77slujjbwzJEcqlnHGQnGa\")
\n\nReturn
\n![\"v2%20delivery/update%20webhooks%20-%20return%20flow\"](\"https://lh7-qw.googleusercontent.com/docsz/AD_4nXcqT8diFCNWyiy8IcC-rWh-u2qoaBx_2tbByvqSuvvY4gpw3Lo84ZgTOLzGSP2rwm1RSQ-WSM9FeyXu49pNxY0M5hIYDwOmZEymzUKRnW1Wq6vQfHvNO60-Mp4bHU-yTdfQThNX?key=fq77slujjbwzJEcqlnHGQnGa\")
\n\nCancelation
\n![\"v2%20delivery/update%20webhooks%20-%20cancelation%20flow\"](\"https://lh7-qw.googleusercontent.com/docsz/AD_4nXfnGNDZ3uQICuvOG_Aq7fWXnRyOjoIIB_FRV5n7E2RjHoSIddDFB4p9r9wfXDj6OvuD_FnpVONPZ1IdmiuY3PyTjFYrzan-n2QZAZOdulbg347ANyO-OQQWK2HYdJ5n2-4We2SbZw?key=fq77slujjbwzJEcqlnHGQnGa\")
\n\nExpired delivery:
\n![\"v2%20delivery/update%20webhooks%20-%20expiry%20flow\"](\"https://lh7-qw.googleusercontent.com/docsz/AD_4nXdz9AY7bgdqGmQ2QuGV8t90EgGpkOQ2TCEnBQg71t3TEmEPDHNklSuDIPKksVlSSRsbasV8eCo7cTmtZ94xUO9qORClLPktB_s_HyvLH4WN8k-2f8YE6-_yQdMdh1TbNeruwXaMQQ?key=fq77slujjbwzJEcqlnHGQnGa\")
","_postman_id":"7c3c54ce-fa45-400a-8aec-5c80dca97990","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}}},{"name":"Payload fields","item":[],"id":"6821b8e7-8b92-4885-b460-08f1d7de2af3","description":"Below, you will find the list of fields that can be sent in the different webhook events.
\nSome fields will be returned for each webhook topic, while others are specific to certain topics.
\n","_postman_id":"6821b8e7-8b92-4885-b460-08f1d7de2af3","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}}},{"name":"Webhook events","item":[{"name":"Job create webhook event","id":"4ba82776-7146-417c-aed5-c2b97b4c7ee5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"event\": \"job\",\n \"type\": \"create\",\n \"data\": {\n \"id\": 100214157,\n \"status\": \"searching\",\n \"comment\": null,\n \"pickupAt\": null,\n \"dropoffAt\": null,\n \"createdAt\": \"2022-01-19T14:19:44.000+01:00\",\n \"endedAt\": null,\n \"transportType\": {\n \"code\": \"bike\"\n },\n \"packageType\": null,\n \"originComment\": null,\n \"destinationComment\": null,\n \"jobReference\": \"12345\",\n \"currentDelivery\": null,\n \"deliveries\": [\n {\n \"id\": 100259470,\n \"clientReference\": \"12345\"\n },\n {\n \"id\": 100259471,\n \"clientReference\": \"465768798\"\n }\n ]\n }\n}"},"url":"https://your.domain.com/your-job-create-webhooks-endpoint","description":"Job creation webhook schema. Please use the clientReference to track your deliveries
Job update webhook schema. Please use the clientReference to track your deliveries
Delivery creation webhook schema. Please use the clientReference to track your deliveries
Delivery update webhook schema. Please use the clientReference to track your deliveries
Receive courier update events including lat/long location position updates.
\nAs part of this webhook event, the list of deliveries is also included.
\nThis webhook is sent every 1 to 10 seconds and it is triggered every time the courier mobile application sends us a valid location. Its frequency depends on several factors such as:
\n- \n
- the stage of the delivery \n
- the speed of the courier \n
- the distance covered since the last update \n
Required fields
\n","urlObject":{"path":["your-endpoint-url"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a4d1c31-e3e3-4755-8054-245d02196ab8"}],"id":"57ed5e16-3b21-48ee-a015-3e5af7d83040","description":"The following events can each be subscribed to in order to receive real-time updates.
\nTo understand the flow of events you can expect to receive for various scenarios, please see event flows documentation.
\n","_postman_id":"57ed5e16-3b21-48ee-a015-3e5af7d83040","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}}}],"id":"7ed0989c-a5c2-4653-8c3a-499d062418a3","description":"[Deprecated] This section details our previous webhook offering, which is now deprecated, meaning it is no longer supported or maintained. Please transition to our version 3 to harness our latest technology, and be sure to subscribe to our forum for future announcements regarding the discontinuation date.
\nNote: In case of an unsuccessful webhook event reception, our system can attempt to retry sending the same webhook event up to 5 times.
\n","_postman_id":"7ed0989c-a5c2-4653-8c3a-499d062418a3","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"072e0459-ad87-4938-82cc-0d5a3b609571","id":"072e0459-ad87-4938-82cc-0d5a3b609571","name":"Webhooks","type":"folder"}}}],"id":"072e0459-ad87-4938-82cc-0d5a3b609571","description":"Webhooks allow you to receive real-time events regarding the delivery of your packages.
\nIt's critical to use webhooks as opposed to polling the API for continuous updates in order to avoid exceeding our rate limits.
\nAuthentication
\nWebhook validation headers can be used to validate that the webhooks we send actually come from us. To set this up simply add the 'Webhook authentication header' starting with \"X-\" along with the 'Webhook authentication key' in the Stuart admin page(Sandbox, Production), or when using our webhook management endpoints.
\nEach time we send a webhook we will then include this key-value pair which can be used to validate where the webhooks come from.
\nPublic IPs
\nPlease note that we recommend you to rely on DNS resolution rather than IP whitelisting to successfully receive webhooks events.
\nFor security purposes here is the list of public IPs from which you can receive webhooks events from us:
\nSandbox
\n- \n
- 34.254.62.41 \n
- 54.194.139.211 \n
- 54.195.221.43 \n
Production
\n- \n
- 108.128.110.19 \n
- 54.171.243.90 \n
- 52.51.60.65 \n
Create a webhook through the Stuart API.
\nHere is the full list of events you can subscribe to:
\n- \n
package_created\ncourier_assigned\ncourier_arriving\ncourier_waiting\npackage_delivering\npackage_delivered\npackage_canceled\npackage_returning\npackage_returned\ncourier_reassigning\n
Note: In the payload, you must specify the webhook version that you want to use. The possible values for the version field are v1 and v3.
[Deprecated]
\nBelow are the webhook topics from our previous version:
\n- \n
- job/create \n
- job/update \n
- delivery/create \n
- delivery/update \n
- driver/update \n
This endpoint allows you to get information on a specific webhook that you have created.
\n[your_webhook_id] in the path refers to the webhook id generated when creating your webhook.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"This endpoint returns a list of your current webhooks. Currently, you are able to have a maximum of 6 webhooks.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"This endpoint allows you to update any webhooks you have created.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"This endpoint allows you to delete a particular webhook.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"As well as being able to manage your webhook setup through our Stuart dashboard (Sandbox, Production), you can also manage your webhooks by API.
\nYou are limited to a maximum of 6 webhook subscriptions.
\nA subscription can only include topics from the same version.
\nThe same URL cannot be utilized more than once to subscribe to the same webhook version. However, it is possible to use the same URL for subscriptions to different versions of the webhook.
\n","_postman_id":"c641551d-25bd-4c60-952f-534f316ec905","auth":{"type":"oauth2","oauth2":{"client_authentication":"The endpoint described below allows you validate a pickup or dropoff address.
\nNote that when the address is approximate (not precise), a valid contact phone is required for successful validation.
\nIt is generally recommended to always provide a valid phone number to ensure our courier the best chance of finding the location.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"Full-text address you want to validate
\n","type":"text/plain"},"key":"address","value":"32 Coombe Ln, Raynes Park, London SW20 0LA"},{"description":{"content":"Allowed Values: picking, delivering
\n","type":"text/plain"},"key":"type","value":"picking"},{"disabled":true,"description":{"content":"Phone number is required if the address is approximate and must be in E.164 standard
\n","type":"text/plain"},"key":"phone","value":"+34666777555"}],"variable":[]}},"response":[{"id":"91f82b55-6ea9-485f-88fa-dd96a27f08a6","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/v2/addresses/validate?address=29 Rue de Rivoli 75004 Paris&type=picking&phone=+34666777555","host":["{{api_url}}"],"path":["v2","addresses","validate"],"query":[{"description":"Full-text address you want to validate","key":"address","value":"29 Rue de Rivoli 75004 Paris"},{"description":"Allowed Values: picking, delivering","key":"type","value":"picking"},{"description":"Phone number is required if the address is approximate and must be in E.164 standard","key":"phone","value":"+34666777555"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"58dabf64-7c9b-4b26-8c20-24f381008ba7","name":"422 - record invalid","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/v2/addresses/validate?type=picking","host":["{{api_url}}"],"path":["v2","addresses","validate"],"query":[{"description":"Full-text address you want to validate","key":"address","value":"Rivolu","disabled":true},{"description":"Allowed Values: picking, delivering","key":"type","value":"picking"},{"description":"Phone number is required if the address is approximate and must be in E.164 standard","key":"phone","value":"+34666777555","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"RECORD_INVALID\",\n \"message\": \"address is missing and address is empty\",\n \"data\": [\n \"address is missing\",\n \"address is empty\"\n ]\n}"},{"id":"d7d2a3da-4f7f-4e5f-80a1-a95ed80d3c66","name":"422 - out of range","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/v2/addresses/validate?address=57 King William St, Swindon SN1 3LS, UK&type=picking","host":["{{api_url}}"],"path":["v2","addresses","validate"],"query":[{"description":"Full-text address you want to validate","key":"address","value":"57 King William St, Swindon SN1 3LS, UK"},{"description":"Allowed Values: picking, delivering","key":"type","value":"picking"},{"description":"Phone number is required if the address is approximate and must be in E.164 standard","key":"phone","value":"+34666777555","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"OUT_OF_RANGE\",\n \"message\": \"This location is out of range\"\n}"},{"id":"bbd8007a-20bd-434c-98ae-45013a4ccf5c","name":"422 - can't geocode","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/v2/addresses/validate?address=apt 50 8bis tern&type=delivering","host":["{{api_url}}"],"path":["v2","addresses","validate"],"query":[{"description":"Full-text address you want to validate","key":"address","value":"apt 50 8bis tern"},{"description":"Allowed Values: picking, delivering","key":"type","value":"delivering"},{"description":"Phone number is required if the address is approximate and must be in E.164 standard","key":"phone","value":"+34666777555","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"CANT_GEOCODE_ADDRESS\",\n \"message\": \"The address can't be geocoded\"\n}"}],"_postman_id":"21fa9bf6-b146-408a-9de7-485f63648c67"},{"name":"Validate address","id":"57fb53d4-5a32-49e4-871a-955c6a3ff7f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"picking\",\n \"address\": \"32 Coombe Ln, Raynes Park, London SW20 0LA\",\n \"phone\": \"+442079476330\",\n \"coordinates\": {\n \"lat\": 51.40968,\n \"long\": -0.23012\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/addresses/validate","description":"Before create a job. you can ensure your pickup and dropoffs are eligible for a Stuart delivery.
\nEligibility in that context means that we can geocode the given address AND that the address is geocoded inside our zone coverage.
\nBest practice is to specify a phone number in order to avoid approximative addresses.
\nPayload Fields
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"Correct and valid addresses are a core aspect of being able to successfully conduct deliveries with Stuart.
\nRead our addresses best practices to ensure the optimal experience.
\n","event":[{"listen":"prerequest","script":{"id":"e88fcc76-91e6-46be-a5e9-615dfa9038bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9eb30212-c553-410d-bfe8-00e52e4d43e8","type":"text/javascript","exec":[""]}}],"_postman_id":"c1e9d5c2-3a46-4b02-92d1-8528b80aa299","auth":{"type":"oauth2","oauth2":{"client_authentication":"Get the picking or delivery area of an open Stuart zone. This endpoint response is in GeoJSON standard
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"Allowed Values: picking, delivering\ndefault: picking
\n","type":"text/plain"},"key":"type","value":"picking"}],"variable":[{"description":{"content":"(Required) Zone's code
\n","type":"text/plain"},"type":"any","value":"paris","key":"zone"}]}},"response":[{"id":"309b602d-40e7-4ccb-951e-c96895177086","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/v2/areas/paris?type=picking","host":["{{api_url}}"],"path":["v2","areas","paris"],"query":[{"description":"Allowed Values: picking, delivering\ndefault: picking","key":"type","value":"picking"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"properties\": {\n \"name\": \"Paris Operational Area\",\n \"zipcode\": \"paris - pu area\"\n },\n \"geometry\": {\n \"coordinates\": [\n [\n [\n 1.625374,\n 48.638567\n ],\n [\n 1.661449,\n 48.610099\n ],\n [\n 1.703686,\n 48.59977\n ],\n [\n 1.700628,\n 48.578011\n ],\n [\n 1.769871,\n 48.546156\n ],\n [\n 1.766073,\n 48.512243\n ],\n [\n 1.787217,\n 48.479909\n ],\n [\n 1.800124,\n 48.466643\n ],\n [\n 1.831155,\n 48.461111\n ],\n [\n 1.841199,\n 48.447148\n ],\n [\n 1.866927,\n 48.435411\n ],\n [\n 1.926225,\n 48.440924\n ],\n [\n 1.918225,\n 48.395443\n ],\n [\n 1.961794,\n 48.392284\n ],\n [\n 1.971254,\n 48.356471\n ],\n [\n 1.95918,\n 48.314346\n ],\n [\n 1.96391,\n 48.282625\n ],\n [\n 2.041543,\n 48.280763\n ],\n [\n 2.113408,\n 48.291733\n ],\n [\n 2.169214,\n 48.292884\n ],\n [\n 2.209298,\n 48.331505\n ],\n [\n 2.240499,\n 48.297343\n ],\n [\n 2.269626,\n 48.296207\n ],\n [\n 2.282247,\n 48.306635\n ],\n [\n 2.311561,\n 48.306404\n ],\n [\n 2.321747,\n 48.326095\n ],\n [\n 2.356313,\n 48.299405\n ],\n [\n 2.401732,\n 48.307436\n ],\n [\n 2.411169,\n 48.276832\n ],\n [\n 2.436769,\n 48.245227\n ],\n [\n 2.471729,\n 48.245184\n ],\n [\n 2.505176,\n 48.220405\n ],\n [\n 2.503702,\n 48.167681\n ],\n [\n 2.469976,\n 48.162346\n ],\n [\n 2.435828,\n 48.11998\n ],\n [\n 2.483168,\n 48.121425\n ],\n [\n 2.540456,\n 48.122839\n ],\n [\n 2.563969,\n 48.135726\n ],\n [\n 2.595972,\n 48.124397\n ],\n [\n 2.639409,\n 48.131308\n ],\n [\n 2.670249,\n 48.114507\n ],\n [\n 2.698036,\n 48.118969\n ],\n [\n 2.745574,\n 48.132417\n ],\n [\n 2.766088,\n 48.147115\n ],\n [\n 2.754438,\n 48.163574\n ],\n [\n 2.79707,\n 48.157116\n ],\n [\n 2.800051,\n 48.122911\n ],\n [\n 2.866936,\n 48.138842\n ],\n [\n 2.878247,\n 48.150697\n ],\n [\n 2.950696,\n 48.156927\n ],\n [\n 2.962124,\n 48.184219\n ],\n [\n 2.988668,\n 48.200126\n ],\n [\n 3.016239,\n 48.20745\n ],\n [\n 3.04643,\n 48.242558\n ],\n [\n 3.061271,\n 48.254406\n ],\n [\n 3.059889,\n 48.267872\n ],\n [\n 3.039163,\n 48.280854\n ],\n [\n 3.034968,\n 48.296284\n ],\n [\n 3.047375,\n 48.320373\n ],\n [\n 3.056004,\n 48.350462\n ],\n [\n 3.097932,\n 48.345501\n ],\n [\n 3.142564,\n 48.361068\n ],\n [\n 3.177479,\n 48.365306\n ],\n [\n 3.233684,\n 48.360088\n ],\n [\n 3.282726,\n 48.363819\n ],\n [\n 3.38537,\n 48.367863\n ],\n [\n 3.380427,\n 48.38691\n ],\n [\n 3.425736,\n 48.383106\n ],\n [\n 3.436811,\n 48.414556\n ],\n [\n 3.412657,\n 48.429655\n ],\n [\n 3.425066,\n 48.450045\n ],\n [\n 3.407926,\n 48.476399\n ],\n [\n 3.454215,\n 48.494294\n ],\n [\n 3.429788,\n 48.5219\n ],\n [\n 3.476784,\n 48.528769\n ],\n [\n 3.501104,\n 48.549041\n ],\n [\n 3.484706,\n 48.570893\n ],\n [\n 3.504284,\n 48.582483\n ],\n [\n 3.537816,\n 48.588754\n ],\n [\n 3.519886,\n 48.602443\n ],\n [\n 3.5809,\n 48.618003\n ],\n [\n 3.541594,\n 48.635122\n ],\n [\n 3.545023,\n 48.648974\n ],\n [\n 3.506939,\n 48.656295\n ],\n [\n 3.470251,\n 48.644114\n ],\n [\n 3.466458,\n 48.668959\n ],\n [\n 3.496683,\n 48.699721\n ],\n [\n 3.489358,\n 48.744567\n ],\n [\n 3.421691,\n 48.767485\n ],\n [\n 3.487492,\n 48.795877\n ],\n [\n 3.462006,\n 48.803616\n ],\n [\n 3.50898,\n 48.811202\n ],\n [\n 3.507607,\n 48.858132\n ],\n [\n 3.472257,\n 48.859635\n ],\n [\n 3.439512,\n 48.881239\n ],\n [\n 3.384183,\n 48.937233\n ],\n [\n 3.343019,\n 48.926959\n ],\n [\n 3.320578,\n 48.956013\n ],\n [\n 3.285718,\n 48.958115\n ],\n [\n 3.251228,\n 48.99177\n ],\n [\n 3.211513,\n 49.026961\n ],\n [\n 3.175135,\n 49.107863\n ],\n [\n 3.071147,\n 49.128151\n ],\n [\n 3.028372,\n 49.102076\n ],\n [\n 2.98394,\n 49.089574\n ],\n [\n 2.966929,\n 49.098474\n ],\n [\n 2.905302,\n 49.08903\n ],\n [\n 2.8977,\n 49.080938\n ],\n [\n 2.890993,\n 49.082602\n ],\n [\n 2.866205,\n 49.075383\n ],\n [\n 2.85194,\n 49.088271\n ],\n [\n 2.831863,\n 49.089316\n ],\n [\n 2.812431,\n 49.099664\n ],\n [\n 2.79476,\n 49.093484\n ],\n [\n 2.786861,\n 49.086197\n ],\n [\n 2.76719,\n 49.08579\n ],\n [\n 2.784197,\n 49.076478\n ],\n [\n 2.775918,\n 49.072438\n ],\n [\n 2.761951,\n 49.063839\n ],\n [\n 2.744433,\n 49.063912\n ],\n [\n 2.729517,\n 49.085812\n ],\n [\n 2.704623,\n 49.073709\n ],\n [\n 2.686365,\n 49.094092\n ],\n [\n 2.63946,\n 49.115905\n ],\n [\n 2.594374,\n 49.087282\n ],\n [\n 2.570863,\n 49.102568\n ],\n [\n 2.565242,\n 49.127959\n ],\n [\n 2.515938,\n 49.123327\n ],\n [\n 2.475788,\n 49.142137\n ],\n [\n 2.627676,\n 49.204021\n ],\n [\n 2.551631,\n 49.246567\n ],\n [\n 2.485253,\n 49.30435\n ],\n [\n 2.401028,\n 49.26676\n ],\n [\n 2.329147,\n 49.222837\n ],\n [\n 2.362098,\n 49.159244\n ],\n [\n 2.326126,\n 49.189323\n ],\n [\n 2.306156,\n 49.187978\n ],\n [\n 2.268726,\n 49.163031\n ],\n [\n 2.231296,\n 49.158346\n ],\n [\n 2.243912,\n 49.170974\n ],\n [\n 2.225532,\n 49.183388\n ],\n [\n 2.177794,\n 49.180776\n ],\n [\n 2.132832,\n 49.198621\n ],\n [\n 2.110997,\n 49.195728\n ],\n [\n 2.093241,\n 49.215373\n ],\n [\n 2.030692,\n 49.196828\n ],\n [\n 2.00725,\n 49.183786\n ],\n [\n 1.977221,\n 49.187106\n ],\n [\n 1.947191,\n 49.176192\n ],\n [\n 1.859272,\n 49.177181\n ],\n [\n 1.789127,\n 49.190343\n ],\n [\n 1.763174,\n 49.179643\n ],\n [\n 1.752164,\n 49.225998\n ],\n [\n 1.715535,\n 49.258935\n ],\n [\n 1.656719,\n 49.191631\n ],\n [\n 1.643555,\n 49.131926\n ],\n [\n 1.593561,\n 49.096179\n ],\n [\n 1.510868,\n 49.092237\n ],\n [\n 1.432655,\n 49.071417\n ],\n [\n 1.466149,\n 49.006374\n ],\n [\n 1.459368,\n 48.983745\n ],\n [\n 1.476765,\n 48.971277\n ],\n [\n 1.499763,\n 48.974252\n ],\n [\n 1.486382,\n 48.965492\n ],\n [\n 1.529079,\n 48.90012\n ],\n [\n 1.542648,\n 48.8671\n ],\n [\n 1.560091,\n 48.840215\n ],\n [\n 1.568337,\n 48.764356\n ],\n [\n 1.614435,\n 48.746293\n ],\n [\n 1.556521,\n 48.69832\n ],\n [\n 1.597669,\n 48.683618\n ],\n [\n 1.598078,\n 48.658878\n ],\n [\n 1.625374,\n 48.638567\n ]\n ]\n ],\n \"type\": \"Polygon\"\n },\n \"id\": \"378259afa690d017bb41f09313aa88cc\"\n }\n ]\n}"},{"id":"74e894c9-6d14-4a8c-82c1-b4633ebaf75a","name":"404 - zone not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/v2/areas/pris?type=picking","host":["{{api_url}}"],"path":["v2","areas","pris"],"query":[{"description":"Allowed Values: picking, delivering\ndefault: picking","key":"type","value":"picking"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"NOT_FOUND\",\n \"message\": \"Not found\"\n}"}],"variable":[{"key":"zone","value":"paris","description":"(Required) Zone's code"}],"_postman_id":"e254afe9-84b1-492a-b60a-9d0acd42ee6f"}],"id":"bbde72bf-8708-42cf-86a3-070219150c8e","description":"Here's a list of the zones where Stuart is currently operating, these codes can be used to get zone coverage GeoJSON through the get zone coverage endpoint.
\nFrance
\namiens, angers, angouleme, annecy, antibes, aubagne, avignon, beauvais, besancon, beziers, blois, bordeaux, boulogne_sur_mer, brest, brive, caen, calais, cannes, cazeres, charleville_mezieres, cherbourg, cholet, clermont_ferrand, colmar, dijon, dinard, douai, dunkerque, evreux, foix, grenoble, guerande, la_rochelle, le_havre, le_mans, lille, limoges, lyon, marseille, merignac, merlimont, metz, montpellier, mulhouse, nancy, nantes, nice, nimes, niort, orleans, pamiers, paris, perigueux, perpignan, poitiers, quimper, reims, rennes, roubaix, rouen, saint_brieuc, saint_etienne, saint_nazaire, saint_quentin, strasbourg, thionville, toulon, toulouse, tours, valence, valenciennes, vannes, bayonne, tarbes, belfort, lens, bethune, chalons_en_champagne, cambrai, soissons niort, lorient, chambery, bourges, la_roche_sur_yon, carcassonne, narbonne, dieppe, montauban, hyeres, sedan, orleans, frejus_saint_raphael, cherbourg, neydens, chalon_sur_saone, troyes, arras, pau, chartres , aix_en_provence , albi , auxerre , chambly , clairoix , conde_sur_lescaut , dax , denain , dreux , epernay , forbach , montluçon , roanne , saint_dizier , saint_malo , sens , villefranche_sur_saone
United-Kingdom
\nbasildon, belfast, birmingham, blackpool, bournemouth, brighton, bristol, cambridge, cardiff, coventry, crawley, darlington, derby, edinburgh , exeter, farnborough, gillingham, glasgow ,grimsby, harlow , huddersfield, hull, leeds, leicester, liverpool, london, manchester, milton_keynes, newcastle_gateshead, northampton, nottingham, norwich , oxford, portsmouth , plymouth, reading, sheffield, south_shields, southampton, stoke ,sunderland, swansea, teesside, wakefield, warrington , wigan , york
Poland
\nkraków , lodz , poznan , silesia, szczecin , torun , tricity , warszawa , wroclaw
Italy
\nmilano
This endpoint allows you to find scheduling slots for one of our zones.
\nPlease note you will receive slots from the current time of making your request. Hence we recommend fetching slots for dates in the future and caching the results for around one month for optimal results.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"(Required) Type of schedules\nAllowed values: [pickup, dropoff]
\n","type":"text/plain"},"type":"any","value":"pickup","key":"type"},{"description":{"content":"(Required) Date\nFormat: YYYY-MM-DD
\n","type":"text/plain"},"type":"any","value":"2022-07-22","key":"date"}]}},"response":[{"id":"bc6040b2-47a4-4a17-8df0-0fe8473314d9","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/jobs/schedules/paris/pickup/2021-12-25"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"date\": \"2021-12-25T00:00:00.000+01:00\",\n \"type\": \"pickup\",\n \"slots\": [\n {\n \"start_time\": \"2021-12-25T00:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T00:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T00:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T00:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T00:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T00:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T00:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T01:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T01:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T01:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T01:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T01:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T01:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T01:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T01:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T02:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T02:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T02:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T02:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T02:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T02:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T02:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T02:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T03:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T03:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T03:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T03:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T03:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T03:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T03:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T03:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T04:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T04:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T04:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T04:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T04:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T04:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T04:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T04:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T05:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T05:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T05:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T05:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T05:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T05:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T05:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T05:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T06:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T06:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T06:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T06:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T06:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T06:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T06:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T06:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T07:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T07:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T07:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T07:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T07:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T07:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T07:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T07:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T08:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T08:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T08:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T08:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T08:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T08:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T08:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T08:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T09:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T09:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T09:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T09:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T09:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T09:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T09:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T09:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T10:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T10:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T10:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T10:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T10:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T10:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T10:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T10:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T11:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T11:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T11:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T11:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T11:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T11:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T11:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T11:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T12:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T12:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T12:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T12:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T12:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T12:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T12:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T12:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T13:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T13:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T13:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T13:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T13:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T13:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T13:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T13:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T14:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T14:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T14:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T14:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T14:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T14:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T14:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T14:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T15:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T15:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T15:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T15:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T15:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T15:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T15:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T15:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T16:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T16:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T16:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T16:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T16:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T16:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T16:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T16:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T17:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T17:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T17:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T17:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T17:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T17:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T17:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T17:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T18:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T18:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T18:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T18:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T18:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T18:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T18:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T18:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T19:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T19:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T19:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T19:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T19:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T19:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T19:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T19:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T20:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T20:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T20:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T20:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T20:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T20:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T20:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T20:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T21:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T21:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T21:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T21:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T21:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T21:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T21:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T21:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T22:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T22:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T22:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T22:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T22:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T22:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T22:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T22:45:00.000+01:00\",\n \"end_time\": \"2021-12-25T23:00:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T23:00:00.000+01:00\",\n \"end_time\": \"2021-12-25T23:15:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T23:15:00.000+01:00\",\n \"end_time\": \"2021-12-25T23:30:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T23:30:00.000+01:00\",\n \"end_time\": \"2021-12-25T23:45:00.000+01:00\"\n },\n {\n \"start_time\": \"2021-12-25T23:45:00.000+01:00\",\n \"end_time\": \"2021-12-26T00:00:00.000+01:00\"\n }\n ]\n}"},{"id":"7ba1e658-73fb-408d-9697-b8cd447eeda8","name":"400 - invalid type","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/jobs/schedules/paris/picking/2021-12-25"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"INVALID_TYPE\",\n \"message\": \"Invalid type. Valid types: pickup or dropoff.\"\n}"},{"id":"4a3d4871-0a3b-4076-8d4c-38c9d91ebbf3","name":"400 - invalid date","originalRequest":{"method":"GET","header":[],"url":"{{api_url}}/v2/jobs/schedules/paris/pickup/2021-25-12"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"INVALID_TYPE\",\n \"message\": \"Invalid date format. Valid format: YYYY-MM-DD, YYY-MM-DDThh:mm:ssZ or YYY-MM-DDThh:mm:ssTZD\"\n}"}],"_postman_id":"7b1abc29-1d79-4117-89e9-016ecc393624"},{"name":"Get delivery slots","id":"9acceabc-f973-49a4-a32b-9d19645baa75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"from\": \"2023-08-10T00:00:00.000+02:00\",\n \"to\": \"2023-08-10T23:59:00.000+02:00\",\n \"address\": \"32 Coombe Ln, Raynes Park, London SW20 0LA\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/v2/delivery_slots","description":"This endpoint allows you to retrieve the available delivery slots configured for your account, which can then be displayed to your customers.
\nPlease note, the slot ID can also be used when creating a delivery job for a specific delivery slot
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"Get scheduling slots which can be used to display directly to your customer on your site.
\nThese slots also allow you to recognise Stuart's opening and closing times for a given zone.
\n","_postman_id":"19ae6d64-d878-42cd-804e-a954a6afb85a","auth":{"type":"oauth2","oauth2":{"client_authentication":"Here you can find the exhaustive list of Stuart API error responses, the expected format can be found below:
\n{\n \"error\": \"BAD_REQUEST\",\n \"message\": \"job[dropoffs][0][package_type] is invalid\"\n}\n\nThe HTTP status codes detailed below allow you to determine the best way to address the error.
If you see an error response which is not listed below please let us know.
Authentication Errors
\nFor authentication errors the response payload has a different structure than other error types, the expected format can be found below:
\n{\n \"error\": \"invalid_client\", \n \"error_description\": \"Client authentication failed due to unknown client, no client authentication included, or unsupported authentication method.\"\n}\n\nAPI Communication Errors
\nAddress Errors
\nScheduled Job Errors
\nOther Job Errors
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c79024c4-e3f3-484a-9371-c146a7a626ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2a00b2d1-f373-4e29-8140-7113c058050d","type":"text/javascript","exec":[""]}}],"_postman_id":"e7572871-c6a1-4d29-931a-13a6d4fa386d"},{"name":"Rate Limits","item":[],"id":"a0f9081e-2ccf-4e56-aa47-829a39cfacaf","description":"Rate limiting of the API is primarily considered on a per-user basis. We consider two main Rate Limit windows: per minute and per day. Additionally, any requests made before being authenticated are rate limited by IP source and are restricted to 500 requests per minute.
\nIf you exceed our rate limits you can expect to receive an error code 429 responses from our API.
Minute Rate Limit
\nUp to 1000 requests can be consumed every minute, and our response headers will detail:
\n- \n
X-MinuteRateLimit-Identifierallowing you to identify the minute time window \nX-MinuteRateLimit-Limitis the total amount of requests \nX-MinuteRateLimit-Remainingis the remaining amount of available requests \n
{\n ...\n \"X-MinuteRateLimit-Identifier\": \"[IP/USER ID]:[YYYY]-[MM]-[DD]-[hh]-[mm]\",\n \"X-MinuteRateLimit-Limit\": \"1000\",\n \"X-MinuteRateLimit-Remaining\": \"XX\"\n ...\n}\n\nDaily Rate Limit
\nUp to 500,000 requests can be consumed per day, and our response headers will detail:
\n- \n
X-DailyRateLimit-Identifierallowing you to identify the daily time window \nX-DailyRateLimit-Limitis the total amount of requests \nX-DailyRateLimit-Remainingis the remaining amount of available requests \n
{\n ...\n \"X-DailyRateLimit-Identifier\": \"[IP/USER ID]:[YYYY]-[MM]-[DD]\",\n \"X-DailyRateLimit-Limit\": \"500000\",\n \"X-DailyRateLimit-Remaining\": \"XX\"\n ...\n}\n\nThis section list the additions and updates to the Stuart On-demand API:
\n25/03/2025
\nTwo new fields added to the delivery_options object:
- \n
\nalternative_locations: Allows clients to specify an alternative delivery option (e.g. neighbour, safe place) when in-person delivery is not required at first attempt. \n
\nundeliverable_actions: Enables clients to define the action to be taken in case the recipient is unavailable (e.g. return, discard). \n
07/02/2025
\n- \n
- Revamp of the \"Job & Deliveries\" section, now renamed to \"Job, Deliveries, and Packages\". Updated the Webhooks section and removed outdated sections, including \"Client Libraries\" and \"Plugins\". \n
25/11/2024
\n- \n
- New package_split webhook. It has been added to the webhooks v3. \n
01/11/2024
\n- \n
- A new \"client_tracking_url\" field has been added to the V3 webhook payloads, providing your staff with a live tracking page to manage orders, access customer support, and view proof of deliveries.
The existing \"tracking_url\" has been renamed to \"end_customer_tracking_url\" to clarify its purpose for end-customers tracking their deliveries. \n
27/09/2024
\n- \n
- A new \"return_reason\" field has been added to the 'get job' endpoint, providing the reason for a package return. \n
11/06/2024
\n- \n
- New \"packages\" field added to the courier-assigned webhook payload, to share IDs of packages stacked with the one covered by the webhook. \n
27/05/2024
\n- \n
- Update the 'job creation' endpoint. The error \"UNSUPPORTED_JOB_STACKING\" has been added. \n
11/12/2023
\n- \n
- New courier_moving to dropoff webhook. It has been added to the webhooks v3. \n
21/11/2023
\n- \n
- Updated the 'job pricing' endpoint. \n
31/10/2023
\n- \n
- New 'Delivery order ready' endpoint. \n
10/10/2023
\n- \n
- New \"partner_data\" field added to the job creation payload. \n
25/09/2023
\n- \n
New \"Customer promised time\" endpoint added, to return the estimate time to dropoff address.
\n \nNew webhooks \"v3\" released, adding new statuses and more granularity to the tracking.
\n \n
05/09/2023
\n- \n
Access is restricted to proof of delivery and invoice image url's, available through GET Job endpoints, with Time to Live (TTL) of 48 hours for
\nsignature_urlandproof_of_delivery_url, and 1 hour forinvoive_url. \n⚠️ Please note that URL links can be up to 2000 characters in length.
\n \nTo access these contents at any time we recommend storing the image in your systems.
\n \n
04/09/2023
\n- \n
- Courier online/offline webhook events for dedicated fleets are now deprecated, the endpoint details have been removed from this documentation. More details here. \n
09/08/2023
\nScheduled offering added:
\n- \n
'get delivery slots' endpoint allows you to retrieve available scheduled delivery slots configured for your account, which can then be displayed to your customers.
\n \nNew attributes added to the job creation endpoint,
\noffering_typeto specify a scheduled delivery request, anddelivery_slot_IDfor specifying a slot from the 'get delivery slots' endpoint. \n
10/07/2023
\n- \n
- Now able to request pin-code validation as proof of delivery at a package level within the
delivery optionsobject. More details can be found here. \n
06/07/2023
\n- \n
- Added a new POST /addresses/validate endpoint. It is now possible to check an address validity using its coordinates. \n
25/12/2022
\n- \n
- Now able to specify the
dropoffs_contact's extension numbe in the newphone_pin_codefield. More details can be found here. \n
14/12/2022
\n- \n
Now able to retrieve photo proof of delivery in the API response of the \"Get a Job\" & \"Get Jobs\" endpoints. More information here.
\n \nAdded
\nrestricted_itemsasdelivery_optionsin the Job creation endpoint. More details can be found here. \n
If you have any questions about your integration, there's a good chance someone may have already asked it in the developers community forum.
\nFind the answer your are looking for in the FAQ section or ask your question by creating a new topic in the Q&A section. Our team will get back to you as soon as possible!
\nFor any other non-technical requests please contact support@stuart.com or log into the production dashboard and live chat with us.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4ee41ae3-9466-47dd-8574-66533de6bcac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3b5074be-19d2-4a1d-ae3e-ec5f557b62dd","type":"text/javascript","exec":[""]}}],"_postman_id":"34e506f3-da30-490d-846e-fcdd3e328a57"}],"id":"69c5cfaa-1063-4088-be5b-1a3578ad928e","description":"This section details the full technical specification of the Stuart Delivery API. Please find additional content, help and guides in our Developer Community Forum.
\nBefore starting your integration, we strongly recommend reading our getting started guide and following the linked guidance, including signing up to the forum to receive announcements of API changes and updates that may impact your integration.
\nBe sure to make use of our postman collection to help you play around with our API, you'll need to set up the authentication using the credentials you'll get by following the setup steps below.
\nDisclaimer
Once your delivery is assigned to a courier, you can request their anonymous phone number. Once the delivery is complete, the phone number will expire. Read more about our two-way anonymised calling.
Please note that, pursuant to the General Data Protection Regulation (GDPR), the minimisation of personal data is a mandatory requirement. During your integration, we therefore strongly recommend implementing our data masking solution in order to comply with the GDPR and other applicable data protection regulations.
\n","auth":{"type":"oauth2","oauth2":{"client_authentication":"