Skip to main content
GET
/
returns
/
{returnShipmentId}
Get return shipment
curl --request GET \
  --url https://api.quivo.co/returns/{returnShipmentId}
{
  "returnShipmentId": 123,
  "warehouseId": 123,
  "returnShipmentIdentifier": "<string>",
  "sellerId": 123,
  "receivedDate": "2023-11-07T05:31:56Z",
  "trackingNumber": "<string>",
  "trackingLink": "<string>",
  "carrierSlug": "<string>",
  "orderId": 123,
  "fulfillmentOrderId": 123,
  "returnAnnouncementId": 123,
  "shipFrom": {
    "name1": "<string>",
    "name2": "<string>",
    "company": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "email": "<string>"
  },
  "returnShipmentReference": "<string>",
  "customerExamined": true,
  "positions": [
    {
      "returnShipmentPositionId": 123,
      "sellerSku": "<string>",
      "warehouseSku": "<string>",
      "name": "<string>",
      "quantity": 123,
      "lot": "<string>",
      "expirationDate": "2023-11-07T05:31:56Z",
      "serialNumbers": [
        "<string>"
      ],
      "classCode": "<string>",
      "classDescription": "<string>",
      "reasonCode": "<string>",
      "reasonDescription": "<string>",
      "positionIdentifier": "<string>",
      "storageCode": "<string>",
      "storageBlocked": true
    }
  ],
  "groupedPositions": [
    {
      "sellerSku": "<string>",
      "warehouseSku": "<string>",
      "name": "<string>",
      "quantity": 123,
      "lot": "<string>",
      "expirationDate": "2023-11-07T05:31:56Z",
      "serialNumbers": [
        "<string>"
      ],
      "classCode": "<string>",
      "classDescription": "<string>",
      "reasonCode": "<string>",
      "reasonDescription": "<string>"
    }
  ],
  "comments": [
    {
      "returnShipmentCommentId": 123,
      "text": "<string>",
      "fileKey": "<string>",
      "url": {
        "link": "<string>"
      },
      "returnShipmentImages": [
        {
          "text": "<string>",
          "fileKey": "<string>",
          "url": {
            "link": "<string>"
          }
        }
      ]
    }
  ],
  "piiDataRemoved": true
}

Path Parameters

returnShipmentId
integer<int64>
required

The unique identifier for a return shipment.

Response

Returns the return shipment details including items and current status.

Complete return shipment information with all details. Contains return identifiers, original order reference, return reason, status, and processing information.

returnShipmentId
integer<int64>

The unique identifier for the returnshipment

warehouseId
integer<int64>

The unique identifier for the warehouse

returnShipmentIdentifier
string

The unique identifier for the returnshipmententifier

sellerId
integer<int64>

The unique identifier for the seller

receivedDate
string<date-time>

The received date date

trackingNumber
string

Tracking information or tracking enabled status

Tracking information or tracking enabled status

carrierSlug
string

Carrier identifier or information

orderId
integer<int64>

The unique identifier for the order

fulfillmentOrderId
integer<int64>

The unique identifier for the fulfillmentorder

returnAnnouncementId
integer<int64>

The unique identifier for the returnannouncement

shipFrom
object

Detailed address information

returnShipmentReference
string

Reference number or identifier for the return shipment

customerExamined
boolean

Customer identifier or information

positions
object[]

Array of position items

groupedPositions
object[]

Array of grouped position

comments
object[]

Comment or notes

piiDataRemoved
boolean

Boolean flag indicating pii data removed