Returns

GET returns

Query parameters

No changes

Response message

Table 1. Changed fields in response
Change v3 field name v5 field name Remarks

Introduced

returnId

Introduced

returnItems (object)

Introduced

processingResults (object)

Moved and changed

rmaId

returnItems.rmaId

Type changed to string

Moved

orderId

returnItems.orderId

Moved

ean

returnItems.ean

Introduced

returnItems.expectedQuantity

Moved and changed

returnReason

returnItems.returnReason

Type changed to object

Introduced

returnReason.mainReason

Introduced

returnReason.detailedReason

Introduced

returnReason.customerComments

Removed

returnItems.returnReasonComments

Moved

handled

returnItems.handled

Moved

quantity

processingResults.quantity

Moved

processingResult

processingResults.processingResult

Moved

handlingResult

processingResults.handlingResult

Moved

processingDateTime

processingResults.processingDateTime

Changed

returnId

Changed to string

GET a return by return id

Path parameters

Table 2. Changed path parameters
Change v3 field name v5 field name Remarks

Changed

rma-id

return-id

Changed primary identifier and changed type to string

Response message

Table 3. Changed fields in response
Change v3 field name v5 field name Remarks

Introduced

returnId

Introduced

returnItems (object)

Introduced

returnItems.processingResults (object)

Moved

customerDetails

returnItems.customerDetails

Moved and changed

rmaId

returnItems.rmaId

Type changed to string

Moved

orderId

returnItems.orderId

Moved

ean

returnItems.ean

Moved

title

returnItems.title

Introduced

returnItems.expectedQuantity

Moved and changed

returnReason

returnItems.returnReason

Type changed to object

Introduced

returnItems.returnReason.mainReason

Introduced

returnItems.returnReason.detailedReason

Introduced

returnItems.returnReason.customerComments

Removed

returnItems.returnReasonComments

Moved

handled

returnItems.handled

Moved

trackAndTrace

returnItems.trackAndTrace

Introduced

returnItems.transporterName

Moved

quantity

returnItems.processingResults.quantity

Moved

processingResult

returnItems.processingResults.processingResult

Moved

handlingResult

returnItems.processingResults.handlingResult

Moved

processingDateTime

returnItems.processingResults.processingDateTime

Removed

customerDetails.pickUpPointName

Removed

customerDetails.chamberOfCommerceNumber

Removed

customerDetails.orderReference

Removed

returnItems.customerDetails.addressSupplement

Changed

returnItems.returnReason

Type changed to object

Removed

returnItems.customerDetails.addressSupplement

POST create return

This endpoint was introduced in V4. See the Returns documentation for more information.

PUT handle return

Response message

Table 4. Changed fields in response
Change v3 field name v5 field name Remarks

Changed and renamed

id

processStatusId

Changed to string

Back to Reductions

Continue to Shipments