Skip to main content
GET
/
returnLinks
List return links
curl --request GET \
  --url https://api.quivo.co/returnLinks
[
  {
    "sellerId": 123,
    "shippingServiceGroupId": 123,
    "shipToAddress": {
      "name1": "<string>",
      "name2": "<string>",
      "company": "<string>",
      "address1": "<string>",
      "address2": "<string>",
      "address3": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "phone": "<string>",
      "email": "<string>"
    },
    "id": 123,
    "created": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "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
    },
    "returnLink": "<string>",
    "shippingServiceGroupName": "<string>"
  }
]

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

​
returnLink
string

Link or URL reference

​
shippingServiceGroupName
string

The name of the shipping service group