Merchant API: how to create test orders

You can create test orders on ChannelEngine via the Merchant API.

Table of contents

Introduction

Creating test orders

• Creating marketplace-fulfilled test orders
• Test order rate limit

Test order cleanup

FAQs

Introduction

When integrating with ChannelEngine or adding a new channel on ChannelEngine, you may want to create a test order and check if your connection is working as intended. 

You can create test orders either using the ChannelEngine's web interface or the Merchant API. 

Creating test orders

• Create test orders: POST /v2/supportorder

Use this endpoint to create a test order on ChannelEngine. Include the required parameters in the request body:

• CurrencyCode - the currency used in the order, formatted according to ISO 4217, e.g., EUR.
• ChannelID - the ID of the channel for which you want to create a test order. To locate this ID, check out the article ChannelEngine: where can I find the ChannelName, ChannelID, and ChannelReference?
• EAN - the GTIN of the product to include in the order. This product must be part of the product selection of the selected channel.
• Quantity - the number of product items to include in the order.
• NumberOfOrdersCopies - (optional) the number of copies of the test order you want to create. The default value is '0'. Use this parameter to create multiple test orders at once.

All other parameters are optional. If left empty, they are filled with ChannelEngine's default dummy data.

Test orders on ChannelEngine include the channel order number in the format 'CE-TEST-XXXXX'. These orders can be retrieved, shipped, canceled, and returned (if the channel allows) to test the order flow. However, they are not exported to channels.

Creating marketplace-fulfilled test orders 

First, ensure that the selected channel supports marketplace fulfillment. To create a test order that is labeled as marketplace-fulfilled, include all the required parameters as mentioned in the previous section.

Additionally, set the IsFulfillmentByMarketplace parameter to true. The order is created with the status Shipped. If the IsFulfillmentByMarketplace parameter is set to false, the test order is considered merchant-fulfilled. 

Test order rate limit

You can send up to three requests to the POST /v2/supportorder endpoint per minute. This rate limit ensures system stability and prevents overload.

Test order cleanup

Test orders are intended for short-term testing and are automatically deleted after two months. Cleanup runs on a scheduled task to prevent database clutter.

FAQs

How do I know if I exceeded the 10,000 test order limit?

ChannelEngine checks the current number of test orders before processing a new request. If you exceed the limit of 10,000 orders, your request is rejected, and you cannot create any new test orders.

What happens if I try to create more than 1,000 test orders in a single request?

If you set the number of test orders in the request to more than 1,000, your request is rejected, and you receive an error message.

To submit a request successfully, reduce the number in the NumberOfOrdersCopies parameter to less than 1,000.

Can I create a B2B test order?

No, only B2C test orders can currently be created using the Merchant API.