README

Use the Taxonomy API to discover the most appropriate eBay categories under which sellers can offer inventory items for sale, and the most likely categories under which buyers can browse or search for items to purchase. In addition, the Taxonomy API provides metadata about the required and recommended category aspects to include in listings, and also has two operations to retrieve parts compatibility information.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/macropage/sdk-ebay-rest-taxonomy.git"
    }
  ],
  "require": {
    "macropage/sdk-ebay-rest-taxonomy": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/sdk-ebay-rest-taxonomy/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure OAuth2 access token for authorization: api_auth
$config = macropage\SDKs\ebay\rest\taxonomy\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new macropage\SDKs\ebay\rest\taxonomy\Api\CategoryTreeApi(
    // 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
);
$categoryTreeId = 'categoryTreeId_example'; // string | The unique identifier of the eBay category tree being requested.

try {
    $result = $apiInstance->fetchItemAspects($categoryTreeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoryTreeApi->fetchItemAspects: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.ebay.com/commerce/taxonomy/v1

Class	Method	HTTP request	Description
CategoryTreeApi	fetchItemAspects	GET /category_tree/{category_tree_id}/fetch_item_aspects	Get Aspects for All Leaf Categories in a Marketplace
CategoryTreeApi	getCategorySubtree	GET /category_tree/{category_tree_id}/get_category_subtree	Get a Category Subtree
CategoryTreeApi	getCategorySuggestions	GET /category_tree/{category_tree_id}/get_category_suggestions	Get Suggested Categories
CategoryTreeApi	getCategoryTree	GET /category_tree/{category_tree_id}	Get a Category Tree
CategoryTreeApi	getCompatibilityProperties	GET /category_tree/{category_tree_id}/get_compatibility_properties	Get Compatibility Properties
CategoryTreeApi	getCompatibilityPropertyValues	GET /category_tree/{category_tree_id}/get_compatibility_property_values	Get Compatibility Property Values
CategoryTreeApi	getDefaultCategoryTreeId	GET /get_default_category_tree_id	Get a Default Category Tree ID
CategoryTreeApi	getItemAspectsForCategory	GET /category_tree/{category_tree_id}/get_item_aspects_for_category

Models

Authorization

api_auth

Type: OAuth
Flow: application
Authorization URL: ``
Scopes:
- https://api.ebay.com/oauth/api_scope: View public data from eBay
- https://api.ebay.com/oauth/api_scope/metadata.insights: View metadata insights such as aspect relevance.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: v1.0.0
- Package version: 2.3.2
Build package: org.openapitools.codegen.languages.PhpClientCodegen

macropage / sdk-ebay-rest-taxonomy

Maintainers

Details