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

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

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

Authorization

Basic_Auth

Path parameters

id*string

Identificador de la ruta a cambiar de estado.

Body

application/json

Aqui va la descripción

status*enum

Nuevo estado de la ruta

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

Comentario del cambio

Example: "Zona peligrosa"

reasonByCompanyarray of object

Razones predefinidas del cambio de estado

authorobject

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

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Success"

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 peligrosa"
    }),
});
const data = await response.json();

Response

200401

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

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