ChannelEngine: how to create a test marketplace return

About this article

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

Table of contents

Introduction

Create a test marketplace return

• Create a test order
• Create a test shipment (via the web interface)
• Create a test marketplace return
• Retrieve a return via the Merchant API

Introduction

When adding a new marketplace, it is important to test the return process initiated on the marketplace side. The merchant must mark the return as received to process the refund and complete the return.

Most live marketplaces do not allow this kind of test. Therefore, you can create a test return on ChannelEngine.

Create a test marketplace return

If you already have a test order, you can skip the steps below and proceed to the step you have not completed yet.

Create a test order

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

1. From the left-hand side menu, go to Settings, Support.
2. Under Test order, fill out the required information.
3. Select your test marketplace from the Channel dropdown menu.
   
   
4. In the Order lines section, enter an active product. This ensures the orders can be correctly retrieved by your system. All other sections are optional and will be automatically filled with placeholder data if left empty.
5. Click Create test order to complete the process.

Create a test shipment (via the web interface)

1. Find the test order you created in the order overview.
2. Select Create shipment (a.k.a. the truck icon).
   
   
3. Enter the shipped quantity. Select the Shipment method, add the tracking code and the Merchant shipment number. For a test shipment, you can use placeholder data, but ensure the Merchant shipment number is unique.
4. Click Add to save the shipment.

Creating a test marketplace return

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

1. On the Order details page, select Create return.
   
   
2. In the popup window, select Channel in the Created by field. Specify the quantity to be returned. Fill out the remaining fields: Status, Reason and Channel return number. Adding a comment is optional.
3. Click Add to save the return.
4. The new return should appear below the shipment section on the Order details page.

Retrieve a return via the Merchant API

To retrieve the marketplace return, use the GET /v2/returns/merchant endpoint. You can test this using 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": {} }