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.

Built With

• node.js
• node-fetch

Licence

MIT

Contributors

RienNeVaPlus - [email protected]