Cambiar el estado de una ruta

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

Para cancelar la ruta puedes utilizar este endpoint con el estado cancelado.

Endpoint

PATCH {{SHIPPIFY_API_URL}}/v1/routes/:id/status

Request

Parámetros

Propiedad	Tipo	Descripción	Obligatorio	Restricciones
id	string	Id de la ruta creada en el sistema	SI

Body

Propiedad	Tipo	Descripción	Obligatorio	Restricciones
status	string	Código del estado al que deseas cambiar.	SI	Puedes ver el código de cada estado en esta tabla.Estados
comment	string	Breve descripción del cambio.	SI
author	objeto	Información del operador que realiza el cambio.	SI

Response

Propiedad	Tipo	Descripción
code	string	Código del resultado.
message	string	Descripción del resultado.

Ejemplo

Request

curl --location --request PATCH 'https://api.shippify.co/v1/deliveries/t-pruaas-4973/status' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--header 'Cookie: locale=es' \
--data-raw '{
  "author": {
    "type": "operator",
    "id": 1149,
    "name": "Developers",
    "email": "[e-mail]"
  },
  "status": "assigned",
  "comment": "e"
}'

200 Success

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