https://github.com/shoppingflux/php-sdk
Shopping-feed PHP SDK to ease our API integration in your application
https://github.com/shoppingflux/php-sdk
api-client library php php-sdk sdk
Last synced: 3 months ago
JSON representation
Shopping-feed PHP SDK to ease our API integration in your application
- Host: GitHub
- URL: https://github.com/shoppingflux/php-sdk
- Owner: shoppingflux
- Created: 2018-02-26T10:53:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-12T14:32:06.000Z (about 1 year ago)
- Last Synced: 2025-08-23T09:54:59.485Z (7 months ago)
- Topics: api-client, library, php, php-sdk, sdk
- Language: PHP
- Homepage:
- Size: 517 KB
- Stars: 4
- Watchers: 10
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Welcome to the Shopping Feed PHP SDK
## Install
1. In your project root repository run
```bash
composer require shoppingfeed/php-sdk
```
2. Install a http client of your choice, we recommend using GuzzleHttp 6 as the SDK embed an adapter for this client.
```bash
composer require guzzlehttp/guzzle ^6.3
```
You can also develop your own adapter, if you already have a http client library in your project (see the [http adapter documentation](docs/development/http-adapter.md) for more information).
This will load the SDK library into the `vendor` repository.
And thanks to PSR-4 specification you should be able to access the SDK under the namespace `\ShoppingFeed\Sdk`.
## Basic usage
Here are the three basic steps to use the SDK :
1. Authentication to start a new session
2. Retrieve the store(s) you want to manage from the session
3. Manage resources
### Authentication against the API
The Shopping Feed API requires that you are authenticated to perform any calls.
In order to make authenticated call, you should build the client like so:
```php
selectStore(1276);
$store->getName(); // test-store
$store->getId(); // 1276
// ... and so on
```
If you manage more than one store, you can use the store collection object
```php
/** @var \ShoppingFeed\Sdk\Api\Session\SessionResource $session */
// Get store collection
$stores = $session->getStores();
// Count the number of stores [int]
$stores->count();
// Get a particular store
$store = $stores->select('id-or-store-name');
// Loop over available stores
foreach ($stores as $store) {
$store->getName();
}
```
### SDK guides
- [Authentication in details](docs/manual/authenticate.md)
- [Error handling and debug](docs/manual/error-handling.md)
### SDK resources documentation
- [Inventory management](docs/manual/resources/inventory.md)
- [Order management](docs/manual/resources/order.md)
- [Pricing management](docs/manual/resources/pricing.md)
- [Ticket management](docs/manual/resources/ticket.md)
### Generates XML compliant feed for import
The SDK is able to simplify XML feed creation by providing necessary tools.
Check the documentation at https://github.com/shoppingflux/php-feed-generator to learn how to create compliant feed.