Cambiar el estado de una entrega

Puedes utilizar este endpoint para cambiar el estado a una entrega.

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

Endpoint

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

Request

Parámetros

PropiedadTipoDescripciónObligatorioRestricciones

id

string

Id de la tarea creada en el sistema

SI

Body

PropiedadTipoDescripciónObligatorioRestricciones

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

PropiedadTipoDescripción

code

string

Código del resultado.

message

string

Descripción del resultado.

Ejemplo

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 '{
    "status": "processing",
    "comment": "TEST",
    "author": {
        "email": "test@shippify.co",
        "id": 999,
        "name": "Test operator",
        "type": "operator"
    }
}'

Última actualización