Skip to main content
POST
/
returnLinks
Create return link
curl --request POST \
  --url https://api.quivo.co/returnLinks \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'
{
  "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>"
}

Body

application/json

Data to create a new resource at /returnLinks

Request payload for creating a new return link. Contains return link configuration including validity period, return conditions, and associated order filters.

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.

Response

Returns the newly created return link with assigned identifier and URL details.

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