Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neta-io/shopware-sdk
A PHP SDK for the Shopware 5 REST API
https://github.com/neta-io/shopware-sdk
php sdk shopware
Last synced: 3 months ago
JSON representation
A PHP SDK for the Shopware 5 REST API
- Host: GitHub
- URL: https://github.com/neta-io/shopware-sdk
- Owner: neta-io
- License: mit
- Fork: true (portrino/shopware-sdk)
- Created: 2018-09-05T09:57:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-31T11:55:02.000Z (over 2 years ago)
- Last Synced: 2024-03-07T16:07:35.539Z (8 months ago)
- Topics: php, sdk, shopware
- Language: PHP
- Homepage:
- Size: 429 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-shopware - Shopware 5 API SDK PHP - Shopware 5 API SDK written in PHP. (Connectors)
README
A PHP SDK for Shopware 5 REST API
-----------------
Code Information:
[](https://travis-ci.org/neta-io/shopware-sdk)
[](https://scrutinizer-ci.com/g/neta-io/shopware-sdk/?branch=master)
[](https://scrutinizer-ci.com/g/neta-io/shopware-sdk/?branch=master)
[](https://styleci.io/repos/147497159)
Package Information:
[](https://packagist.org/packages/neta-io/shopware-sdk)
[](https://packagist.org/packages/neta-io/shopware-sdk)
[](https://packagist.org/packages/neta-io/shopware-sdk)
## Requirement
PHP >= 7.2
## Installing
```bash
composer require neta-io/shopware-sdk
```
## Code Docs
See [API Docs](http://neta-io.github.io/shopware-sdk/)
## Examples
```php
['/path/server.pem']]);
// Fetch all articles
$articles = $client->getArticleQuery()->findAll();
// Fetch one article by id
$article = $client->getArticleQuery()->findOne(1);
$article->getName();
$article->getDescription();
$article->get('mainDetail.id'); // Nested fields
$article->get('customField');
// Create an article
$article = new Article();
$article->setName("John product doe");
$article->setDescription("Lorem ipsum");
// ... <- more setters are required
$client->getArticleQuery()->create($article);
// Update article
$article->setName("John product doe");
$updatedArticle = $client->getArticleQuery()->update($article);
// Update multiple articles
$articleOne = $client->getArticleQuery()->findOne(1);
$articleOne->setName("John product doe");
$articleTwo = $client->getArticleQuery()->findOne(2);
$articleTwo->setName("John product doe 2");
$articles = $client->getArticleQuery()->updateBatch([$articleOne, $articleTwo]);
// Delete an article
$client->getArticleQuery()->delete(1);
// Delete multiple articles at once
$client->getArticleQuery()->deleteBatch([1, 2, 3]);
// Find article by parameters
$client->getArticleQuery()->findByParams([
'limit' => 10,
'start' => 20,
'sort' => [
[
'property' => 'name',
'direction' => \Neta\Shopware\SDK\Util\Constants::ORDER_ASC
]
],
'filter' => [
[
'property' => 'name',
'expression' => 'LIKE',
'value' => '%' . $term . '%'
],
[
'operator' => 'AND',
'property' => 'number',
'expression' => '>',
'value' => '500'
]
]
]);
?>
```
## Issues/Features proposals
[Here](https://github.com/neta-io/shopware-sdk/issues) is the issue tracker.
## Contributing
* Write some code
* Write some tests
* Make a pull request
## License
[MIT](LICENSE)
## TODO
- [ ] More tests
- [ ] Generate docs
- [ ] Fluent query builder
- [ ] out-of-the-box pagination
- [ ] Bugs
- [ ] apiUrl: http://example/api doesn't work. It must have a trailing slash in order to work.
- [ ] Invalid response doesn't throw an exception. instead `Symfony\Component\Debug\Exception\FatalThrowableError : Call to a member function getId() on array`
## Credits
This package has been forked from:
[portrino GmbH](https://github.com/portrino/shopware-sdk)
[leadcommerce](https://github.com/LeadCommerceDE/shopware-sdk)
Originally authored by
- [Alexander Mahrt](https://github.com/cyruxx)
- [Jochen Niebuhr](https://github.com/jniebuhr)