Skip to main content
GET
List return links

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 returnLinkId:>=4000; 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: sellerId, shippingServiceGroupId. The address is flat: shipToAddressCountryIso2, shipToAddressCity, shipToAddressZip, shipToAddressEmail. Examples: shipToAddressCountryIso2:DE AND sellerId:123.

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 link summaries with configuration and usage information.

sellerId
integer<int64>
required

Seller ID.

shippingServiceGroupId
integer<int64>
required

Shipping Service Group ID.
Required shipping service group for which to create a return link.

shipToAddress
object

Detailed address information

id
integer<int64>

The unique identifier for the id

created
string<date-time>

Timestamp when the item was created

deletedAt
string<date-time>

The deleted at timestamp

sort
object

The

Link or URL reference

shippingServiceGroupName
string

The name of the shipping service group