README

The Metadata API provides crucial configuration details necessary for managing listings across various eBay marketplaces. This includes retrieving detailed eBay category listing policies, such as supported item conditions and multiple-variation structures; accessing sales tax jurisdiction information for setting up tax tables in supported countries; and obtaining hazardous material and product safety label data for regulatory compliance in listing flows. The API is essential for sellers and developers needing up-to-date, marketplace-specific policy and jurisdictional information to accurately create and manage their listings.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@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\EbayMetadataClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

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


$apiInstance = new OpenAPI\EbayMetadataClient\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=\"/develop/api/sell/request_headers#marketplace-id-values\" target=\"_blank \">Marketplace ID values</a> for a list of supported eBay marketplace ID values.
$content_type = 'content_type_example'; // string | This header indicates the format of the request body provided by the client.<br><br>Its value should be set to <code>application/json</code>.<br><br>For more information, refer to <a href=\"/develop/api/sell/request_headers\" target=\"_blank \">Request Headers</a>.
$specification_request = new \OpenAPI\EbayMetadataClient\Model\SpecificationRequest(); // \OpenAPI\EbayMetadataClient\Model\SpecificationRequest | This type defines the properties and specifications to use to search for compatibilities.

try {
    $result = $apiInstance->getCompatibilitiesBySpecification($x_ebay_c_marketplace_id, $content_type, $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

Models

• AdFormatEnabledEnum
• Amount
• AutomotivePartsCompatibilityPolicy
• AutomotivePartsCompatibilityPolicyResponse
• CardinalityEnum
• CategoryPolicy
• CategoryPolicyResponse
• ClassifiedAdBestOfferEnabledEnum
• ClassifiedAdPaymentMethodEnabledEnum
• ClassifiedAdPolicy
• ClassifiedAdPolicyResponse
• Compatibility
• CompatibilityDetails
• CompatibilityTypeEnum
• CompatibleVehicleTypeEnum
• CountryCodeEnum
• Currency
• CurrencyCodeEnum
• DescriptorUsageEnum
• DisabledProductFilter
• DistanceType
• DurationEnum
• Error
• ErrorDetailV3
• ErrorParameter
• ErrorParameterV3
• ExtendedProducerResponsibility
• ExtendedProducerResponsibilityEnum
• ExtendedProducerResponsibilityPolicy
• ExtendedProducerResponsibilityPolicyResponse
• GenericUsageEnum
• GeographicExposureEnum
• GetCurrenciesResponse
• GetMinimumListingPricePoliciesResponse
• HazardStatement
• HazardousMaterialDetailsResponse
• ItemCondition
• ItemConditionDescriptor
• ItemConditionDescriptorConstraint
• ItemConditionDescriptorValue
• ItemConditionDescriptorValueConstraint
• ItemConditionPolicy
• ItemConditionPolicyResponse
• ListingDuration
• ListingStructurePolicy
• ListingStructurePolicyResponse
• ListingTypeEnum
• ListingTypePoliciesResponse
• ListingTypePolicy
• LocalListingDistance
• MarketplaceIdEnum
• MinimumListingPricePoliciesType
• ModeEnum
• MotorsListingPoliciesResponse
• MotorsListingPolicy
• MultiCompatibilityPropertyValuesRequest
• MultiCompatibilityPropertyValuesResponse
• NegotiatedPricePolicy
• NegotiatedPricePolicyResponse
• PackageLimits
• Pagination
• PaginationInput
• PaymentEnum
• Pictogram
• ProductIdentiferEnabledEnum
• ProductIdentifier
• ProductRequest
• ProductResponse
• ProductResponseCompatibilityDetails
• ProductSafetyLabelPictogram
• ProductSafetyLabelStatement
• ProductSafetyLabelsResponse
• PropertyFilterInner
• PropertyNamesRequest
• PropertyNamesResponse
• PropertyNamesResponseProperties
• PropertyNamesResponsePropertyNameMetadata
• PropertyNamesResponsePropertyNames
• PropertyValues
• PropertyValuesRequest
• PropertyValuesResponse
• RefundMethodEnum
• RegulatoryAttribute
• RegulatoryAttributeEnum
• RegulatoryPolicy
• RegulatoryPolicyResponse
• ReturnMethodEnum
• ReturnPolicy
• ReturnPolicyDetails
• ReturnPolicyResponse
• ReturnShippingCostPayerEnum
• SalesTaxJurisdiction
• SalesTaxJurisdictions
• ShippingCarrier
• ShippingCarrierResponse
• ShippingExcludeLocation
• ShippingExcludeLocationResponse
• ShippingHandlingTime
• ShippingHandlingTimeResponse
• ShippingLocation
• ShippingLocationResponse
• ShippingPoliciesResponse
• ShippingPolicy
• ShippingService
• ShippingServiceResponse
• SignalWord
• SiteVisibilityPoliciesResponse
• SiteVisibilityPolicy
• SortOrderInner
• SortOrderProperties
• SpecificationRequest
• SpecificationResponse
• TimeDuration
• TimeDurationUnitEnum
• UsageEnum

Authorization

api_auth

• Type: OAuth
• Flow: application
• Authorization URL: ``
• Scopes:
  • https://api.ebay.com/oauth/api_scope: View public data from eBay

api_auth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.ebay.com/oauth2/authorize
• Scopes:
  • https://api.ebay.com/oauth/api_scope/sell.inventory: View and manage your inventory and offers

bearerAuth

• Type: Bearer authentication

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.13.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen