Droppa API, developers can integrate our delivery platform into their applications. The API is designed for developers to check prices, book an immediate or scheduled delivery and follow updates until delivery completion.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28395552","collectionId":"933fdf27-93fb-4f35-8f68-da538ff0d500","publishedId":"2sA3e1CqRq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-08T09:16:22.000Z"},"item":[{"name":"Booking Service","item":[{"name":"Create Booking","event":[{"listen":"test","script":{"id":"85963223-e20f-4f28-98b5-73c2e26f9840","exec":[""],"type":"text/javascript","packages":{}}}],"id":"643930e1-d7c2-4994-a8b2-33139b347ca6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"serviceId\": \"id\",\r\n \"quotes_id\": \"667bd5b7011dab00717ae2de\",\r\n \"pickUp_address\": {\r\n \"province\": \"GAUTENG\",\r\n \"suburb\": \"Sandton\",\r\n \"addressLine\": \"123 Rivonia Road\",\r\n \"postalCode\": \"2196\",\r\n \"latitude\": \"-26.1076\",\r\n \"longitude\": \"28.0567\",\r\n \"comment\": \"Pick up address comment\",\r\n \"contact\": {\r\n \"firstName\": \"Lindo\",\r\n \"lastName\": \"Sibeko\",\r\n \"phone\": \"0787777777\",\r\n \"email\": \"lin@droppa.co.za\"\r\n }\r\n },\r\n \"dropOff_address\": {\r\n \"province\": \"WESTERN_CAPE\",\r\n \"suburb\": \"Cape Town\",\r\n \"addressLine\": \"456 Long Street\",\r\n \"postalCode\": \"8001\",\r\n \"latitude\": \"-33.9249\",\r\n \"longitude\": \"18.4241\",\r\n \"comment\": \"Drop off address comment\",\r\n \"contact\": {\r\n \"firstName\": \"Rhulani\",\r\n \"lastName\": \"Chauke\",\r\n \"phone\": \"079000000\",\r\n \"email\": \"thula@droppa.co.za\"\r\n }\r\n },\r\n \"type\": \"EXPRESS_COURIER\",\r\n \"pickUpDate\": \"2024-07-04 19:00\",\r\n \"parcelDimensions\": [\r\n {\r\n \"parcel_number\": \"1\",\r\n \"parcel_length\": 10.5,\r\n \"parcel_breadth\": 5.2,\r\n \"parcel_height\": 3.8,\r\n \"parcel_mass\": 1.5\r\n },\r\n {\r\n \"parcel_number\": \"1\",\r\n \"parcel_length\": 8.0,\r\n \"parcel_breadth\": 4.5,\r\n \"parcel_height\": 6.0,\r\n \"parcel_mass\": 2.0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.droppergroup.co.za/droppa/services/v1/create/book","description":"This endpoint allows you to create a new book entry.
\nserviceId (text, required): The ID of the service.
quotes_id (text, required): The ID of the quote.
pickUp_address (object, required): The pickup address details including province, suburb, address line, postal code, latitude, longitude, comment, and contact information.
dropOff_address (object, required): The drop-off address details including province, suburb, address line, postal code, latitude, longitude, comment, and contact information.
type (text, required): The type of the book.
pickUpDate (text, required): The date of pickup.
parcelDimensions (array, required): An array of parcel dimensions including parcel number, length, breadth, height, and mass.
The response will be in JSON format with the following fields:
\noid: The ID of the book entry.
businessKey: The business key associated with the book entry.
customer: Details of the customer including ID, mobile, email, and verification status.
dropOff: Details of the drop-off location and contact person.
pickUp: Details of the pickup location and contact person.
vehicleType: The type of vehicle used for the book entry.
... (and more)
The Create Booking service in the Droppa API enables users to book a delivery based on the details provided. This service allows users to finalize their delivery requests by converting quotes into actual bookings, specifying delivery details, and confirming the service. The Create Booking service is essential for initiating the delivery process after obtaining a quote.
\n","_postman_id":"f6e33732-68ed-439e-9411-63eaebbb971b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint allows users to validate an address by providing either a postal code or a suburb name. It checks the validity of the provided information and returns relevant address details if the input is correct.
\n","_postman_id":"5f3cd1fc-1be3-40fd-b40d-ac141dcc6f4e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Buckets/basket list of collections/deliveries service enables users to create and manage same day bookings efficiently. This service supports various booking configurations, including:
\nMultiple pick-ups to a single drop-off. (INBOUND)
\nSingle pick-up to multiple drop-offs. (OUTBOUND)
\nThe tracking endpoint is designed to provide real-time updates on booking statuses. When accessed, it returns the most recent status of a specified booking, ensuring that users have up-to-date information on the progress and current state of their bookings. This endpoint is an essential part of the tracking service.
\n","_postman_id":"d217c473-7c8f-4e01-b294-20c7eee6ab44","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This webhook allows you to set up a URL to receive real-time data notifications. When a booking is created, you will immediately receive the status of that booking at the specified URL. This ensures that you are promptly informed about new bookings and their statuses, enabling seamless and efficient integration with your system.
\n","_postman_id":"51acb832-c5d7-416d-85e7-49522894b89d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint allows you to create a new quote for a delivery service by providing the pickup address, drop-off address, and parcel dimensions.
\npickUp_address.province (string *req): Province where the pickup address is located
pickUp_address.suburb (string,required): Suburb of the pickup address
pickUp_address.addressLine (string,required): Street address of the pickup location
pickUp_address.postalCode (string,required): Postal code of the pickup location
pickUp_address.latitude (string): Latitude coordinate of the pickup location
pickUp_address.longitude (string): Longitude coordinate of the pickup location
dropOff_address.province (string): Province where the drop-off address is located
dropOff_address.suburb (string,required): Suburb of the drop-off address
dropOff_address.addressLine (string,required): Street address of the drop-off location
dropOff_address.postalCode (string,required): Postal code of the drop-off location
dropOff_address.latitude (string): Latitude coordinate of the drop-off location
dropOff_address.longitude (string): Longitude coordinate of the drop-off location
parcelDimensions (array, required): Array of parcel dimensions
parcel_length (number, required): Length of the parcel in centimeters
parcel_breadth (number,required): Breadth of the parcel in centimeters
parcel_height (number,required): Height of the parcel in centimeters
parcel_mass (number,required): Mass of the parcel in kilograms
The response will be in the form of a JSON schema with the following structure:
\n{\n \"quotes_id\": \"\",\n \"quotes\": [\n {\n \"companyName\": \"\",\n \"rates\": [\n {\n \"description\": \"\",\n \"type\": \"\",\n \"amount\": 0,\n \"transport_mode\": \"\",\n \"service_name\": \"\"\n }\n ]\n }\n ]\n}\n\nThe Quotes Service in the Droppa API provides functionality to generate, retrieve, update, and manage quotes for delivery services. This service allows users to get pricing information for their delivery requests based on various parameters such as pickup and drop-off locations, package dimensions, weight, and delivery service. The Quotes Service is essential for customers to understand the cost implications of their delivery needs before making a booking.
\n","_postman_id":"b950614b-df45-4c8a-8771-07015fc8574d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"