Skip to main content
GET
/
returnLinks
/
{returnLinkId}
Get return link
curl --request GET \
  --url https://api.quivo.co/returnLinks/{returnLinkId}
{
  "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>"
  },
  "defaultWeightKG": 123,
  "weightInputVisible": true,
  "id": 123,
  "created": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "returnLink": "<string>",
  "shippingServiceGroupName": "<string>"
}

Path Parameters

The unique identifier for a return link.

Response

Returns the return link details including configuration and access URL.

Return link configuration and details. Contains link validity, return conditions, associated order filters, and usage statistics.

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

defaultWeightKG
number

Default weight in KG.

weightInputVisible
boolean

Indicates if weight input should be visible.

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

Link or URL reference

shippingServiceGroupName
string

The name of the shipping service group