https://github.com/hkonnet/laravel-ebay
This package for laravel framework to access Ebay.
https://github.com/hkonnet/laravel-ebay
ebay ebay-sdk laravel-5-package laravel-package php
Last synced: about 1 year ago
JSON representation
This package for laravel framework to access Ebay.
- Host: GitHub
- URL: https://github.com/hkonnet/laravel-ebay
- Owner: hkonnet
- License: mit
- Created: 2017-06-01T10:16:22.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-03T09:37:04.000Z (almost 6 years ago)
- Last Synced: 2025-04-18T10:12:25.685Z (about 1 year ago)
- Topics: ebay, ebay-sdk, laravel-5-package, laravel-package, php
- Language: PHP
- Size: 23.4 KB
- Stars: 40
- Watchers: 10
- Forks: 41
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Ebay
[](//packagist.org/packages/hkonnet/laravel-ebay)
[](//packagist.org/packages/hkonnet/laravel-ebay)
[](//packagist.org/packages/hkonnet/laravel-ebay)
[](//packagist.org/packages/hkonnet/laravel-ebay)
This package is based on [Ebay SDK](https://github.com/davidtsadler/ebay-sdk-php) written by David T. Sadler.
This package will organize all the configuration according to laravel and make you use the SDK with out doing any exceptional work or configurations.
## Getting Started
Follow the instruction to install and use this package.
### Prerequisites
This is package use [**Ebay Php SDK**](http://devbay.net/)
### Installing
Add Laravel-Ebay to your composer file via the composer require command:
```bash
$ composer require hkonnet/laravel-ebay
```
Or add it to `composer.json` manually:
```json
"require": {
"hkonnet/laravel-ebay": "^1.2"
}
```
Register the service provider by adding it to the providers key in config/app.php. Also register the facade by adding it to the aliases key in config/app.php.
**Laravel 5.1 or greater**
```php
'providers' => [
...
Hkonnet\LaravelEbay\EbayServiceProvider::class,
],
'aliases' => [
...
'Ebay' => Hkonnet\LaravelEbay\Facade\Ebay::class,
]
```
**Laravel 5**
```php
'providers' => [
...
'Hkonnet\LaravelEbay\EbayServiceProvider',
],
'aliases' => [
...
'Ebay' => 'Hkonnet\LaravelEbay\Facade\Ebay',
]
```
Next to get started, you'll need to publish all vendor assets:
```bash
$ php artisan vendor:publish --provider="Hkonnet\LaravelEbay\EbayServiceProvider"
```
This will create a config/ebay.php file in your app that you can modify to set your configuration.
###Configuration
After installation, you will need to add your ebay settings. Following is the code you will find in config/ebay.php, which you should update accordingly.
```php
return [
'mode' => env('EBAY_MODE', 'sandbox'),
'siteId' => env('EBAY_SITE_ID','0'),
'sandbox' => [
'credentials' => [
'devId' => env('EBAY_SANDBOX_DEV_ID'),
'appId' => env('EBAY_SANDBOX_APP_ID'),
'certId' => env('EBAY_SANDBOX_CERT_ID'),
],
'authToken' => env('EBAY_SANDBOX_AUTH_TOKEN'),
'oauthUserToken' => env('EBAY_SANDBOX_OAUTH_USER_TOKEN'),
],
'production' => [
'credentials' => [
'devId' => env('EBAY_PROD_DEV_ID'),
'appId' => env('EBAY_PROD_APP_ID'),
'certId' => env('EBAY_PROD_CERT_ID'),
],
'authToken' => env('EBAY_PROD_AUTH_TOKEN'),
'oauthUserToken' => env('EBAY_PROD_OAUTH_USER_TOKEN'),
]
];
```
## Usage
Following are few examples for using this package.
### Ex 1: Get the official eBay time
Following are the two ways you can do it
**Method 1:**
```php
use \Hkonnet\LaravelEbay\EbayServices;
use \DTS\eBaySDK\Shopping\Types;
// Create the service object.
$ebay_service = new EbayServices();
$service = $ebay_service->createShopping();
// Create the request object.
$request = new Types\GeteBayTimeRequestType();
// Send the request to the service operation.
$response = $service->geteBayTime($request);
// Output the result of calling the service operation.
printf("The official eBay time is: %s\n", $response->Timestamp->format('H:i (\G\M\T) \o\n l jS Y'));
```
**Method 2:**
> **Tip:** If you prefer to use **DTS** library class you need to pass the configuration.
```php
use \DTS\eBaySDK\Shopping\Services;
use \DTS\eBaySDK\Shopping\Types;
$config = Ebay::getConfig();
// Create the service object.
$service = new Services\ShoppingService($config);
// Create the request object.
$request = new Types\GeteBayTimeRequestType();
// Send the request to the service operation.
$response = $service->geteBayTime($request);
// Output the result of calling the service operation.
printf("The official eBay time is: %s\n", $response->Timestamp->format('H:i (\G\M\T) \o\n l jS Y'));
```
### Ex 2: Find items by keyword
This example will call the findItemsByKeywords operation
**Method 1:**
```php
use \Hkonnet\LaravelEbay\EbayServices;
use \DTS\eBaySDK\Finding\Types;
// Create the service object.
$ebay_service = new EbayServices();
$service = $ebay_service->createFinding();
// Assign the keywords.
$request = new Types\FindItemsByKeywordsRequest();
$request->keywords = 'Harry Potter';
// Ask for the first 25 items.
$request->paginationInput = new Types\PaginationInput();
$request->paginationInput->entriesPerPage = 25;
$request->paginationInput->pageNumber = 1;
// Ask for the results to be sorted from high to low price.
$request->sortOrder = 'CurrentPriceHighest';
$response = $service->findItemsByKeywords($request);
// Output the response from the API.
if ($response->ack !== 'Success') {
foreach ($response->errorMessage->error as $error) {
printf("Error: %s
", $error->message);
}
} else {
foreach ($response->searchResult->item as $item) {
printf("(%s) %s:%.2f
", $item->itemId, $item->title, $item->sellingStatus->currentPrice->value);
}
}
```
**Method 2:**
```php
use DTS\eBaySDK\Finding\Services\FindingService;
use \DTS\eBaySDK\Finding\Types;
// Create the service object.
$config = Ebay::getConfig();
$service = new FindingService($config);
// Assign the keywords.
$request = new Types\FindItemsByKeywordsRequest();
$request->keywords = 'Harry Potter';
// Ask for the first 25 items.
$request->paginationInput = new Types\PaginationInput();
$request->paginationInput->entriesPerPage = 25;
$request->paginationInput->pageNumber = 1;
// Ask for the results to be sorted from high to low price.
$request->sortOrder = 'CurrentPriceHighest';
$response = $service->findItemsByKeywords($request);
// Output the response from the API.
if ($response->ack !== 'Success') {
foreach ($response->errorMessage->error as $error) {
printf("Error: %s
", $error->message);
}
} else {
foreach ($response->searchResult->item as $item) {
printf("(%s) %s:%.2f
", $item->itemId, $item->title, $item->sellingStatus->currentPrice->value);
}
}
```
### Ex 3. Get my ebay selling
```php
use \DTS\eBaySDK\Constants;
use \DTS\eBaySDK\Trading\Types;
use \DTS\eBaySDK\Trading\Enums;
use \Hkonnet\LaravelEbay\EbayServices;
/**
* Create the service object.
*/
$ebay_service = new EbayServices();
$service = $ebay_service->createTrading();
/**
* Create the request object.
*/
$request = new Types\GetMyeBaySellingRequestType();
/**
* An user token is required when using the Trading service.
*/
$request->RequesterCredentials = new Types\CustomSecurityHeaderType();
$authToken = Ebay::getAuthToken();
$request->RequesterCredentials->eBayAuthToken = $authToken;
/**
* Request that eBay returns the list of actively selling items.
* We want 10 items per page and they should be sorted in descending order by the current price.
*/
$request->ActiveList = new Types\ItemListCustomizationType();
$request->ActiveList->Include = true;
$request->ActiveList->Pagination = new Types\PaginationType();
$request->ActiveList->Pagination->EntriesPerPage = 10;
$request->ActiveList->Sort = Enums\ItemSortTypeCodeType::C_CURRENT_PRICE_DESCENDING;
$pageNum = 1;
do {
$request->ActiveList->Pagination->PageNumber = $pageNum;
/**
* Send the request.
*/
$response = $service->getMyeBaySelling($request);
/**
* Output the result of calling the service operation.
*/
echo "==================\nResults for page $pageNum\n==================\n";
if (isset($response->Errors)) {
foreach ($response->Errors as $error) {
printf(
"%s: %s\n%s\n\n",
$error->SeverityCode === Enums\SeverityCodeType::C_ERROR ? 'Error' : 'Warning',
$error->ShortMessage,
$error->LongMessage
);
}
}
if ($response->Ack !== 'Failure' && isset($response->ActiveList)) {
foreach ($response->ActiveList->ItemArray->Item as $item) {
printf(
"(%s) %s: %s %.2f\n",
$item->ItemID,
$item->Title,
$item->SellingStatus->CurrentPrice->currencyID,
$item->SellingStatus->CurrentPrice->value
);
}
}
$pageNum += 1;
} while (isset($response->ActiveList) && $pageNum <= $response->ActiveList->PaginationResult->TotalNumberOfPages);
```
> **Note:**
> - There are lots for more example available at [Ebay SDK Examples](https://github.com/davidtsadler/ebay-sdk-examples).
> - Follow above examples but read the Important note below.
## Important Note
Using method 1 in both examples we did
```php
use \Hkonnet\LaravelEbay\EbayServices;
// Create the service object.
$ebay_service = new EbayServices();
$service = $ebay_service->createFinding();
```
to get service object..
Following methods are available to create services using `EbayServices` class.
* createAccount(array $args = [])
* createAnalytics(array $args = [])
* createBrowse(array $args = [])
* createBulkDataExchange(array $args = [])
* createBusinessPoliciesManagement(array $args = [])
* createFeedback(array $args = [])
* createFileTransfer(array $args = [])
* createFinding(array $args = [])
* createFulfillment(array $args = [])
* createHalfFinding(array $args = [])
* createInventory(array $args = [])
* createMarketing(array $args = [])
* createMerchandising(array $args = [])
* createMetadata(array $args = [])
* createOrder(array $args = [])
* createPostOrder(array $args = [])
* createProduct(array $args = [])
* createProductMetadata(array $args = [])
* createRelatedItemsManagement(array $args = [])
* createResolutionCaseManagement(array $args = [])
* createReturnManagement(array $args = [])
* createShopping(array $args = [])
* createTrading(array $args = [])
These services methods can be used to get appropriate service object to perform operations on Ebay.
## Author
* **Haroon Khan** - *Initial work* - [hkonnet](https://github.com/hkonnet)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Acknowledgments
* [David T. Sadler](https://github.com/davidtsadler) for his awesome Ebay SDK.