Cambiar de estado una ruta

Puede utilizar este endpoint para cambiar el estado de todas las entregas de una ruta.

Actualiza el estado de una ruta

patch

Actualiza el estado de una ruta, incluyendo todas sus entregas.

Authorizations

Path parameters

idstringrequired

Identificador de la ruta a cambiar de estado.

Body

statusstring · enumrequired

Nuevo estado de la ruta

Example: hold_by_courier

Available options:

commentstringrequired

Comentario del cambio

Example: Zona peligrosa

reasonByCompanyobject[]optional

Razones predefinidas del cambio de estado

authorobjectoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

200

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

Successful operation

Casos de uso

Cancelar ruta

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

Completar ruta

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