Upload and manage invoices with Channable API
Learn how to upload and manage order invoices with the Channable API for supported marketplaces.
If you have an order connection, you can upload and manage your invoices in PDF format for supported marketplaces via the Channable API. This feature is available for Amazon, Kaufland, bol, and all Mirakl-based marketplaces (e.g. MediaMarkt, Decathlon, Leroy Merlin etc.)
Before you start
To make the most of this feature, make sure you’ve considered the following:
You’ll need
An active order connection with existing orders
A Channable API access token
Existing orders from a supported marketplace
Good to know
Currently, you can only upload and manage your webshops with the Channable API (not webshop-based platforms)
The API allows us to receive invoice information. Currently, we can’t automatically retrieve invoices from order connection platforms.
This setup involves connecting your system to Channable using our API. This is a technical process that typically requires a developer or someone with programming knowledge.
Generate Channable API access token
Tip: You can skip this step if you’ve already generated an access token.
In Channable, go to your Company Settings.
In the Tools section, select Channable API.
Make note of your Company ID, as you will need it later.
Click Generate token to generate a Company token.
Important: Once your token is generated, save it in a safe place. For security reasons, we don’t display the token again after you generate it. If you lose it, you’ll need to generate a new one.
Find and note your product and order ids
OPTION 1: Retrieve order IDs using the Channable API (recommended for developers)
Use All Orders V2 to fetch orders from Channable.
Each order contains an id attribute — this is the id you need to provide when uploading invoices for a specific order.
OPTION 2: Find Order IDs manually in Channable (recommended for non-developers)
In Channable, open the project with your order connection.
In the sidebar, go to Settings. This will take you to your Project settings.
Make note of your Project ID, as you will need it in your API request.
Go to Orders. You’ll see a list of your imported orders.
Make note of the specific order IDs you want to upload invoices for.
Integrate for Invoices (developer)
In this step, you/your developer will write code that communicates directly with Channable to send the invoice data to the correct order.
Convert your invoice file from a PDF into a Base64 encoded string.
Build your request:
Create a POST request to the order_attachment_upload endpoint.
Embed your API access token in the Authorization: Bearer your_api_token header.
Fill in the request body. It should contain:
attachment_type: Set to “INVOICE”
file: the Base64 encoded string of your invoice file
order_item_ids (optional, bol only): an array of order item IDs. If you don’t add them, the invoice will be linked to all items in the order.
For detailed instructions, refer to our Order Attachments API documentation.
Check your uploaded invoices
After you/your developer sends an invoice via our Channable API, check it was attached correctly within Channable.
In Channable, open the project with your order connection.
Go to Orders.
Click on the order you uploaded the invoice for.
Go to the Order attachments tab.
Click Download Invoice.
Last updated
Was this helpful?