Update pickup point

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

Edit pickup

patch

Endpoint that allows editing the pickup data of a delivery.

Autorizaciones

AuthorizationstringRequerido

Cuerpo

deliveryIdsstringRequerido

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

Example: t-pruaas-4973

recalculatePricebooleanRequerido

Indicates whether to recalculate the price after modification (recommended)

Example: true

reorderRoutebooleanRequerido

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

Example: true

Respuestas

200

Successful operation

application/json

codestringOpcionalExample: OK

messagestringOpcionalExample: Success

401

Unauthorized

application/json

patch/v1/deliveries/pickup

PATCH /v1/deliveries/pickup HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "deliveryIds": "t-pruaas-4973",
  "deliveryChanges": {
    "location": {
      "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
      "instructions": "Unit 1001",
      "lat": -33.511333999,
      "lng": -70.6102933
    },
    "contact": {
      "name": "Juan Perez",
      "email": "[e-mail]",
      "phonenumber": "9999999999"
    }
  },
  "recalculatePrice": true,
  "reorderRoute": true
}

{
  "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": "Juan Perez",
            "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
}