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.

Atualiza o estado de uma entrega

Atualiza o estado de uma entrega seja pelo id da entrega ou id de referência.

patch

/v1/deliveries/{id}/status

Authorizations

Path parameters

idstringrequired

Identificador do Id de referência da entrega a mudar de estado.

Body

statusstring · enumrequired

Novo estado da rota.

Example: hold_by_courier

Options: pending_to_review, processing, broadcasting, assigned, confirmed_to_pickup, going_to_pickup, at_pickup, on_delivery, going_to_dropoff, at_dropoff, dropped_off, completed, canceled, going_to_return, at_return_point, returned, not_picked_up, not_picked_up_payable, hold_by_courier

commentstringrequired

Comentário da alteração

Example: Zona de perigo.

reasonByCompanyobject[]

Motivos predefinidos da alteração de estado.

authorobject

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.shippify.co/v1/deliveries/{id}/status' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "hold_by_courier",
    "comment": "Zona de perigo.",
    "reasonByCompany": [
      {
        "reasonId": 67,
        "reason": "ZONA  DE PERIGO"
      }
    ],
    "author": {
      "type": "operador",
      "id": 1149,
      "name": "Developers",
      "email": "[e-mail]"
    }
  }'

200

401

200

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

Operação bem sucedida

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": "[e-mail]",
        "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": "[e-mail]"
    }
}

Completar entrega

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