Merchant API: generate or upload an order invoice (sent with shipments)
About this article
This article explains how to generate a ChannelEngine-managed invoice or upload your own via the Merchant API, including the available endpoints, parameters, and file requirements.
Introduction
The Merchant API provides three endpoints for managing order invoices. You can generate a ChannelEngine sales tax invoice as a PDF, upload your own invoice as a multipart file, or upload a Base64-encoded invoice if your environment does not support multipart form data. ChannelEngine attaches the invoice to the shipment and sends it to the channel.
Some channels and local tax regulations require an invoice to be present before or at the point of shipment. Check the requirements for each channel before dispatching orders — missing an invoice where one is required may delay fulfillment or result in a compliance issue.
You can generate a ChannelEngine-managed invoice for an order, or upload your own, via the Merchant API. ChannelEngine then sends this invoice with your shipment. Some channels and local tax regulations require invoice upload as part of the fulfillment process — check the channel's requirements before shipping.
Generate an invoice
GET /v2/orders/{merchantOrderNo}/invoice generates a ChannelEngine sales tax invoice for the order and returns it as a PDF.
| Parameter | In | Required | Description |
merchantOrderNo |
path | Required | Your order reference, as set during acknowledgement. |
useCustomerCulture |
query | Optional | When true, generates the invoice in the language of the billing address country. |
Upload an invoice
POST /v2/orders/{merchantOrderNo}/invoice uploads your own invoice for an order as a PDF file using multipart/form-data. Use this when you generate invoices in your own system and need to attach them to the order in ChannelEngine.
| Parameter | In | Required | Description |
merchantOrderNo |
path | Required | Your order reference. |
Upload an invoice (Base64)
POST /v2/orders/{merchantOrderNo}/invoice-base64 uploads an invoice PDF encoded as a Base64 string. Use this alternative if you cannot send multipart form data from your environment. The invoice must be under 1 MB.
| Field | Type | Required | Description |
InvoiceContent |
string | Required | The Base64-encoded PDF content. |
InvoiceNumber |
string | Required | The invoice number as it appears in the invoice document. |
400 Bad Request error.
Configure and upload order invoices
For further guidance on uploading order invoices via the web interface and configuring merchant invoices per channel, check out:
Comments
0 comments
Article is closed for comments.