Mudar o status de uma entrega

Você pode usar esse endpoint para mudar o status de uma entrega.

Para cancelar uma tarefa você pode usar esse endpoint com o status de cancelado.

Endpoint

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

Request

Parâmetros

Propriedade	Tipo	Descrição	Obrigatório	Restrições
id	string	ID da tarefa criada dentro do sistema.	SIM

Body

Propriedade	Tipo	Descrição	Obrigatório	Restrições
status	string	Código de status que você deseja alterar.	SIM	Você pode ver todos os códigos de status nesta tabela.Status da entrega
comment	string	Breve descrição da mudança.	SIM
author	object	Informações do operador que fez a mudança.	SIM

Response

Propriedade	Tipo	Descrição
code	string	Resultado do código.
message	string	Descrição do resultado.

Exemplo

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 '{
    "status": "processing",
    "comment": "TEST",
    "author": {
        "email": "[e-mail]",
        "id": 999,
        "name": "Test operator",
        "type": "operator"
    }
}'

200 Success

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