nogrod/ebay-sell-metadata-php-sdk

The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces. In addition to marketplace information, the API also has operations that get information that helps sellers list items on eBay.

Maintainers

Details

github.com/Nogrod/ebay-sell-metadata-php-sdk

Homepage

Source

Issues

Installs: 5

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v0.1.2 2025-03-27 14:40 UTC

Requires

Requires (Dev)

unlicense 23445ceb19d03f3288f9901d6ebfc1f46ab146a8

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2025-03-29 09:25:03 UTC

README

The Metadata API has operations that retrieve configuration details pertaining to the different eBay marketplaces. In addition to marketplace information, the API also has operations that get information that helps sellers list items on eBay.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/nogrod/ebay-sell-metadata-php-sdk.git"
    }
  ],
  "require": {
    "nogrod/ebay-sell-metadata-php-sdk": "*@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 = eBay\Sell\Metadata\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: api_auth
$config = eBay\Sell\Metadata\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new eBay\Sell\Metadata\Api\CompatibilitiesApi(
    // 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
);
$x_ebay_c_marketplace_id = 'x_ebay_c_marketplace_id_example'; // string | This header identifies the seller's eBay marketplace.<br><br>See <a href=\"/api-docs/sell/metadata/overview.html#requirements\" target=\"_blank \">Metadata API requirements and restrictions</a> for supported values.
$specification_request = new \eBay\Sell\Metadata\Model\SpecificationRequest(); // \eBay\Sell\Metadata\Model\SpecificationRequest | This type defines the properties and specifications to use to search for compatibilities.

try {
    $result = $apiInstance->getCompatibilitiesBySpecification($x_ebay_c_marketplace_id, $specification_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompatibilitiesApi->getCompatibilitiesBySpecification: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.ebay.com/sell/metadata/v1

Class Method HTTP request Description
CompatibilitiesApi getCompatibilitiesBySpecification POST /compatibilities/get_compatibilities_by_specification
CompatibilitiesApi getCompatibilityPropertyNames POST /compatibilities/get_compatibility_property_names
CompatibilitiesApi getCompatibilityPropertyValues POST /compatibilities/get_compatibility_property_values
CompatibilitiesApi getMultiCompatibilityPropertyValues POST /compatibilities/get_multi_compatibility_property_values
CompatibilitiesApi getProductCompatibilities POST /compatibilities/get_product_compatibilities
CountryApi getSalesTaxJurisdictions GET /country/{countryCode}/sales_tax_jurisdiction
MarketplaceApi getAutomotivePartsCompatibilityPolicies GET /marketplace/{marketplace_id}/get_automotive_parts_compatibility_policies
MarketplaceApi getExtendedProducerResponsibilityPolicies GET /marketplace/{marketplace_id}/get_extended_producer_responsibility_policies
MarketplaceApi getHazardousMaterialsLabels GET /marketplace/{marketplace_id}/get_hazardous_materials_labels
MarketplaceApi getItemConditionPolicies GET /marketplace/{marketplace_id}/get_item_condition_policies
MarketplaceApi getListingStructurePolicies GET /marketplace/{marketplace_id}/get_listing_structure_policies
MarketplaceApi getNegotiatedPricePolicies GET /marketplace/{marketplace_id}/get_negotiated_price_policies
MarketplaceApi getProductSafetyLabels GET /marketplace/{marketplace_id}/get_product_safety_labels
MarketplaceApi getRegulatoryPolicies GET /marketplace/{marketplace_id}/get_regulatory_policies
MarketplaceApi getReturnPolicies GET /marketplace/{marketplace_id}/get_return_policies

Models

Authorization

api_auth

api_auth

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.9.0
    • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen