https://github.com/michabbb/sdk-ebay-rest-browse
A PHP SDK for generated with openapitools/openapi-generator-cli
https://github.com/michabbb/sdk-ebay-rest-browse
api browse ebay php sdk
Last synced: 7 days ago
JSON representation
A PHP SDK for generated with openapitools/openapi-generator-cli
- Host: GitHub
- URL: https://github.com/michabbb/sdk-ebay-rest-browse
- Owner: michabbb
- Created: 2019-03-12T17:08:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T18:54:46.000Z (over 3 years ago)
- Last Synced: 2025-04-15T14:51:09.628Z (about 1 month ago)
- Topics: api, browse, ebay, php, sdk
- Language: PHP
- Homepage: https://developer.ebay.com/api-docs/buy/browse/overview.html
- Size: 448 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sdk-ebay-rest-browse
The Browse API has the following resources:
-
item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters. -
![\"Experimental](\%22/cms/img/docs/experimental-icon.svg\%22 "\\"Experimental")
(Experimental) search_by_image: Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters. -
item: Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size. This resource also provides a bridge between the eBay legacy APIs, such as Trading and Finding, and the RESTful APIs, such as Browse, which use different formats for the item IDs. You can use the Browse API to retrieve the basic details of the item and the RESTful item ID using a legacy item ID. -
(Experimental) shopping_cart: Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart. *Note:* This resource is not available in the eBay API Explorer.
The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1_beta.19.0
- Package version: 2.3.2
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
## Requirements
PHP 5.5 and later
## Installation & Usage
### Composer
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
```
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/macropage/sdk-ebay-rest-browse.git"
}
],
"require": {
"macropage/sdk-ebay-rest-browse": "*@dev"
}
}
```
Then run `composer install`
### Manual Installation
Download the files and include `autoload.php`:
```php
require_once('/path/to/sdk-ebay-rest-browse/vendor/autoload.php');
```
## Tests
To run the unit tests:
```
composer install
./vendor/bin/phpunit
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```php
setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new macropage\SDKs\ebay\rest\browse\Api\ItemApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$itemId = 'itemId_example'; // string | The eBay RESTful identifier of an item (such as a part you want to check). This ID is returned by the Browse and Feed API methods. RESTful Item ID Format: v1|#|# For example: v1|272394640372|0 or v1|162846450672|461882996982 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.
$xEBAYCMARKETPLACEID = 'xEBAYCMARKETPLACEID_example'; // string | The ID of the eBay marketplace you want to use. Note: This value is case sensitive. For example: X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.
$compatibilityPayload = new \macropage\SDKs\ebay\rest\browse\Model\CompatibilityPayload(); // \macropage\SDKs\ebay\rest\browse\Model\CompatibilityPayload |
try {
$result = $apiInstance->checkCompatibility($itemId, $xEBAYCMARKETPLACEID, $compatibilityPayload);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ItemApi->checkCompatibility: ', $e->getMessage(), PHP_EOL;
}
?>
```
## Documentation for API Endpoints
All URIs are relative to *https://api.ebay.com/buy/browse/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ItemApi* | [**checkCompatibility**](docs/Api/ItemApi.md#checkcompatibility) | **POST** /item/{item_id}/check_compatibility |
*ItemApi* | [**getItem**](docs/Api/ItemApi.md#getitem) | **GET** /item/{item_id} |
*ItemApi* | [**getItemByLegacyId**](docs/Api/ItemApi.md#getitembylegacyid) | **GET** /item/get_item_by_legacy_id |
*ItemApi* | [**getItemsByItemGroup**](docs/Api/ItemApi.md#getitemsbyitemgroup) | **GET** /item/get_items_by_item_group |
*ItemSummaryApi* | [**search**](docs/Api/ItemSummaryApi.md#search) | **GET** /item_summary/search |
*SearchByImageApi* | [**searchByImage**](docs/Api/SearchByImageApi.md#searchbyimage) | **POST** /item_summary/search_by_image |
*ShoppingCartApi* | [**addItem**](docs/Api/ShoppingCartApi.md#additem) | **POST** /shopping_cart/add_item |
*ShoppingCartApi* | [**getShoppingCart**](docs/Api/ShoppingCartApi.md#getshoppingcart) | **GET** /shopping_cart/ |
*ShoppingCartApi* | [**removeItem**](docs/Api/ShoppingCartApi.md#removeitem) | **POST** /shopping_cart/remove_item |
*ShoppingCartApi* | [**updateQuantity**](docs/Api/ShoppingCartApi.md#updatequantity) | **POST** /shopping_cart/update_quantity |
## Documentation For Models
- [AddCartItemInput](docs/Model/AddCartItemInput.md)
- [AdditionalProductIdentity](docs/Model/AdditionalProductIdentity.md)
- [Address](docs/Model/Address.md)
- [Amount](docs/Model/Amount.md)
- [Aspect](docs/Model/Aspect.md)
- [AspectDistribution](docs/Model/AspectDistribution.md)
- [AspectFilter](docs/Model/AspectFilter.md)
- [AspectGroup](docs/Model/AspectGroup.md)
- [AspectValueDistribution](docs/Model/AspectValueDistribution.md)
- [AttributeNameValue](docs/Model/AttributeNameValue.md)
- [AvailabilityStatusEnum](docs/Model/AvailabilityStatusEnum.md)
- [AvailabilityThresholdEnum](docs/Model/AvailabilityThresholdEnum.md)
- [BuyingOptionDistribution](docs/Model/BuyingOptionDistribution.md)
- [CartItem](docs/Model/CartItem.md)
- [Category](docs/Model/Category.md)
- [CategoryDistribution](docs/Model/CategoryDistribution.md)
- [CommonDescriptions](docs/Model/CommonDescriptions.md)
- [CompatibilityPayload](docs/Model/CompatibilityPayload.md)
- [CompatibilityResponse](docs/Model/CompatibilityResponse.md)
- [CompatibilityStatus](docs/Model/CompatibilityStatus.md)
- [ConditionDistribution](docs/Model/ConditionDistribution.md)
- [ConvertedAmount](docs/Model/ConvertedAmount.md)
- [CountryCodeEnum](docs/Model/CountryCodeEnum.md)
- [CurrencyCodeEnum](docs/Model/CurrencyCodeEnum.md)
- [DeliveryOptionsEnum](docs/Model/DeliveryOptionsEnum.md)
- [Error](docs/Model/Error.md)
- [ErrorDetailV3](docs/Model/ErrorDetailV3.md)
- [ErrorParameter](docs/Model/ErrorParameter.md)
- [ErrorParameterV3](docs/Model/ErrorParameterV3.md)
- [EstimatedAvailability](docs/Model/EstimatedAvailability.md)
- [FilterField](docs/Model/FilterField.md)
- [Image](docs/Model/Image.md)
- [Item](docs/Model/Item.md)
- [ItemGroupSummary](docs/Model/ItemGroupSummary.md)
- [ItemGroupTypeEnum](docs/Model/ItemGroupTypeEnum.md)
- [ItemLocationImpl](docs/Model/ItemLocationImpl.md)
- [ItemReturnTerms](docs/Model/ItemReturnTerms.md)
- [ItemSummary](docs/Model/ItemSummary.md)
- [Items](docs/Model/Items.md)
- [LegalAddress](docs/Model/LegalAddress.md)
- [MarketingPrice](docs/Model/MarketingPrice.md)
- [PickupOptionSummary](docs/Model/PickupOptionSummary.md)
- [Price](docs/Model/Price.md)
- [PriceDisplayConditionEnum](docs/Model/PriceDisplayConditionEnum.md)
- [Product](docs/Model/Product.md)
- [ProductIdentity](docs/Model/ProductIdentity.md)
- [RangeValue](docs/Model/RangeValue.md)
- [RatingHistogram](docs/Model/RatingHistogram.md)
- [Refinement](docs/Model/Refinement.md)
- [RefundMethodEnum](docs/Model/RefundMethodEnum.md)
- [Region](docs/Model/Region.md)
- [RegionTypeEnum](docs/Model/RegionTypeEnum.md)
- [RemoteShopcartResponse](docs/Model/RemoteShopcartResponse.md)
- [RemoveCartItemInput](docs/Model/RemoveCartItemInput.md)
- [ReturnMethodEnum](docs/Model/ReturnMethodEnum.md)
- [ReturnShippingCostPayerEnum](docs/Model/ReturnShippingCostPayerEnum.md)
- [ReviewRating](docs/Model/ReviewRating.md)
- [SearchByImageRequest](docs/Model/SearchByImageRequest.md)
- [SearchPagedCollection](docs/Model/SearchPagedCollection.md)
- [Seller](docs/Model/Seller.md)
- [SellerDetail](docs/Model/SellerDetail.md)
- [SellerLegalInfo](docs/Model/SellerLegalInfo.md)
- [ShipToLocation](docs/Model/ShipToLocation.md)
- [ShipToLocations](docs/Model/ShipToLocations.md)
- [ShippingOption](docs/Model/ShippingOption.md)
- [ShippingOptionSummary](docs/Model/ShippingOptionSummary.md)
- [SortField](docs/Model/SortField.md)
- [TargetLocation](docs/Model/TargetLocation.md)
- [TaxJurisdiction](docs/Model/TaxJurisdiction.md)
- [TaxType](docs/Model/TaxType.md)
- [Taxes](docs/Model/Taxes.md)
- [TimeDuration](docs/Model/TimeDuration.md)
- [TimeDurationUnitEnum](docs/Model/TimeDurationUnitEnum.md)
- [TypedNameValue](docs/Model/TypedNameValue.md)
- [UpdateCartItemInput](docs/Model/UpdateCartItemInput.md)
- [ValueTypeEnum](docs/Model/ValueTypeEnum.md)
- [VatDetail](docs/Model/VatDetail.md)
## Documentation For Authorization
## api_auth
- **Type**: OAuth
- **Flow**: application
- **Authorization URL**:
- **Scopes**:
- **https://api.ebay.com/oauth/api_scope**: View public data from eBay
## bearerAuth
- **Type**: HTTP basic authentication
## Author