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.

PATCHhttps://api.shippify.co/v1/deliveries/pickup

Authorization

Basic_Auth

Body

application/json

Description goes here

deliveryIds*string

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

Example: "t-pruaas-4973"

deliveryChanges*object

Changes to be made in the task

recalculatePrice*boolean

Indicates whether to recalculate the price after modification (recommended)

Example: true

reorderRoute*boolean

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

Example: true

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Success"

dataobject

Information of additional processes created (if the delivery belongs to a route)

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/deliveries/pickup', {
    method: 'PATCH',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deliveryIds": "t-pruaas-4973",
      "reorderRoute": true,
      "recalculatePrice": true,
      "deliveryChanges": {
        "location": {
          "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile"
        }
      }
    }),
});
const data = await response.json();

Response

200401

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

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
}