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.

patch

/v1/deliveries/{id}/status

Authorizations

Path parameters

idstringrequired

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

Body

commentstringrequired

Comentario del cambio

Example: Zona peligrosa

statusstring · enumrequired

Nuevo estado de la ruta

Example: hold_by_courier

Options: pending_to_review, processing, broadcasting, assigned, confirmed_to_pickup, going_to_pickup, at_pickup, on_delivery, going_to_dropoff, at_dropoff, dropped_off, completed, canceled, going_to_return, at_return_point, returned, not_picked_up, not_picked_up_payable, hold_by_courier

authorobject

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

reasonByCompanyobject[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.shippify.co/v1/deliveries/{id}/status' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "Zona peligrosa",
    "status": "hold_by_courier",
    "author": {
      "id": 1149,
      "name": "Developers",
      "email": "[e-mail]",
      "type": "operator"
    },
    "reasonByCompany": [
      {
        "reasonId": 67,
        "reason": "ZONA PELIGROSA"
      }
    ]
  }'

200

401

200

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

Successful operation

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