# PUT /purchases/{id}/cancel.json

**PUT /purchases/{id}/cancel.json**




## Servers
- http://api.example.com/v1: http://api.example.com/v1 ()


## Authentication methods
- Bearer auth


## Parameters

### Path parameters
- **id** (integer(int64))
  Numeric ID of the instance


### Body: application/json (object)

- **adminNotes** (string | null)
  Admin notes
- **aftershipId** (string | null)
  Aftership
- **commercialInvoiceUrl** (string | null)
  Commercial invoice url
- **createdAt** (string(date-time))
  Created at
- **days** (integer(int32) | null)
  Days
- **dropshipProviderAddressId** (integer(int32) | null)
  Dropship provider address
- **durationTerms** (string | null)
  Duration terms
- **externalId** (string | null)
  External
- **files** (object | null | array | boolean | integer | number | string)
  Files
- **grams** (number | null)
  Grams
- **id** (integer(int32))
  Id
- **intercomMessageId** (string | null)
  Intercom message
- **labelError** (string | null)
  Label error
- **labelFileFormat** (string | null)
  Label file format
- **labelFiles** (object | null | array | boolean | integer | number | string)
  Label files
- **labelRefund** (boolean | null)
  Label refund
- **labelUrl** (string | null)
  Label url
- **muteError** (boolean | null)
  Mute error
- **notes** (string | null)
  Notes
- **paid** (number)
  Paid
- **paymentStatus** (string)
  Payment status
- **price** (number | null)
  Price
- **provider** (string | null)
  Provider
- **purchaseId** (integer(int32) | null)
  Purchase
- **quoteId** (string | null)
  Quote
- **reference** (string)
  Reference
- **returnAddressLineOne** (string | null)
  Return address line one
- **returnAddressLineTwo** (string | null)
  Return address line two
- **returnCity** (string | null)
  Return city
- **returnCountry** (string | null)
  Return country
- **returnFirstName** (string | null)
  Return first name
- **returnLabelType** (string | null)
  Return label type
- **returnLastName** (string | null)
  Return last name
- **returnName** (string | null)
  Return name
- **returnShipmentId** (integer(int32) | null)
  Return shipment
- **returnState** (string | null)
  Return state
- **returnZip** (string | null)
  Return zip
- **saleId** (integer(int32))
  Sale
- **saleReturnSource** (string | null)
  Sale return source
- **saleReturnType** (string | null)
  Sale return type
- **serviceLevel** (string | null)
  Service level
- **serviceLevelTerms** (string | null)
  Service level terms
- **shippoLabelIds** (array[string] | null)
  Shippo label ids
- **status** (string)
  Status
- **tags** (array[string] | null)
  Tags
- **trackingCompany** (string | null)
  Tracking company
- **trackingNumber** (string | null)
  Tracking number
- **trackingStatus** (string | null)
  Tracking status
- **trackingStatusDate** (string(date-time) | null)
  Tracking status date
- **trackingStatusDetails** (string | null)
  Tracking status details
- **trackingUrl** (string | null)
  Tracking url
- **updatedAt** (string(date-time))
  Updated at
- **userId** (integer(int32) | null)
  User
- **vendorCancelledAt** (string(date-time) | null)
  Vendor cancelled at
- **vendorReceivedId** (string | null)
  Vendor received
- **vendorReceivedStatus** (string | null)
  Vendor received status


## Responses
### 200
Successful response

#### Body: application/json (object)
- **adminNotes** (string | null)
  Admin notes
- **aftershipId** (string | null)
  Aftership
- **commercialInvoiceUrl** (string | null)
  Commercial invoice url
- **createdAt** (string(date-time))
  Created at
- **days** (integer(int32) | null)
  Days
- **dropshipProviderAddressId** (integer(int32) | null)
  Dropship provider address
- **durationTerms** (string | null)
  Duration terms
- **externalId** (string | null)
  External
- **files** (object | null | array | boolean | integer | number | string)
  Files
- **grams** (number | null)
  Grams
- **id** (integer(int32))
  Id
- **intercomMessageId** (string | null)
  Intercom message
- **labelError** (string | null)
  Label error
- **labelFileFormat** (string | null)
  Label file format
- **labelFiles** (object | null | array | boolean | integer | number | string)
  Label files
- **labelRefund** (boolean | null)
  Label refund
- **labelUrl** (string | null)
  Label url
- **muteError** (boolean | null)
  Mute error
- **notes** (string | null)
  Notes
- **paid** (number)
  Paid
- **paymentStatus** (string)
  Payment status
- **price** (number | null)
  Price
- **provider** (string | null)
  Provider
- **purchaseId** (integer(int32) | null)
  Purchase
- **quoteId** (string | null)
  Quote
- **reference** (string)
  Reference
- **returnAddressLineOne** (string | null)
  Return address line one
- **returnAddressLineTwo** (string | null)
  Return address line two
- **returnCity** (string | null)
  Return city
- **returnCountry** (string | null)
  Return country
- **returnFirstName** (string | null)
  Return first name
- **returnLabelType** (string | null)
  Return label type
- **returnLastName** (string | null)
  Return last name
- **returnName** (string | null)
  Return name
- **returnShipmentId** (integer(int32) | null)
  Return shipment
- **returnState** (string | null)
  Return state
- **returnZip** (string | null)
  Return zip
- **saleId** (integer(int32))
  Sale
- **saleReturnSource** (string | null)
  Sale return source
- **saleReturnType** (string | null)
  Sale return type
- **serviceLevel** (string | null)
  Service level
- **serviceLevelTerms** (string | null)
  Service level terms
- **shippoLabelIds** (array[string] | null)
  Shippo label ids
- **status** (string)
  Status
- **tags** (array[string] | null)
  Tags
- **trackingCompany** (string | null)
  Tracking company
- **trackingNumber** (string | null)
  Tracking number
- **trackingStatus** (string | null)
  Tracking status
- **trackingStatusDate** (string(date-time) | null)
  Tracking status date
- **trackingStatusDetails** (string | null)
  Tracking status details
- **trackingUrl** (string | null)
  Tracking url
- **updatedAt** (string(date-time))
  Updated at
- **userId** (integer(int32) | null)
  User
- **vendorCancelledAt** (string(date-time) | null)
  Vendor cancelled at
- **vendorReceivedId** (string | null)
  Vendor received
- **vendorReceivedStatus** (string | null)
  Vendor received status


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