Skip to main content

Cancel a quotation

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

Cancels a pending quotation. The success response uses status 201.

Requires the X-Api-Key, User-Agent and Content-Type: application/json headers. Limit: 1 request per second (learn more).

Request​

Path parameters

idstringrequired

Quotation identifier.

Example: YmIwYzk1ZGMtYzNhYi00YmQ4LTkxNjEtZDVjNTU1ZTQxNTQwOjIyOTE1.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

JSON, sent with the Content-Type: application/json header.

canceledAtstring

Cancellation date (ISO 8601), which cannot be in the future. Defaults to the moment of the request.

Accepts: null.

Responses

  • 201

    Quotation canceled.

  • 401

    API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

  • 403

    Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

  • 422

    Nonexistent quotation (reason: not found; there is no 404), status that does not allow canceling (reason: invalid status transition) or invalid or future date (resourceValidationErr). A quotation that is already canceled is returned unchanged.

  • 429

    Limit of 1 request per second exceeded. See Rate limit.

  • 500

    Unexpected server error.