ChannelEngine

Unofficial node.js API client for ChannelEngine.
Supports pagination and variable request retries.

Swagger Docs · ChannelEngine Docs · Issues

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
   • Example
2. Built with
3. Licence
4. Contributors

Getting Started

Prerequisites

In order to connect to ChannelEngine, a tenant and an apiKey are required.

The tenant will be provided by ChannelEngine. The API key can then be generated at https://$TENANT.channelengine.net/apikeys.

Installation

Yarn:

yarn add channelengine

NPM:

npm install channelengine

Example

import {ChannelEngine} from 'channelengine'

// provided by ChannelEngine
const tenant = 'demo'
const apiKey = 'myApiKey'

// create instance and request IN_PROGRESS orders
const api = new ChannelEngine(tenant, apiKey, {maxRetries: 10, version: 2})
const response = await api.GET('orders', {
  statuses: 'IN_PROGRESS'
})

// log result
console.log(res)

Methods

An instance provides the methods GET, POST, PATCH, PUT and DELETE.

See Swagger docs for details on when to use which method.

(back to top)

Built With

• node.js
• node-fetch

(back to top)

Licence

MIT

(back to top)

Contributors

RienNeVaPlus - ?@rienneva.plus

(back to top)