Cambiar estados de entrega

Puedes utilizar este endpoint para cambiar el estado a una entrega, aqui puedes añadir comentarios o agregar razones de problemas creados anteriormente en el sistema. Para conoces mas de los estados de Shippify, entre aqui.

Actualiza el estado de una entrega

Actualiza el estado de una entrega ya sea por el id de entrega o referencia.

PATCHhttps://api.shippify.co/v1/deliveries/{id}/status

Authorization

Basic_Auth

Path parameters

id*string

Identificador o Id de referencia de la entrega a cambiar de estado.

Body

application/json

Aqui va la descripción

status*enum

Nuevo estado de la ruta

Example: "hold_by_courier"

pending_to_reviewprocessingbroadcastingassignedconfirmed_to_pickupgoing_to_pickupat_pickupon_deliverygoing_to_dropoffat_dropoffdropped_offcompletedcanceledgoing_to_returnat_return_pointreturnednot_picked_upnot_picked_up_payablehold_by_courier

comment*string

Comentario del cambio

Example: "Zona peligrosa"

reasonByCompanyarray of object

Razones predefinidas del cambio de estado

authorobject

Información del usuario que esta realizando el cambio de estado

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Success"

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/deliveries/{id}/status', {
    method: 'PATCH',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "hold_by_courier",
      "comment": "Zona peligrosa"
    }),
});
const data = await response.json();

Response

200401

{
  "code": "OK",
  "message": "Success"
}

Casos de uso

Cambio de estado por referenceId

Puedes utilizar el reference id de la entrega en la url de la petición para cambiar su estado.

Cancelar entrega

{
    "status": "canceled",
    "comment": "TEST",
    "author": {
        "email": "[e-mail]",
        "id": 999,
        "name": "Test operator",
        "type": "operator"
    }
}

Cambiar estado a resguardo del conductor con motivo de problema

{
    "status": "hold_by_courier",
    "comment": "Sur de la ciudad",
    "reasonByCompany": [
        {
            "companyId": "9065",
            "reasonId": 67,
            "reason": "ZONA PELIGROSA"
        }
    ],
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "[e-mail]"
    }
}

Completar entrega

{
    "status": "completed",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "[e-mail]"
    }
}