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.

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

Authorization

Basic_Auth

Path parameters

id*string

Identificador da rota a alterar o estado.

Body

application/json

Aqui vai a descrição.

status*enum

Novo estado da rota.

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

Comentário da alteração

Example: "Zona de perigo."

reasonByCompanyarray of object

Motivos predefinidos da alteração de estado.

authorobject

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

Response

200401

Operação bem sucedida.

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Successo"

Request

JavaScriptCurlPython

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

Response

200401

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

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