Skip to main content
PUT
Update return link

Path Parameters

The unique identifier for a return link.

Body

application/json

Complete resource data to update at /returnLinks/{returnLinkId}

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

200 - application/json

Returns the updated return link with current configuration.

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