{"id":18577469,"url":"https://github.com/ecomplus/client","last_synced_at":"2025-04-10T09:30:53.340Z","repository":{"id":36986191,"uuid":"197812374","full_name":"ecomplus/client","owner":"ecomplus","description":"Isomorphic JS client for E-Com Plus REST APIs","archived":false,"fork":false,"pushed_at":"2024-12-16T03:48:58.000Z","size":3870,"stargazers_count":9,"open_issues_count":5,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T20:57:00.254Z","etag":null,"topics":["axios-promises","ecomclient","ecommerce-apis","ecomplus","headless-ecommerce","js-client","rest-apis","store-api"],"latest_commit_sha":null,"homepage":"https://developers.e-com.plus/client/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ecomplus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-19T16:58:05.000Z","updated_at":"2024-12-16T03:48:30.000Z","dependencies_parsed_at":"2023-02-13T01:16:24.093Z","dependency_job_id":"ac3eb8dc-edf0-43da-a8f1-dd520be31a51","html_url":"https://github.com/ecomplus/client","commit_stats":{"total_commits":654,"total_committers":6,"mean_commits":109.0,"dds":0.3516819571865444,"last_synced_commit":"ba37bfb74a65c280562c3dd851635574a6536a1e"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomplus%2Fclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomplus%2Fclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomplus%2Fclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomplus%2Fclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ecomplus","download_url":"https://codeload.github.com/ecomplus/client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247785945,"owners_count":20995645,"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":["axios-promises","ecomclient","ecommerce-apis","ecomplus","headless-ecommerce","js-client","rest-apis","store-api"],"created_at":"2024-11-06T23:29:16.224Z","updated_at":"2025-04-10T09:30:51.912Z","avatar_url":"https://github.com/ecomplus.png","language":"JavaScript","readme":"# E-Com Plus Client\n\n[![Publish](https://github.com/ecomplus/client/workflows/Publish/badge.svg)](https://github.com/ecomplus/client/actions?workflow=Publish) [![CodeFactor](https://www.codefactor.io/repository/github/ecomplus/client/badge)](https://www.codefactor.io/repository/github/ecomplus/client) [![npm version](https://img.shields.io/npm/v/@ecomplus/client.svg)](https://www.npmjs.org/@ecomplus/client) [![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nJS client for E-Com Plus REST APIs\n\n[CHANGELOG](https://github.com/ecomplus/client/blob/master/CHANGELOG.md)\n\n## Usage\n\n**TL;DR**: We have [methods](https://developers.e-com.plus/client/ecomClient.html) to run requests for almost all E-Com Plus APIs, but you're probably searching for [Store API](https://developers.e-com.plus/client/ecomClient.html#.store).\n\nThe `@ecomplus/client` package provides a [list of methods](https://developers.e-com.plus/client/ecomClient.html), each one is a function to request a specific E-Com Plus REST API, using [axios](https://github.com/axios/axios) HTTP client and returning a [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise).\n\nIt's available for both Node.js and browser environments.\n\n- [Get started](https://developers.e-com.plus/client/module-@ecomplus_client.html)\n- [Methods](https://developers.e-com.plus/client/ecomClient.html)\n\n### Store API request example\n\n```js\nimport { store } from '@ecomplus/client'\n\nconst authenticationId = 'myAuthenticationId'\nconst accessToken = 'myAccessToken'\n\necomClient.store({\n  url: '/products.json',\n  authenticationId,\n  accessToken,\n  method: 'post',\n  data: { sku: '123', name: 'Sample Prduct 123' }\n})\n  .then(({ data, status }) =\u003e console.log(status, data))\n  .catch(error =\u003e console.error(error))\n```\n\n### Dependencies\n\nIt requires and _may not_ include `core-js`, [`axios`](https://github.com/axios/axios) and [`@ecomplus/utils`](https://github.com/ecomplus/utils).\n\n#### Node.js\n\n```bash\nnpm i --save @ecomplus/utils @ecomplus/client\n```\n\n#### Webpack\n\n```bash\nnpm i --save core-js @ecomplus/utils @ecomplus/client\n```\n\n#### CDN\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@ecomplus/client/dist/ecom-client.polyfill.min.js\"\u003e\u003c/script\u003e\n```\n\n`axios` and `ecomUtils` libraries **must be included separately** and available on window scope.\n\n## Development\n\nFork/clone this repository and install dependencies normally:\n\n```bash\ngit clone https://github.com/ecomplus/client\ncd client\nnpm i\n```\n\nThen you can edit source files and test locally with `npm run serve`.\n\n### Contributing\n\nPlease read the [contribution guidelines](CONTRIBUTING.md).\n\n### Deploy\n\nTake a look on `package.json` scripts:\n\n- `npm run doc` - Update jsdoc/docdash generated documentation;\n- `npm run release` - Generate changelog and new version;\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecomplus%2Fclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fecomplus%2Fclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecomplus%2Fclient/lists"}