Skip to main content
GET
/
returns
List return shipments
curl --request GET \
  --url https://api.quivo.co/returns
[
  {
    "warehouseId": 123,
    "returnShipmentIdentifier": "<string>",
    "sellerId": 123,
    "returnShipmentId": 123,
    "orderId": 123,
    "fulfillmentOrderId": 123,
    "returnAnnouncementId": 123,
    "receivedDate": "2023-11-07T05:31:56Z",
    "shipFromCountry": "<string>",
    "shipFromZip": "<string>",
    "shipFromCompany": "<string>",
    "shipFromName1": "<string>",
    "shipFromName2": "<string>",
    "sort": {
      "short": true,
      "nodeType": "ARRAY",
      "float": true,
      "binary": true,
      "number": true,
      "integralNumber": true,
      "boolean": true,
      "double": true,
      "long": true,
      "int": true,
      "valueNode": true,
      "containerNode": true,
      "missingNode": true,
      "object": true,
      "pojo": true,
      "floatingPointNumber": true,
      "bigDecimal": true,
      "bigInteger": true,
      "textual": true,
      "array": true,
      "null": true
    },
    "trackingLink": "<string>",
    "trackingNumber": "<string>",
    "carrierSlug": "<string>",
    "returnShipmentReference": "<string>",
    "customerExamined": true,
    "positions": [
      {
        "sellerSku": "<string>",
        "warehouseSku": "<string>",
        "name": "<string>",
        "quantity": 123,
        "classCode": "<string>",
        "lot": "<string>",
        "expirationDate": "2023-11-07T05:31:56Z",
        "serialNumbers": [
          "<string>"
        ],
        "reasonCode": "<string>",
        "reasonDescription": "<string>",
        "classDescription": "<string>",
        "positionIdentifier": "<string>"
      }
    ],
    "groupedPositions": [
      {
        "sellerSku": "<string>",
        "warehouseSku": "<string>",
        "name": "<string>",
        "quantity": 123,
        "classCode": "<string>",
        "lot": "<string>",
        "expirationDate": "2023-11-07T05:31:56Z",
        "serialNumbers": [
          "<string>"
        ],
        "reasonCode": "<string>",
        "reasonDescription": "<string>",
        "classDescription": "<string>"
      }
    ],
    "piiDataRemoved": true
  }
]

Query Parameters

​
query
string

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

​
sort
string

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

​
page
integer<int64>

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

​
searchAfter
string

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

​
pageSize
integer<int64>

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

Returns an array of return shipment summaries with status and tracking information.

​
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

​
returnShipmentId
integer<int64>

The unique identifier for the returnshipment

​
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

​
receivedDate
string<date-time>

The received date date

​
shipFromCountry
string

Country code or name

​
shipFromZip
string

ZIP or postal code

​
shipFromCompany
string

Company name

​
shipFromName1
string

The name of the ship from

​
shipFromName2
string

The name of the ship from

​
sort
object

The

​
trackingLink
string

Tracking information or tracking enabled status

​
trackingNumber
string

Tracking information or tracking enabled status

​
carrierSlug
string

Carrier identifier or 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

​
piiDataRemoved
boolean

Boolean flag indicating pii data removed