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

patch

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

Autorizaciones

Cuerpo

deliveryIdsstring[]Requerido

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

Example: t-pruaas-4973

referenceIdsstring[]Opcional

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

Example: FACT-0001

recalculatePriceboolOpcional

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

Example: true

reorderRouteboolOpcional

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

recalculateCityboolOpcional

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

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: 574

{
  "deliveryIds": [
    "t-pruaas-4973"
  ],
  "referenceIds": [
    "FACT-0001"
  ],
  "deliveryChanges": {
    "location": {
      "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
      "instructions": "Local 1001",
      "lat": -33.511333999,
      "lng": -70.6102933
    },
    "contact": {
      "name": "Iliana Bolaños",
      "email": "[e-mail]",
      "phonenumber": "0998976565"
    },
    "packages": [
      {
        "id": "Product-001",
        "name": "Caja de colores",
        "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"
  }
}

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
            }
        ]
    }
}