# Cancel a Quote Request

**PATCH /requests/{request_id}/cancel**

Cancels an in_progress Quote Request resource. This is useful to indicate to Arta that you no longer require custom quotes for a request.


## Servers
- https://api.arta.io: https://api.arta.io ()



## Parameters
### Headers
- **Authorization** (string)
  Authorize your API calls with an Arta API token

### Path parameters
- **request_id** (string)
  request_id parameter



## Responses
### 200
Successful Request get response
#### Headers
- **content-type** (string)

- **x-arta-request-id** (string)
  A unique identifier for the Arta API call

#### Body: application/json (object)
- **additional_services** (array[string])
  Any desired services, such as unpacking, installation, etc. can be sent through in the request and will be treated as if that requested service is required. Requested services may disqualify certain segments of shipping services offered by Arta depending on location and object details.
- **bookable** (object)

- **created_at** (string)
  A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision
- **currency** (string)
  ISO 4217 three-letter alphabetic currency code. Options are defined in the Currencies metadata endpoint
- **destination** (object)

- **disqualifications** (array[object])
  The list of reasons for which particular quote types were disqulified
- **hosted_session_id** (integer | null)
  The ID of the HostedSession through which this shipment was created
- **id** (string)

- **insurance** (string | null)
  The id of an insurance type. If requesting Arta insurance, object values must be provided.
- **internal_reference** (string | null)
  This field can be used to pass through any data about the request you may want returned unaltered for your own later usage
- **log_request_id** (string)
  The request ID for the API call that created the resource. This request ID maps to the Log resource's "request_id" field
- **object_count** (number)
  The count of objects included in the initial request payload
- **objects** (array[object])
  A list of objects to be shipped
- **origin** (object)

- **payment_process** (string)
  The primary method by which payment to Arta will be handled for any shipment booked from this request
- **preferred_parcel_transport_services** (array[string] | null)
  Optionally instruct the Arta API to filter Parcel and Self Ship quotes for specific transport services. For example, if you would prefer to only return `ground` quotes, you can set this field to `["ground"]` The list of valid transport service IDs is available at the /metadata/parcel_transport_services endpoint.
- **preferred_quote_types** (array[string])
  An optional field presenting the list of quote types the caller instructed Arta to return as part of the quote request
- **public_reference** (string | null)
  A client defined name for the resource. The value provided for the public_reference field may appear in notification emails and public web pages
- **quote_types** (array[string])
  The list of quote types returned as part of the quotes in this quote request
- **quotes** (array[object])
  The list of quotes returned for the request
- **quoting_strategy** (string)
  The quoting strategy used when creating quotes for this request. Determines whether the API returns a single best-rate option per transport speed or multiple carrier options for comparison. If not specified, the default strategy (“best_rate”) will be applied.
- **shipping_notes** (string | null)
  This field can be used to pass through any notes to Arta that a customer might want to provide about the request
- **shortcode** (string)
  A brief and unique string identifier for the resource
- **status** (string)

- **tags** (array[object])
  A list of tags associated with this request
- **updated_at** (string)
  A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision

### 404
Not Found
#### Headers
- **content-type** (string)

- **x-arta-request-id** (string)
  A unique identifier for the Arta API call

#### Body: application/json (object)
- **errors** (object)



[Powered by Bump.sh](https://bump.sh)