Update pickup point

Endpoint to update pickup data, including the address and contact information at the warehouse.

Edit pickup

Endpoint that allows editing the pickup data of a delivery.

patch

/v1/deliveries/pickup

Authorizations

Body

deliveryIdsstringrequired

Delivery identifiers to be edited separated by comma, up to 10 deliveries can be edited in a single request

Example: t-pruaas-4973

recalculatePricebooleanrequired

Indicates whether to recalculate the price after modification (recommended)

Example: true

reorderRoutebooleanrequired

Indicates whether to reorder the route (if the delivery belongs to a route) after modification (recommended)

Example: true

deliveryChangesobjectrequired

Changes to be made in the task

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.shippify.co/v1/deliveries/pickup' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "deliveryIds": "t-pruaas-4973",
    "recalculatePrice": true,
    "reorderRoute": true,
    "deliveryChanges": {
      "location": {
        "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
        "instructions": "Unit 1001",
        "lat": -33.511333999,
        "lng": -70.6102933
      },
      "contact": {
        "name": "Iliana Bolaños",
        "email": "[e-mail]",
        "phonenumber": "0998976565"
      }
    }
  }'

200

401

200

{
  "code": "OK",
  "message": "Success",
  "data": {
    "jobs": "JOB-1234"
  }
}

Successful operation

Use cases

Update sender details

{
    "deliveryIds": "t-pruaas-4973",
    "deliveryChanges": {
        "location": {
            "address": "av. echeñique 8861, 7860169 la reina, región metropolitana, chile",
            "instructions": "CLIENT WILL PICKUP THE PACKAGES AT DOOR 2",
            "lat": -23.557166,
            "lng": -46.664559
        },
        "contact": {
            "name": "iliana",
            "email": "[e-mail]"
        }
    },
    "recalculatePrice": true,
    "reorderRoute": true
}

Update pickup address

{
    "deliveryIds": "t-pruaas-4973",
    "deliveryChanges": {
        "location": {
            "address": "av. echeñique 8861, 7860169 la reina, región metropolitana, chile",
            "instructions": "CLIENT WILL PICKUP THE PACKAGES AT DOOR 2",
            "lat": -23.557166,
            "lng": -46.664559
        }
    },
    "recalculatePrice": true,
    "reorderRoute": true
}