Parcel tag configuration

Introduction

In the parcel tag configuration, a specific return address can be defined per return via tags. This can be helpful if returned items need to be sent to a special facility. An example are items that have reached their end of life cycle and need to be handled in a specific facility (outlet). This can be handled by configuring tags that contain the information about a specific return address. An order can be created with that tag which will then make sure that the return label will carry the new return address instead of the standard return address of the facility.

Multiple alternative return addresses can be chosen via tags. In this case, the alternative return address is chosen upon sorting the results by tagRef.

How to set up the parcel tag configuration

1. Create the needed tag and value

Create a new tag or use an existing tag.

More information can be found under Developer Docs – Tags.

2. Create a parcel tag configuration

When the tag is available, the tag configuration can be created which will carry information about the new return address. The configuration can be set via the parcel tags configurations endpoint.

3. Create an order with the tag

The newly configured tag can then be set in the order. The tag works only when the tag is set on the order itself, not when it is on order line items. The order can be created via the orders endpoint.

4. Create a shipping label

When a shipping label is created, a corresponding return label is created at the same time (if activated). The return label then carries the new return address which is given with the tag.

Last updated