Update delivery

Endpoint to update delivery details, including the address and contact information of the delivery point, as well as other properties such as packages, tags, COD (cash on delivery), reference identifier, among others.

Edit delivery data

patch

Endpoint that allows editing the data of one or multiple deliveries.

Autorizaciones

Cuerpo

deliveryIdsstring[]Requerido

List of delivery identifiers to be edited, up to 10 deliveries can be edited in a single request

Example: t-pruaas-4973

referenceIdsstring[]Opcional

List of reference identifiers of orders to be edited, up to 10 deliveries can be edited in a single request. If this property is used, do not include deliveryIds

Example: FACT-0001

recalculatePricebooleanOpcional

Indicates whether to recalculate the price after modification (recommended)

Example: true

reorderRoutebooleanOpcional

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

Example: true

recalculateCitybooleanOpcional

Indicates whether to recalculate the city after modification (recommended)

Example: true

Respuestas

200

Successful operation

application/json

401

Unauthorized

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "deliveryIds": [
    "t-pruaas-4973"
  ],
  "referenceIds": [
    "FACT-0001"
  ],
  "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": "[email protected]",
      "phonenumber": "0998976565"
    },
    "packages": [
      {
        "id": "Product-001",
        "name": "Color box",
        "qty": 4,
        "weight": 5.3,
        "size": "slot",
        "price": 5.3
      }
    ],
    "cod": 10.4,
    "referenceId": "PO-00012",
    "addTags": [
      1003
    ],
    "removeTags": [
      1003
    ]
  },
  "recalculatePrice": true,
  "reorderRoute": true,
  "recalculateCity": true
}

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

Use cases

Update delivery by its deliveryId

{
    "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": "CLIENT PICKS UP THE PACKAGE AT DOOR 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"}]
    }
}

Update delivery by its referenceId

{
    "referenceIds": [
        "0987837468"
    ],
    "reorderRoute": true,
    "recalculatePrice": true,
    "recalculateCity": false,
    "deliveryChanges": {
        "location": {
            "address": "av. echeñique 8861, 7860169 la reina, región metropolitana, chile",
            "instructions": "CLIENT PICKS UP THE PACKAGE AT DOOR 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"}]
    }
}

Update recipient details

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "deliveryChanges": {
        "contact": {
            "name": "iliana",
            "email": "[email protected]"
        }
    }
}

Update delivery address

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "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
        }
    }
}

Update tags

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "deliveryChanges": {
        "addTags":[1003],
        "removeTags": []
    }
}

Update referenceId

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "deliveryChanges": {
        "referenceId": "0987837468"
    }
}

Update delivery packages

{
    "deliveryIds": [
        "t-pruaas-4973"
    ],
    "deliveryChanges": {
       "packages": [
            {
                "id": "SSSTP002",
                "name": "XIAOMI REDMI 10S",
                "size": 2,
                "price": 0,
                "weight": 5,
                "qty": 1
            }
        ]
    }
}