Deliveries API
Search
K
Comment on page

Edit dropoff

In this endpoint you can fix or change the dropof data and some properties of a delivery.

Endpoint

PATCH /v1/deliveries/dropoff

Request

Property
Type
Description
Required
Constraints
deliveryIds
array of string
IDs of the task you want to change information
YES
deliveryChanges
object
New data information, can have a contact, a location and packages.
YES
deliveryChanges.location
Location
New data location
NO
lat and lng are required
deliveryChanges.contact
Contact
New data contact
NO
deliveryChanges.packages
Package
New data packages
NO
deliveryChanges.cod
number
Use this option if the driver needs to collect money from your client
NO
deliveryChanges.referenceId
string
Extern id
NO
deliveryChanges.addTags
array of numbers
List of tags IDs created in the system you want to add
NO
deliveryChanges.removeTags
array of numbers
List of tags IDs created in the system you want to remove
NO
deliveryChanges.extraData
array of objects
List of objects with extra information on delivery
NO
recalculatePrice
boolean
After the change, the price changes or not.
YES
true/false
reorderRoute
boolean
After the change, the route changes order or not.
YES
true/false

Response

Property
Type
Description
code
string
Result code.
message
string
Result description.

Example

Request
200 Success
curl --location --request PATCH 'https://api.shippify.co/v1/deliveries/dropoff' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXX=' \
--header 'Content-Type: application/json' \
--header 'Cookie: locale=es' \
--data-raw '{
"deliveryIds": [
"t-pruaas-4973"
],
"reorderRoute": true,
"recalculatePrice": true,
"recalculateCity": false,
"deliveryChanges": {
"location": {
"address": "av. echeñique 8861, 7860169 la reina, región metropolitana, chile",
"instructions": "CLIENTE RETIRA PRODUCTOS EN POLICENTRO 2",
"lat": -23.557166,
"lng": -46.664559
},
"contact": {
"name": "iliana",
"email": "[email protected]"
},
"packages": [
{
"id": "SSSTP002",
"name": "XIAOMI REDMI 10S",
"size": 2,
"price": 0,
"weight": 5,
"qty": 1
}
],
"cod": 10,
"referenceId": "0987837468",
"addTags":[1003],
"removeTags": [],
"extraData": [{"name":"Billing", "value":"0000-123-334"}]
}
}'
{
"code": "OK",
"message": "Success"
}