Modificar entrega

Endpoint para actualizar datos de la entrega, esto incluye la dirección y la información de contacto del punto de entrega, asi como tambien el propiedades como paquetes, etiquetas, paquetes, cod, identificador de referencia, entre otros.

Editar datos de la entrega

Endpoint que permite editar los datos de una o varias entregas.

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

Authorization

Basic_Auth

Body

application/json

Aqui va la descripción

deliveryIds*array of string

Lista de identificadores de las entregas que se van a editar, se puede editar en un mismo request hasta 10 entregas

referenceIdsarray of string

Lista de identificadores de referencia de los pedidos que se va a editar, se puede editar en un mismo request hasta 10 entregas. Si se coloca esta propiedad, no colocar deliveryIds

deliveryChanges*object

Cambios a realizar en la tarea

recalculatePricebool

Indica si se va a recalcular el precio luego de la modificación (recomendable)

Example: true

reorderRoutebool

Indica si se va a reordenar la ruta (en caso que la entrega pertenezca a una ruta) luego de la modificación (recomendable)

Example: true

recalculateCitybool

Indica si se va a recalcular la ciudad luego de la modificación (recomendable)

Example: true

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Success"

dataobject

Información de los procesos adicionales creados (en el caso que la entrega pertenezca a una ruta)

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/deliveries/dropoff', {
    method: 'PATCH',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "deliveryIds": [
        "t-pruaas-4973"
      ],
      "deliveryChanges": {}
    }),
});
const data = await response.json();

Response

200401

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

Casos de uso

Modificar entrega por 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": "CLIENTE RETIRA PRODUCTOS EN POLICENTRO 2",
            "lat": -23.557166,
            "lng": -46.664559
        },
        "contact": {
            "name": "iliana",
            "email": "[e-mail]"
        },
        "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"}]
    }
}

Modificar entrega por referenceId

{
    "referenceIds": [
        "0987837468"
    ],
    "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": "[e-mail]"
        },
        "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"}]
    }
}

Modificar datos del destinatario

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

Modificar dirección de entrega

{
    "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
        }
    }
}

Modificar etiquetas

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

Modificar referenceId

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

Modificar paquetes de la entrega

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