1. ChannelEngine Help Center
  2. APIs
  3. API references

Articles in this section

ChannelEngine: API references

  • Created
  • Updated

About this article

This article provides one-stop access to our API references for the following APIs:

  • Merchant API
  • Channel API
  • Channel Management API
NB: API URL and format changes

On 30 June 2026, the URLs and documentation formats for the Channel API, Merchant API, and Channel Management API permanently changed. Please review the updated formats and links below to ensure a smooth transition.

Table of contents

Introduction

API references

Legacy API references

Getting started

Introduction

We upgraded our API documentation experience alongside our URL migration:

  • Until 30 June 2026: our API references were available in Swagger (an interactive interface for testing endpoints) and Redoc (a user-friendly, easy-to-navigate document structure). Note: The Channel Management API was only available in Swagger during this period.

  • From 30 June 2026: we officially switched to Scalar to power all our API references. Scalar replaces both Swagger and Redoc with a single, modern, and fully interactive interface that allows you to explore API structures and test endpoints in real time.

All formats are built on our OpenAPI specifications, which remain available for direct download.

API references

Use this table to access the new Scalar documentation and updated URLs.

To use these resources against your own tenant, replace docs-new with your subdomain in the URL.

API Name Demo link URL
Merchant API

Scalar reference


 

OpenAPI Spec

https://docs-new.channelengine.net/api/docs/#merchant-api


 

https://docs-new.channelengine.net/api/openapi/merchant.json
Channel API

Scalar reference


 

OpenAPI Spec

https://docs-new.channelengine.net/api/docs/#channel-api


 

https://docs-new.channelengine.net/api/openapi/channel.json
Channel Management API

Scalar reference


 

OpenAPI spec

https://www.channelengine.net/channelmanagement-api/docs


 

https://www.channelengine.net/channelmanagement-api/openapi/v1.json

Legacy API references (until 30 June 2026)

Use this table to see our previous documentation formats and URLs up until the migration date to the new resource URLs.

API Name Demo link URL 
Merchant API

Swagger


 

Redoc


 

OpenAPI spec

https://docs-old.channelengine.net/api/swagger


 

https://docs-old.channelengine.net/api/api-docs/merchant


 

https://docs-old.channelengine.net/api/swagger/merchant.json
Channel API

Swagger


 

Redoc


 

OpenAPI spec

https://docs-old.channelengine.net/api/swagger


 

https://docs-old.channelengine.net/api/api-docs/channel


 

https://docs-old.channelengine.net/api/channel/swagger.json
Channel Management API

Swagger


 

OpenAPI spec

https://docs-old.channelengine.net/channelmanagement-api/swagger


 

https://docs-old.channelengine.net/channelmanagement-api/swagger/v1/swagger.json

Getting started

For information about how to connect to the Channel API, the Merchant API, or the Channel Management API, check out the relevant getting started article:

Related articles

Comments

0 comments

Article is closed for comments.