Announced returns

Introduction

An announced return is a return that has been registered in the shop system by the customer before the physical package arrives at the facility.

The return announcement is transferred from the shop and an ItemReturn is created in the associated ItemReturnJob with the status ANNOUNCED . Announced returns include the items and details provided by the customer, such as return reason and item condition.

These details are made available in the Backoffice and the Returns app, where announced returns can be searched for, optionally using a barcode from the return label if provided. Furthermore, the user is able to check and, if necessary, edit those details and confirm the return.

When confirming the return, the status changes from ANNOUNCED to COMPLETED, and no further changes are possible after confirmation.

Create an announced return and complete it

This is an example of an order that only contains returnable items.

1. Obtain the itemReturnJobId for the order

   1. Query GET /api/itemreturnjobs using the tenantOrderId (for example, via searchTerm) and, if needed, additional filters such as facilityId

   2. From the result, select the entry matching the tenantOrderId and take its ID as itemReturnJobId

2. Create the announced return

   1. Create an announced return using POST /api/itemreturnjobs/{itemReturnJobId}/itemreturns

   2. Set status to ANNOUNCED

   3. Provide returnFacilityRef and at least one entry in returnedLineItems

   4. Each returned line item must include tenantArticleId and a line-item status (for example, OPEN)

   5. itemConditionLocalized and reasons are optional

   6. Include the current itemReturnJobVersion

3. Locate announced returns

   1. Filter by status ANNOUNCED in Backoffice

   2. Search by order information

4. Edit prior to confirmation (optional)

   1. Edits can be performed in the mobile application:

      1. Adjust quantities

      2. Replace or correct items within the same order

      3. Update reasons or conditions (if applicable)

      4. Add missing items from the same order if necessary

5. Confirm the return using the returns app

   1. Review the summary of items and details

   2. Confirm the return

   3. When confirming the return, the status changes from ANNOUNCED to COMPLETED and no further changes are possible after confirmation.