{"id":15145501,"url":"https://github.com/prestashop/ws-client","last_synced_at":"2026-02-08T02:03:11.664Z","repository":{"id":199271879,"uuid":"700383743","full_name":"PrestaShop/ws-client","owner":"PrestaShop","description":"A webservice client library for PrestaShop written in TypeScript","archived":false,"fork":false,"pushed_at":"2024-05-24T10:16:52.000Z","size":233,"stargazers_count":4,"open_issues_count":2,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-10-29T17:04:09.176Z","etag":null,"topics":["hacktoberfest","library","prestashop","testing","webservices"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/PrestaShop.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-04T13:50:30.000Z","updated_at":"2024-05-24T10:16:19.000Z","dependencies_parsed_at":"2024-04-10T15:29:52.152Z","dependency_job_id":"4d216c2c-6d96-4eaa-a0dc-42ca51d5b95b","html_url":"https://github.com/PrestaShop/ws-client","commit_stats":{"total_commits":49,"total_committers":5,"mean_commits":9.8,"dds":0.4285714285714286,"last_synced_commit":"f0536d01efb7528d23bae1bd9cc7e03123030798"},"previous_names":["prestashop/ws-client"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2Fws-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2Fws-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2Fws-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PrestaShop%2Fws-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PrestaShop","download_url":"https://codeload.github.com/PrestaShop/ws-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237163335,"owners_count":19265256,"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":["hacktoberfest","library","prestashop","testing","webservices"],"created_at":"2024-09-26T11:40:21.891Z","updated_at":"2026-02-08T02:03:11.615Z","avatar_url":"https://github.com/PrestaShop.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WS-CLIENT\n\n## Description\n\nTypescript [Webservice](https://devdocs.prestashop-project.org/8/webservice/) Client to use with PrestaShop Core.\n\nTO DO :\n\n- Typing : 2 types are required\n  - Readable\n  - Writable\n\nPrestaShop Compatibility :\n\n- 9\n- 8\n- 1.7\n\nNodeJs compatibility :\n\n- 18\n\n## Endpoint to implement\n\n| Endpoint   | URL | Done |\n|------------| --- | ---- |\n| addresses  |     | []   |\n| carts      |     | []   |\n| cart_rules |     | []   |\n| categories |     | []   |\n| country    |     | []   |\n| customers  |     | []   |\n| orders     |     | []   |\n| products   |     | []   |\n| stores     |     | []   |\n| taxes      |     | []   |\n| tax_rules  |     | []   |\n\n## Stack\n\n- [fetch](https://www.npmjs.com/package/node-fetch)\n- Typescript\n\n## How to use\n\nSet up the env file:\n\n```sh\ncp .env.dist .env\nopen .env\n```\n\nRun some code:\n\n```js\nconst client = new BaseClient({\n  baseURl: process.env.BASE_URL, // URL of your PrestaShop\n  wsKey: process.env.WS_KEY, // Key to connect to your prestashop\n});\n\nconst response = await client.product.create(productData);\nconsole.log(response.status);\nconsole.log(response.data.product); // Maybe return type writable ??\n\n// Error case\n// Return an Exeption depending on what is the error.\n// UnreachableServerException\n// WrongPayloadException\n// RequestTimeoutException\n// InvalidCredentialsException\n```\n\n# Build\n\nInstall dependencies:\n\n```sh\nnpm install -g pnpm\npnpm install\n```\n\nBuild the library:\n\n```sh\npnpm build\n```\n\nTest the library:\n\n```sh\npnpm test\n```\n\n# Contributing\n\nThis library is an open source solution. Everyone is welcome and even encouraged to contribute with their own improvements!\n\nJust make sure to follow our [contribution guidelines](https://devdocs.prestashop-project.org/8/contribute/contribution-guidelines/project-modules/).\n\n## Reporting issues\n\nYou can report issues [here](https://github.com/PrestaShop/ws-client/issues/new).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprestashop%2Fws-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprestashop%2Fws-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprestashop%2Fws-client/lists"}