ChannelEngine: merchant invoices

About this article

This article describes how to configure merchant invoices on ChannelEngine.

Table of contents

Introduction

Setup

• Via the Merchant API
• Via the web interface

Introduction

You can submit order invoices to the marketplaces, such as as Mirakl-based ones, Amazon, bol, and Kaufland, via ChannelEngine's Merchant API and web interface.

Setup

To enable the merchant invoice feature and the Documents page:

1. From the left hand-side menu, go to Settings, Settings, Orders.
2. Enable the Merchant invoice setting, and click Save.

Via the Merchant API

• Upload invoices for orders: POST /v2/orders/{merchantOrderNo}/invoice

Use this endpoint to upload merchant invoices for orders. Provide a unique Merchant order number for the order and include the invoice in PDF format in the request body.

If your system does not support PDF invoices and can only process text, you can use Base64 encoding for your order invoices. To provide the invoice in the Base64 format to ChannelEngine, send a request to the POST /v2/orders/{merchantOrderNo}/invoice-base64 endpoint – including the invoice content and invoice number in the body of the request.

Via the web interface

Upload the invoice

Provide the invoice to ChannelEngine so it can be attached to the shipment.

1. From the left-hand side menu, go to Orders, Orders.
2. Click the eye icon next to the order for which you want to upload an invoice.
3. On the Order details page, scroll down to the Documents section, and click Upload merchant invoice.
4. In your file explorer, select a PDF file to upload. Once selected, the status of the invoice changes to the Ready to export to marketplace.

Check the invoice status

From the left-hand side menu, go to Orders, Documents. 

At the top of the Documents overview, there is a search bar and several different filters. Use the search bar to filter on one or more specific invoices by entering an identifier, such as the Order ID or the Channel order number.

The functionality of the filters is detailed below. 

• Select channels - filter on the marketplace.
• Status - filter on the status of the invoice. The options are ‘Ready to export to marketplace’ and ‘Exported to marketplace’.
• Type - filter on the type of document. Select ‘Invoice’ from the dropdown.
• Date - filter on the date and time of the last action – when the invoice was uploaded to ChannelEngine or exported to the marketplace.

To reset the filters, click the Clear filters button.

The Documents table contains the following columns:

• Order ID - the unique ID of the order within your tenant on ChannelEngine. By clicking the order ID, you can navigate to the Order details page.
• Channel - the name of the marketplace the invoice is going to be exported to.
• Channel order no - the unique reference assigned to the order by the marketplace.
• Merchant order no - the unique reference assigned to the order by your system (e.g.: ERP, OMS).
• Document no - the unique invoice number inside the document, as expected by the marketplace. 
• Date - the date and time of the last action – when the invoice was uploaded to ChannelEngine or exported to the marketplace.
• Type - the type of document.
• Status - the status of the invoice. 
• Actions - the action you can perform on the document, such as download it.