Mudar o status de uma rota

Você pode usar esse endpoint para alterar o status de todas as entregas em uma rota.

Para cancelar a rota, você pode usar este endpoint com o status cancelado.

Endpoint

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

Request

Parâmetro

PropriedadeTipoDescriçãoObrigatórioRestrições

id

string

ID da rota criada dentro do sistema.

SIM

Body

PropriedadeTipoDescriçãoObrigatórioRestrição

status

string

Código de status que você deseja alterar.

YES

Você pode ver todos os códigos de status nesta tabela. Status da entrega

comment

string

Breve descrição da mudança.

YES

author

object

Informações do operador que fez a mudança.

YES

Response

PropriedadeTipoDescrição

code

string

Resultado do código.

message

string

Descrição do resultado.

Example

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": "developers@shippify.co"
  },
  "status": "assigned",
  "comment": "e"
}'