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

patch

Actualizar el estado de una entrega por su ID o referencia.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Parámetros de ruta

idstringRequerido

Identificador o ID de referencia de la entrega para cambiar el estado.

Cuerpo

application/json

statusstring · enumRequerido

Nuevo estado de la ruta

Example: hold_by_courierValores posibles:

commentstringRequerido

Comentario del cambio

Example: Dangerous area

Respuestas

200

Operación exitosa

application/json

401

No autorizado

application/json

patch

/v1/deliveries/{id}/status

HTTPcURLJavaScriptPython

PATCH /v1/deliveries/{id}/status HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "status": "hold_by_courier",
  "comment": "Dangerous area",
  "reasonByCompany": [
    {
      "reasonId": 67,
      "reason": "DANGEROUS AREA"
    }
  ],
  "author": {
    "type": "operator",
    "id": 1,
    "name": "Juan Perez",
    "email": "[email protected]"
  }
}

{
  "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": "[email protected]",
        "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": "example",
        "email": "[email protected]"
    }
}

Completar entrega

{
    "status": "completed",
    "comment": "",
    "author": {
        "type": "operator",
        "id": 1,
        "name": "example",
        "email": "[email protected]"
    }
}