Included in this document:
Description
Query to book a driver to pick up from your location. They will make a best effort attempt to pick up on the same day - however, if you book after 2PM it is recommended that you book again in the morning if they don't pick up on the same day. Each call to this endpoint will ping the driver, so do not call this endpoint excessively.
This query is supported for the following companies:
- Castle Parcels
- Post Haste Couriers
- New Zealand Couriers
- Mainstream Freight
- Fedex
- New Zealand Post
- First Global Logistics
Mainstream Freight
When booking for Mainstream Freight you must manifest the consignments first using this endpoint.
TIL Freight
TIL Freight cannot be booked through this endpoint. However, when you manifest TIL Freight consignments, it will be booked simultaneously. Using this endpoint for manifesting.
Requests
Method: POST
Content Type: application/json
URL: https://api.gosweetspot.com/api/bookpickup
Headers
access_key : your unqiue api key provided by GSS.
site_id : which site you are requesting action for.
Parameters
| Parameter | Type | Destination |
|---|---|---|
| Carrier | string | Specify the carrier to book a pickup for. Supported values: "NZCouriers". This value can be obtained from the AvailableServices endpoint. Mandatory field. |
| Consignments | array of string | Representing the consignments to be picked up. Not mandatory for New Zealand Couriers. You can include it, but it will do nothing. |
| TotalKg | TotalKg | Indicating the total weight of parcels. Not mandatory for New Zealand Couriers. You can include it, but it will do nothing. |
| Parts | integer | Indicating the total number of parcels. This field is mandatory when booking for FirstGlobal. You can include it for other carriers, but it will do nothing. |
Return format
A string indicating whether or not the pickup request was lodged successfully.
Request example
Please note some fields are mandatory for different carriers.
curl --location 'https://api.gosweetspot.com/api/bookpickup' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json' \
--data '{
"Carrier": "PostHaste"
}'
Response example
Binary blocks below have been trimmed for presentation.
Success. Your booking has been accepted. #NC12345678