⚠️

Atenção

Caso o cancelamento seja realizado antes de um entregador aceitar a corrida, não haverá cobrança.

Caso o pedido seja cancelado antes da chegada do entregador ao ponto de coleta, será cobrado o valor mínimo da entrega, conforme tabela vigente.

Caso contrário, a cobrança será feita de acordo com o ponto de destino seguinte ao ponto do cancelamento, haja vista que, por segurança, não é possível avisar o entregador sobre o cancelamento quando ele estiver se deslocando entre um ponto e outro.

Exemplo: em um pedido de 03 (três) pontos (A, B e C), se a entrega for cancelada entre os pontos A e B, a cobrança é feita até o ponto B e não será cobrado o deslocamento até o ponto C, que não ocorrerá; porém, caso o entregador já tenha se retirado do ponto B em direção ao ponto C, será cobrado o valor total do pedido.

⚠️

Atenção

Caso o cliente queira cancelar pacotes/pontos de parada em um pedido de múltiplos pacotes, mas não deseje cancelar o pedido inteiro, é necessário acionamento via URA.

Caso a rota esteja em andamento, mas o entregador ainda não tenha ido até o ponto em questão, o cliente pode solicitar a exclusão do ponto de entrega e adicionar um ponto de retorno (caso ainda não tenha) para devolução do pacote (caso tenha sido coletado).

Requisição

Substitua as variáveis e use esta consulta:

mutation {
  cancelOrder(input: { id: PK_ORDER }) {
    success
    order {
      status
      pk
    }    
    errors {
      field
      message
    }
  }
}

Argumentos

📘

Identificador do pedido

O id é obtido na resposta da criação do pedido no campo orders.pk.

NomeTipoDescriçãoExemplo
idIntIdentificador do pedido.47950616

Exemplo

mutation {
  cancelOrder(input: { id: 47950889 }) {
    success
    order {
      status
      pk
    }    
    errors {
      field
      message
    }
  }
}

Resposta

Campos

NomeTipoDescrição
successBoolInforma se o pedido foi cancelado com sucesso.
orderOrderInformações do pedido.
errorsErrorContém informações caso algum erro aconteça.

Order

NomeTipoDescrição
statusStringInforma se o pedido foi cancelado com ou sem cobrança.
pkIntIdentificador do pedido.

Error

NomeTipoDescrição
fieldStringNome do argumento com erro.
messageStringMensagem de erro.

Exemplos

Sucesso

{
   "data":{
      "cancelOrder":{
         "success":true,
         "order":{
           "status":"cancelledWithCharge",
            "pk":47984756
         },
         "errors":null
      }
   }
}

Erros

Pedido não existe

{
   "data":{
      "cancelOrder":{
        "success":false,
         "order":null,         
         "errors":null
      }
   }
}

Pedido já cancelado

{
   "data":{
      "cancelOrder":{
        "success":false,
         "order":{
            "status":"cancelledWithCharge",
            "pk":47984756
         },         
         "errors":[
            {
               "message":"Este pedido já foi finalizado."
            }
         ]
      }
   }
}