Skip to main content
GET
List return shipments

Authorizations

Authorization
string
header
required

Access token from POST /v2/oauth2/token, requested with an API credential. See https://api-docs.quivo.co/api-reference/authentication.

Query Parameters

query
string

Elasticsearch query string: field:value, joined with AND by default; AND/OR/NOT in upper case; quotes around values with spaces, / or :; * wildcards; ranges like receivedDate:[2026-10-01 TO 2026-10-31] or receivedDate:>=now-30d; exists:field. A condition on a wrong field name matches nothing and gives no error, so OR still returns the other matches and NOT drops nothing, which widens the result. Guide: https://api-docs.quivo.co/docs/quivo-guides/using-queries. Fields include: trackingNumber, returnShipmentReference, returnShipmentIdentifier, orderId, sellerId, warehouseId, receivedDate, customerExamined, senderAddressCountryIso2. Examples: receivedDate:[2026-10-01 TO 2026-10-31] AND sellerId:123; trackingNumber:1234567890.

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

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

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