PUT /purchase-returns/{id}.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

application/json

Body Required

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
durationTerms string | null

Duration terms
externalId string | null

External
grams number | null Required

Grams

Default value is 0.
id integer(int32)

Id
intercomMessageId string | null

Intercom message
labelError string | null

Label error
labelFileFormat string | null

Label file format

Values are png or pdf.
labelRefund boolean | null Required

Label refund

Default value is false.
labelUrl string | null

Label url
muteError boolean | null Required

Mute error

Default value is false.
paid number Required

Paid

Default value is 0.
paymentStatus string Required

Payment status

Values are notPaid, partiallyPaid, or paid. Default value is notPaid.
price number | null Required

Price

Default value is 0.
provider string | null

Provider
purchaseId integer(int32) Required

Purchase
quoteId string | null

Quote
reference string Required

Reference
serviceLevel string | null

Service level
serviceLevelTerms string | null

Service level terms
shippoLabelIds array[string] | null

Shippo label ids
status string Required

Status

Values are requested, shipped, received, or cancelled. Default value is requested.
tags array[string] | null

Tags
trackingCompany string | null

Tracking company
trackingNumber string | null

Tracking number
trackingStatus string | null

Tracking status

Values are delivered, failure, pre_transit, returned, transit, or unknown.
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

PUT /purchase-returns/{id}.json

curl \
 --request PUT 'http://api.example.com/v1/purchase-returns/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"adminNotes":"string","aftershipId":"string","commercialInvoiceUrl":"string","createdAt":"2025-05-04T09:42:00Z","days":42,"durationTerms":"string","externalId":"string","grams":0,"id":42,"intercomMessageId":"string","labelError":"string","labelFileFormat":"png","labelRefund":false,"labelUrl":"string","muteError":false,"paid":0,"paymentStatus":"notPaid","price":0,"provider":"string","purchaseId":42,"quoteId":"string","reference":"string","serviceLevel":"string","serviceLevelTerms":"string","shippoLabelIds":["string"],"status":"requested","tags":["string"],"trackingCompany":"string","trackingNumber":"string","trackingStatus":"delivered","trackingStatusDate":"2025-05-04T09:42:00Z","trackingStatusDetails":"string","trackingUrl":"string","updatedAt":"2025-05-04T09:42:00Z"}'

Request examples

{
  "adminNotes": "string",
  "aftershipId": "string",
  "commercialInvoiceUrl": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "days": 42,
  "durationTerms": "string",
  "externalId": "string",
  "grams": 0,
  "id": 42,
  "intercomMessageId": "string",
  "labelError": "string",
  "labelFileFormat": "png",
  "labelRefund": false,
  "labelUrl": "string",
  "muteError": false,
  "paid": 0,
  "paymentStatus": "notPaid",
  "price": 0,
  "provider": "string",
  "purchaseId": 42,
  "quoteId": "string",
  "reference": "string",
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shippoLabelIds": [
    "string"
  ],
  "status": "requested",
  "tags": [
    "string"
  ],
  "trackingCompany": "string",
  "trackingNumber": "string",
  "trackingStatus": "delivered",
  "trackingStatusDate": "2025-05-04T09:42:00Z",
  "trackingStatusDetails": "string",
  "trackingUrl": "string",
  "updatedAt": "2025-05-04T09:42:00Z"
}