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.2 and later.

Composer

Regenerate client from openApi specs

docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v5.0.1 generate -i https://developer.ebay.com/api-docs/master/commerce/taxonomy/openapi/3/commerce_taxonomy_v1_oas3.json -g php --git-user-id cdma-numiscorner --git-host github.com --git-repo-id ebay-taxonomy-api --invoker-package 'OpenAPI\EbayTaxonomyApiClient' --artifact-version 1.0 -o /local

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/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 = OpenAPI\EbayTaxonomyApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\EbayTaxonomyApiClient\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
);
$category_tree_id = 'category_tree_id_example'; // string | The unique identifier of the eBay category tree. The category tree ID for an eBay marketplace can be retrieved using the <b>getDefaultCategoryTreeId</b> method.

try {
    $result = $apiInstance->fetchItemAspects($category_tree_id);
    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

Models

• AncestorReference
• Aspect
• AspectConstraint
• AspectMetadata
• AspectValue
• BaseCategoryTree
• Category
• CategoryAspect
• CategorySubtree
• CategorySuggestion
• CategorySuggestionResponse
• CategoryTree
• CategoryTreeNode
• CompatibilityProperty
• CompatibilityPropertyValue
• Error
• ErrorParameter
• GetCategoriesAspectResponse
• GetCompatibilityMetadataResponse
• GetCompatibilityPropertyValuesResponse
• RelevanceIndicator
• ValueConstraint

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.1
  • Package version: 1.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen