GET /sale-returns/{id}.json

GET /sale-returns/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes 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

    • 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.

    • notes string | null

      Notes

    • 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) | null

      Purchase

    • quoteId string | null

      Quote

    • reference string Required

      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 Required

      Return label type

      Values are prePaid or paid. Default value is prePaid.

    • 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) Required

      Sale

    • saleReturnSource string | null Required

      Sale return source

      Values are internal or external. Default value is internal.

    • saleReturnType string | null

      Sale return type

      Values are automated, customer, dropship_provider, or merchant.

    • serviceLevel string | null

      Service level

    • serviceLevelTerms string | null

      Service level terms

    • shippoLabelIds array[string] | null

      Shippo label ids

    • status string Required

      Status

      Values are draft, requested, finalized, 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

    • userId integer(int32) | null

      User

    • vendorCancelledAt string(date-time) | null

      Vendor cancelled at

    • vendorReceivedId string | null

      Vendor received

    • vendorReceivedStatus string | null Required

      Vendor received status

      Values are notSent, received, or error. Default value is notSent.

GET /sale-returns/{id}.json
curl \
 --request GET 'http://api.example.com/v1/sale-returns/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "adminNotes": "string",
  "aftershipId": "string",
  "commercialInvoiceUrl": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "days": 42,
  "dropshipProviderAddressId": 42,
  "durationTerms": "string",
  "externalId": "string",
  "files": {},
  "grams": 0,
  "id": 42,
  "intercomMessageId": "string",
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelRefund": false,
  "labelUrl": "string",
  "muteError": false,
  "notes": "string",
  "paid": 0,
  "paymentStatus": "notPaid",
  "price": 0,
  "provider": "string",
  "purchaseId": 42,
  "quoteId": "string",
  "reference": "string",
  "returnAddressLineOne": "string",
  "returnAddressLineTwo": "string",
  "returnCity": "string",
  "returnCountry": "string",
  "returnFirstName": "string",
  "returnLabelType": "prePaid",
  "returnLastName": "string",
  "returnName": "string",
  "returnShipmentId": 42,
  "returnState": "string",
  "returnZip": "string",
  "saleId": 42,
  "saleReturnSource": "internal",
  "saleReturnType": "automated",
  "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",
  "userId": 42,
  "vendorCancelledAt": "2025-05-04T09:42:00Z",
  "vendorReceivedId": "string",
  "vendorReceivedStatus": "notSent"
}