{"id":13765507,"url":"https://github.com/apertureless/shopware-api-client","last_synced_at":"2025-06-19T07:07:19.382Z","repository":{"id":47523624,"uuid":"82204481","full_name":"apertureless/shopware-api-client","owner":"apertureless","description":"🛍 Javascript API Client for Shopware","archived":false,"fork":false,"pushed_at":"2023-02-28T12:26:35.000Z","size":904,"stargazers_count":32,"open_issues_count":9,"forks_count":10,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-05-01T21:32:42.306Z","etag":null,"topics":["api","api-client","rest-api","shopware"],"latest_commit_sha":null,"homepage":"","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/apertureless.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-02-16T17:00:04.000Z","updated_at":"2023-11-27T08:25:07.000Z","dependencies_parsed_at":"2024-01-07T18:31:18.508Z","dependency_job_id":null,"html_url":"https://github.com/apertureless/shopware-api-client","commit_stats":{"total_commits":88,"total_committers":10,"mean_commits":8.8,"dds":"0.19318181818181823","last_synced_commit":"d4ab576d6ec8da752eb8cdbd6c5a6b51fa338180"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apertureless%2Fshopware-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apertureless%2Fshopware-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apertureless%2Fshopware-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apertureless%2Fshopware-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apertureless","download_url":"https://codeload.github.com/apertureless/shopware-api-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221666419,"owners_count":16860415,"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":["api","api-client","rest-api","shopware"],"created_at":"2024-08-03T16:00:40.327Z","updated_at":"2024-10-27T11:01:39.014Z","avatar_url":"https://github.com/apertureless.png","language":"JavaScript","readme":"# 🛍 Shopware 5 API Client\n\n[![npm version](https://badge.fury.io/js/shopware-api-client.svg)](https://badge.fury.io/js/shopware-api-client)\n[![Build Status](https://travis-ci.org/apertureless/shopware-api-client.svg?branch=master)](https://travis-ci.org/apertureless/shopware-api-client)\n[![codecov](https://codecov.io/gh/apertureless/shopware-api-client/branch/master/graph/badge.svg)](https://codecov.io/gh/apertureless/shopware-api-client)\n[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/apertureless/shopware-api-client/blob/master/LICENSE.txt)\n\nNode.js module to interact with the [Shopware 5 REST API](https://developers.shopware.com/developers-guide/rest-api/).\n\n```bash\nyarn add shopware-api-client\n```\n\n## Examples\nExamples how to use the package:\n\n### ES2015\n\n```javascript\nimport Shopware from 'shopware-api-client'\n\nconst shop = new Shopware({\n    host: 'YOUR HOST',\n    user: 'YOUR USER',\n    apiKey: 'YOUR APIKEY'\n})\n\nlet articles\n\ntry {\n  articles = await shop.getArticles()\n} catch (err) {\n  console.log(err)\n}\n\nconsole.log(articles)\n```\n\n### Older ES 😔\n\n```javascript\nconst Shopware = require('shopware-api-client')\nconst shop = new Shopware({\n  host: 'YOUR HOST',\n  user: 'YOUR USER',\n  apiKey: 'YOUR APIKEY'\n})\n\nshop.getArticles()\n  .then(articles =\u003e console.log(articles))\n  .catch(err =\u003e console.log(err))\n\n```\n\n## Docs\nFind the [docs here](https://apertureless.github.io/shopware-api-client/#/) *contributions welcome*\n\n## Implemented API Resources\n\n- [x] `/api/addresses`\n- [x] `/api/articles`\n- [x] `/api/caches`\n- [x] `/api/categories`\n- [x] `/api/countries`\n- [x] `/api/customerGroups`\n- [x] `/api/customers`\n- [x] `/api/generateArticleImages`\n- [x] `/api/media`\n- [x] `/api/manufacturers`\n- [x] `/api/orders`\n- [x] `/api/propertyGroups`\n- [x] `/api/shops`\n- [x] `/api/translations`\n- [x] `/api/variants`\n- [x] `/api/version`\n\n\n## API Reference\n\n- Shopware\n  - [new Shopware([object])](https://github.com/apertureless/shopware-api-client/tree/master/docs#new_shopware)\n  - [.version([callback])](https://github.com/apertureless/shopware-api-client/tree/master/docs#version) 🔀 `Promise`\n  - [.getArticles([callback])](https://github.com/apertureless/shopware-api-client/tree/master/docs#getArticles) 🔀 `Promise`\n  - [.getArticleByOrdernumber(ordernumber, [callback])](https://github.com/apertureless/shopware-api-client/tree/master/docs#getArticleByOrdernumber) 🔀 `Promise`\n  - [.getArticle(id, [callback])](https://github.com/apertureless/shopware-api-client/tree/master/docs#getArticle) 🔀 `Promise`\n  - [.deleteArticle(id, [callback])](https://github.com/apertureless/shopware-api-client/tree/master/docs#deleteArticle) 🔀 `Promise`\n  - [.deleteArticles(ids, [callback])](https://github.com/apertureless/shopware-api-client/tree/master/docs#deleteArticles) 🔀 `Promise`\n  - [.createArticle(article, [callback])](https://github.com/apertureless/shopware-api-client/tree/master/docs#createArticle) 🔀 `Promise`\n  - [.updateArticle(id, article, [callback])](https://github.com/apertureless/shopware-api-client/tree/master/docs#updateArticle) 🔀 `Promise`\n  - .updateArticles(articles, [callback]) 🔀 `Promise`\n  - .getCategories([callback]) 🔀 `Promise`\n  - .getCategory(id, [callback]) 🔀 `Promise`\n  - .createCategory(category, [callback]) 🔀 `Promise`\n  - .updateCategory(id, category, [callback]) 🔀 `Promise`\n  - .deleteCategory(id, [callback]) 🔀 `Promise`\n  - .getVariants([callback]) 🔀 `Promise`\n  - .getVariants([callback]) 🔀 `Promise`\n  - .getVariant(id, [callback]) 🔀 `Promise`\n  - .updateVariant(id, body, [callback]) 🔀 `Promise`\n  - .createVariant(body, [callback]) 🔀 `Promise`\n  - .deleteVariant(id, [callback]) 🔀 `Promise`\n  - .deleteVariants(ids, [callback]) 🔀 `Promise`\n  - .generateArticleImages(articleId, [callback]) 🔀 `Promise`\n  - .listMedia([callback]) 🔀 `Promise`\n  - .getMedia(id, [callback]) 🔀 `Promise`\n  - .updateMedia(id, body, [callback]) 🔀 `Promise`\n  - .createMedia(body, [callback]) 🔀 `Promise`\n  - .deleteMedia(id, [callback]) 🔀 `Promise`\n  - .getOrders([callback]) 🔀 `Promise`\n  - .getOrderByOrdernumber(ordernumber, [callback]) 🔀 `Promise`\n  - .getOrder(id, [callback]) 🔀 `Promise`\n  - .updateOrder(id, body, [callback]) 🔀 `Promise`\n  - .getAddresses([callback]) 🔀 `Promise`\n  - .getAddress(id, [callback]) 🔀 `Promise`\n  - .createAddress(body, [callback]) 🔀 `Promise`\n  - .updateAddress(id, body, [callback]) 🔀 `Promise`\n  - .deleteAddress(id, [callback]) 🔀 `Promise`\n  - .getCustomers([callback]) 🔀 `Promise`\n  - .getCustomer(id, [callback]) 🔀 `Promise`\n  - .createCustomer(body, [callback]) 🔀 `Promise`\n  - .updateCustomer(id, body, [callback]) 🔀 `Promise`\n  - .deleteCustomer(id, [callback]) 🔀 `Promise`\n  - .getCaches([callback]) 🔀 `Promise`\n  - .getCache(id, [callback]) 🔀 `Promise`\n  - .deleteCache(id, [callback]) 🔀 `Promise`\n  - .deleteCaches([callback]) 🔀 `Promise`\n  - .getCountries([callback]) 🔀 `Promise`\n  - .getCountry(id, [callback]) 🔀 `Promise`\n  - .updateCountry(id, body, [callback]) 🔀 `Promise`\n  - .createCountry(body, [callback]) 🔀 `Promise`\n  - .deleteCountry(id, [callback]) 🔀 `Promise`\n  - .getCustomerGroups([callback]) 🔀 `Promise`\n  - .getCustomerGroup(id, [callback]) 🔀 `Promise`\n  - .createCustomerGroup(body, [callback]) 🔀 `Promise`\n  - .updateCustomerGroup(id, body, [callback]) 🔀 `Promise`\n  - .deleteCustomerGroup(id, [callback]) 🔀 `Promise`\n  - .getManufacturers([callback]) 🔀 `Promise`\n  - .getManufacturer(id, [callback]) 🔀 `Promise`\n  - .createManufacturer(body, [callback]) 🔀 `Promise`\n  - .updateManufacturer(id, body, [callback]) 🔀 `Promise`\n  - .deleteManufacturer(id, [callback]) 🔀 `Promise`\n  - .getPropertyGroups([callback]) 🔀 `Promise`\n  - .getPropertyGroup(id, [callback]) 🔀 `Promise`\n  - .createPropertyGroup(body, [callback]) 🔀 `Promise`\n  - .updatePropertyGroup(id, body, [callback]) 🔀 `Promise`\n  - .deletePropertyGroup(id, [callback]) 🔀 `Promise`\n  - .getShops([callback]) 🔀 `Promise`\n  - .getShop(id, [callback]) 🔀 `Promise`\n  - .createShop(body, [callback]) 🔀 `Promise`\n  - .updateShop(id, body, [callback]) 🔀 `Promise`\n  - .deleteShop(id, [callback]) 🔀 `Promise`\n  - .getTranslations([callback]) 🔀 `Promise`\n  - .getTranslation(id, [callback]) 🔀 `Promise`\n  - .createTranslation(id, body, [callback]) 🔀 `Promise`\n  - .updateTranslation(id, body, [callback]) 🔀 `Promise`\n  - .updateTranslations(body, [callback]) 🔀 `Promise`\n  - .deleteTranslation(id, [callback]) 🔀 `Promise`\n\n## Contributing\n\n1. Fork it ( https://github.com/apertureless/shopware-api-client/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## License\n\nThis software is distributed under [MIT license](LICENSE.txt).\n","funding_links":[],"categories":["Connectors"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapertureless%2Fshopware-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapertureless%2Fshopware-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapertureless%2Fshopware-api-client/lists"}