Alterar estados de entrega

Você pode utilizar este endpoint para alterar o status de uma entrega, aqui você pode adicionar comentários ou incluir razões para problemas criados anteriormente no sistema. Para saber mais sobre os status do Shippify entre aqui.

Atualizar o status de uma entrega

patch

Update the status of a delivery by its ID or reference.

Autorizaciones

Parámetros de ruta

idstringRequerido

Identifier or reference ID of the delivery to change status.

Cuerpo

statusstring · enumRequerido

Novo status da rota

Example: hold_by_courierValores posibles:

commentstringRequerido

Comentário da mudança

Example: Dangerous area

Respuestas

200

Operação bem-sucedida

application/json

401

Não autorizado

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/deliveries/{id}/status HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "status": "hold_by_courier",
  "comment": "Dangerous area",
  "reasonByCompany": [
    {
      "reasonId": 67,
      "reason": "DANGEROUS AREA"
    }
  ],
  "author": {
    "type": "operator",
    "id": 1149,
    "name": "Developers",
    "email": "[email protected]"
  }
}

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

Casos de uso

Alteração de estado por referenceId

Utilize o referenceid da entrega na url da petição para alterar o estado.

Cancelar entrega

{
    "status": "canceled",
    "comment": "TEST",
    "author": {
        "email": "[email protected]",
        "id": 999,
        "name": "Test operator",
        "type": "operator"
    }
}

Alterar estado à em posse do motorista baseado nos motivos e problemas

{
    "status": "hold_by_courier",
    "comment": "Sul da cidade",
    "reasonByCompany": [
        {
            "companyId": "9065",
            "reasonId": 67,
            "reason": "ZONA DE PERIGO"
        }
    ],
    "author": {
        "type": "operator",
        "id": 1149,
        "name": "Developers",
        "email": "[email protected]"
    }
}

Completar entrega

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