{"id":24998032,"url":"https://github.com/riennevaplus/channelengine","last_synced_at":"2025-03-29T16:42:21.745Z","repository":{"id":65564247,"uuid":"536987830","full_name":"RienNeVaPlus/channelengine","owner":"RienNeVaPlus","description":"ChannelEngine API Client for Node.js","archived":false,"fork":false,"pushed_at":"2022-12-16T18:43:06.000Z","size":17,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-06T12:52:52.032Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RienNeVaPlus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-15T11:07:41.000Z","updated_at":"2022-09-15T14:58:56.000Z","dependencies_parsed_at":"2023-01-29T20:45:17.444Z","dependency_job_id":null,"html_url":"https://github.com/RienNeVaPlus/channelengine","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RienNeVaPlus%2Fchannelengine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RienNeVaPlus%2Fchannelengine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RienNeVaPlus%2Fchannelengine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RienNeVaPlus%2Fchannelengine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RienNeVaPlus","download_url":"https://codeload.github.com/RienNeVaPlus/channelengine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246215821,"owners_count":20741894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-04T17:38:26.127Z","updated_at":"2025-03-29T16:42:21.717Z","avatar_url":"https://github.com/RienNeVaPlus.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.channelengine.com\"\u003e\n    \u003cimg src=\"https://www.channelengine.com/Themes/ChannelEngine/images/ChannelEngine.svg\" alt=\"Logo\" width=\"600\"\u003e\n  \u003c/a\u003e\n\n\u003ch1 align=\"center\"\u003eChannelEngine\u003c/h1\u003e\n\n  \u003cp align=\"center\"\u003e\n    Unofficial node.js API client for \u003ca href=\"https://www.channelengine.com\"\u003eChannelEngine\u003c/a\u003e.\n    \u003cbr /\u003e\n    Supports pagination and variable request retries.\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://demo.channelengine.net/api/swagger/index.html\"\u003eSwagger Docs\u003c/a\u003e\n    ·\n    \u003ca href=\"https://channelengine.zendesk.com/hc/en-us/sections/4406511272733-Merchant-API\"\u003eChannelEngine Docs\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/RienNeVaPlus/channelengine/issues\"\u003eIssues\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#example\"\u003eExample\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt with\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#licence\"\u003eLicence\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributors\"\u003eContributors\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n\n### Prerequisites\n\nIn order to connect to ChannelEngine, a `tenant` and an `apiKey` are required.\n\nThe tenant will be provided by ChannelEngine. The API key can then be generated at `https://$TENANT.channelengine.net/apikeys`.\n\n### Installation\n\nYarn:\n```bash\nyarn add channelengine\n```\n\nNPM:\n\n```bash\nnpm install channelengine\n```\n\n### Example\n\n```ts\nimport {ChannelEngine} from 'channelengine'\n\n// provided by ChannelEngine\nconst tenant = 'demo'\nconst apiKey = 'myApiKey'\n\n// create instance and request IN_PROGRESS orders\nconst api = new ChannelEngine(tenant, apiKey, {maxRetries: 10, version: 2})\nconst response = await api.GET('orders', {\n  statuses: 'IN_PROGRESS'\n})\n\n// log result\nconsole.log(res)\n```\n\n### Methods\n\nAn instance provides the methods `GET`, `POST`, `PATCH`, `PUT` and `DELETE`.\n\nSee [Swagger docs](https://demo.channelengine.net/api/swagger/index.html) for details on when to use which method.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n### Built With\n\n* [node.js](https://nodejs.org/)\n* [node-fetch](https://github.com/node-fetch/node-fetch)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- Licence --\u003e\n## Licence\n\nMIT\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- Contributors --\u003e\n## Contributors\n\n[RienNeVaPlus](mailto:?@rienneva.plus) - ?@rienneva.plus\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friennevaplus%2Fchannelengine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Friennevaplus%2Fchannelengine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friennevaplus%2Fchannelengine/lists"}