Cancelar um orçamento

POSThttps://carchost.fieldcontrol.com.br/quotations/{id}/cancel

Cancela um orçamento pendente. A resposta de sucesso usa o status 201.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição

Parâmetros de caminho

idstringobrigatório

Identificador do orçamento.

Exemplo: YmIwYzk1ZGMtYzNhYi00YmQ4LTkxNjEtZDVjNTU1ZTQxNTQwOjIyOTE1.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

canceledAtstring

Data do cancelamento (ISO 8601), que não pode ser futura. Padrão é o momento da requisição.

Aceita: null.

Respostas

• 201

  Orçamento cancelado.

• 401

  Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

• 403

  Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

• 422

  Orçamento inexistente (reason: not found; não há 404), situação que não permite cancelar (reason: invalid status transition) ou data inválida ou futura (resourceValidationErr). Um orçamento já cancelado é retornado sem alteração.

• 429

  Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

• 500

  Erro inesperado no servidor.