Alteração de estado da rota

Você pode usar este endpoint para alterar o estado de todas as entregas de uma rota.

Atualiza o estado de uma rota

Atualiza o estado de uma rota, incluindo todas suas entregas.

patch

/v1/routes/{id}/status

Authorizations

Path parameters

idstringrequired

Identificador da rota a alterar o estado.

Body

commentstringrequired

Comentário da alteração

Example: Zona de perigo.

statusstring · enumrequired

Novo estado da rota.

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

Informação do usuário que esta fazendo a alteração.

reasonByCompanyobject[]

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 '{
    "comment": "Zona de perigo.",
    "status": "hold_by_courier",
    "author": {
      "id": 1149,
      "name": "Developers",
      "email": "[e-mail]",
      "type": "operador"
    },
    "reasonByCompany": [
      {
        "reasonId": 67,
        "reason": "ZONA  DE PERIGO"
      }
    ]
  }'

200

401

200

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

Operação bem sucedida.

Casos de uso

Cancelar rota

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

Completar rota

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