<p>The Browse API has the following resources:</p> <ul> <li><b>item_summary: </b> Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters.</li> <li> <a href="

dev-master 2019-03-12 17:11 UTC

This package is auto-updated.

Last update: 2023-03-07 21:26:04 UTC


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 (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 (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 project:

  • API version: v1_beta.19.0
  • Package version: 2.3.2
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen


PHP 5.5 and later

Installation & Usage


To install the bindings via Composer, add the following to composer.json:

  "repositories": [
      "type": "vcs",
      "url": ""
  "require": {
    "macropage/sdk-ebay-rest-browse": "*@dev"

Then run composer install

Manual Installation

Download the files and include autoload.php:



To run the unit tests:

composer install

Getting Started

Please follow the installation procedure and then run the following:

require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: api_auth
$config = macropage\SDKs\ebay\rest\browse\Configuration::getDefaultConfiguration()->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(),
$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: &nbsp;&nbsp;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);
} catch (Exception $e) {
    echo 'Exception when calling ItemApi->checkCompatibility: ', $e->getMessage(), PHP_EOL;


Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
ItemApi checkCompatibility POST /item/{item_id}/check_compatibility
ItemApi getItem GET /item/{item_id}
ItemApi getItemByLegacyId GET /item/get_item_by_legacy_id
ItemApi getItemsByItemGroup GET /item/get_items_by_item_group
ItemSummaryApi search GET /item_summary/search
SearchByImageApi searchByImage POST /item_summary/search_by_image
ShoppingCartApi addItem POST /shopping_cart/add_item
ShoppingCartApi getShoppingCart GET /shopping_cart/
ShoppingCartApi removeItem POST /shopping_cart/remove_item
ShoppingCartApi updateQuantity POST /shopping_cart/update_quantity

Documentation For Models

Documentation For Authorization



  • Type: HTTP basic authentication