ChannelEngine: how to create a test channel return

About this article

This article describes the process involved in testing a channel return.

Table of contents

Introduction

Creating a test channel return

• Adding a custom channel
• Creating a test order
• Creating a test shipment (via the web interface)
• Creating a test channel return

Introduction

When integrating a new channel, it is a good practice to test the channel return process, that is, a return received from the marketplace – which has to be marked by the seller as received so the refund can be processed.

This kind of test cannot be done on most live channels, the best approach is to use a custom channel on ChannelEngine.

Creating a test channel return

If you already have a custom channel or a test order from a custom channel, skip these steps and go straight to the step you have not taken yet. Note that this flow cannot be tested if you do not have any products on ChannelEngine, at least one active product is necessary to create test orders, shipments and returns.

Adding a custom channel

1. Go to your dashboard on ChannelEngine.

2. Select + Add to add a new channel.

3. Select Custom channel from the list of available channels.

4. Select Ok to confirm you want to add this channel. The channel appears in your dashboard and there is no need to set it up any further, though it is recommended to name it "Test return channel" or the like so its purpose is clear.

Creating a test order

For a more detailed guide on how to create a test order, consult the ChannelEngine: how to create test orders? article.

1. Go to your ChannelEngine dashboard.

2. Select Settings > Support.

3. Under Test order, fill in all the information you need. The only requirement is that you enter a valid/active product in the Order lines section, otherwise orders are not be retrieved by your order management system. All other sections are optional and, if left empty, are filled in with dummy data by ChannelEngine.

4. Select + Create test order to complete the process.

Creating a test shipment (via the web interface)

1. Find the order you have just created in the order overview.

2. Select Create shipment (aka the truck icon).

3. Enter the shipped quantity, select the Shipment method, and add the Track-and-trace code and the Merchant shipment number. As this is a test, you can enter dummy data as long as the value in the Merchant shipment number is unique.

4. Select + Add to save the shipment.

Creating a test channel return

When the test order is in the stage where it can be returned, you can create the channel return.

1. In the order details view, select Create return.

2. The following pop-up appears.

3. Select Channel (test) in Created by.

4. Fill in the other fields and select + Add to save the return.

5. The new return should be listed just below the shipment in the order details view.

6. If you retrieve the returns via the GET /v2/returns/merchant endpoint, the new channel return should now be available. Note that you can also test via the OpenAPI/Swagger documentation or a tool such as Postman.

Call

curl -X GET "https://[youraccount].channelengine.net/api/v2/returns/merchant?fromDate=2020-05-14&apikey=XXXXXXXXXXXXXXXX" -H "accept: text/plain" 	

Response

 "Content": [    {      "MerchantOrderNo": null,      "Lines": [        {          "MerchantProductNo": "B00-601-60",          "Quantity": 1        }      ],      "CreatedAt": "2020-05-15T14:09:03.843+02:00",      "UpdatedAt": "2020-05-15T14:09:03.843+02:00",      "MerchantReturnNo": "",      "ChannelReturnNo": "Test-channelReturn-1493",      "Id": 4705,      "Reason": "REFUSED_DAMAGED",      "CustomerComment": "Product was damaged :(",      "MerchantComment": "",      "RefundInclVat": 0,      "RefundExclVat": 0    }  ],  "Count": 1,  "TotalCount": 1,  "ItemsPerPage": 100,  "StatusCode": 200,  "LogId": null,  "Success": true,  "Message": null,  "ValidationErrors": {} }