ebay.metadata
Module ebay.metadata
API
Definitions
ballerinax/ebay.metadata Ballerina library
Overview
eBay is a global online marketplace where businesses and individuals buy and sell goods. The eBay Metadata API provides the marketplace-specific configuration that sellers need when creating listings: category listing policies such as supported item conditions and variation support, sales tax jurisdictions, shipping carriers, services and handling times, parts compatibility data, and hazardous material and product safety label information.
The eBay Metadata connector lets Ballerina applications call these operations with typed requests and responses. It supports version 1 of the eBay Metadata API.
Key features
- Retrieve category listing policies: item conditions, listing structure and types, return, shipping, regulatory, motors and site visibility policies
- Look up marketplace currencies, minimum listing prices and sales tax jurisdictions
- List shipping carriers, services, locations, excluded locations and handling times
- Query parts compatibility names, values and products by specification
- Read hazardous material and product safety label information
Setup guide
To use the eBay Metadata connector, you need an eBay developer account and an application keyset. If you do not have a developer account, you can sign up for one.
Step 1: Create an application keyset
-
Sign in to the eBay Developer Program and open Application Keys.
-
Create a keyset for the Production environment and note down the App ID (Client ID) and Cert ID (Client Secret).
Step 2: Choose the OAuth scope
The Metadata API uses the OAuth 2.0 client credentials grant, which returns an application token. The token needs the following scope:
https://api.ebay.com/oauth/api_scope
The connector requests a token from https://api.ebay.com/identity/v1/oauth2/token with your client ID and client secret and renews it when it expires.
Quickstart
To use the eBay Metadata connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the ebay.metadata module.
import ballerinax/ebay.metadata;
Step 2: Instantiate a new connector
- Create a
Config.tomlfile and configure the credentials obtained in the steps above:
clientId = "<Client ID>" clientSecret = "<Client Secret>"
- Create a
metadata:ConnectionConfigwith the OAuth 2.0 client credentials and initialize the connector with it.
configurable string clientId = ?; configurable string clientSecret = ?; final metadata:Client ebay = check new ({ auth: { clientId, clientSecret, scopes: ["https://api.ebay.com/oauth/api_scope"] } });
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Get the default currency of a marketplace
public function main() returns error? { metadata:GetCurrenciesResponse? _ = check ebay->getCurrencies("EBAY_US"); }
Step 4: Run the Ballerina application
bal run
Examples
The eBay Metadata connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
-
Listing policy review - Review the currency, category, item condition, listing structure and return policies that apply to one category.
-
Shipping options overview - List the carriers, handling times and shipping services of a marketplace.
Clients
ebay.metadata: Client
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.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ebay.com/sell/metadata/v1" - URL of the target service
getAutomotivePartsCompatibilityPolicies
function getAutomotivePartsCompatibilityPolicies(string marketplaceId, GetAutomotivePartsCompatibilityPoliciesHeaders headers, *GetAutomotivePartsCompatibilityPoliciesQueries queries) returns AutomotivePartsCompatibilityPolicyResponse|error?Get automotive parts compatibility policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved.
Note: Only the following eBay marketplaces support automotive parts compatibility:
- EBAY_MOTORS_US
- EBAY_AU
- EBAY_CA
- EBAY_DE
- EBAY_ES
- EBAY_FR
- EBAY_GB
- EBAY_IT
- headers GetAutomotivePartsCompatibilityPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetAutomotivePartsCompatibilityPoliciesQueries - Queries to be sent with the request
Return Type
- AutomotivePartsCompatibilityPolicyResponse|error? - The retrieved automotive parts compatibility policies
getCategoryPolicies
function getCategoryPolicies(string marketplaceId, GetCategoryPoliciesHeaders headers, *GetCategoryPoliciesQueries queries) returns CategoryPolicyResponse|error?Get category policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetCategoryPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetCategoryPoliciesQueries - Queries to be sent with the request
Return Type
- CategoryPolicyResponse|error? - The retrieved category policies
getClassifiedAdPolicies
function getClassifiedAdPolicies(string marketplaceId, GetClassifiedAdPoliciesHeaders headers, *GetClassifiedAdPoliciesQueries queries) returns ClassifiedAdPolicyResponse|error?Get classified ad policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Marketplace ID values for a list of supported eBay marketplace ID values
- headers GetClassifiedAdPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetClassifiedAdPoliciesQueries - Queries to be sent with the request
Return Type
- ClassifiedAdPolicyResponse|error? - The retrieved classified ad policies
getCurrencies
function getCurrencies(string marketplaceId, GetCurrenciesHeaders headers) returns GetCurrenciesResponse|error?Get marketplace currencies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which currency information is retrieved. See the Marketplace ID values type for a list of supported eBay marketplace ID values
- headers GetCurrenciesHeaders (default {}) - Headers to be sent with the request
Return Type
- GetCurrenciesResponse|error? - The retrieved currencies
getExtendedProducerResponsibilityPolicies
function getExtendedProducerResponsibilityPolicies(string marketplaceId, GetExtendedProducerResponsibilityPoliciesHeaders headers, *GetExtendedProducerResponsibilityPoliciesQueries queries) returns ExtendedProducerResponsibilityPolicyResponse|error?Get extended producer responsibility policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information shall be retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetExtendedProducerResponsibilityPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetExtendedProducerResponsibilityPoliciesQueries - Queries to be sent with the request
Return Type
- ExtendedProducerResponsibilityPolicyResponse|error? - The retrieved extended producer responsibility policies
getHazardousMaterialsLabels
function getHazardousMaterialsLabels(string marketplaceId, GetHazardousMaterialsLabelsHeaders headers) returns HazardousMaterialDetailsResponse|error?Get hazardous materials labels
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which hazardous materials label information shall be retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetHazardousMaterialsLabelsHeaders (default {}) - Headers to be sent with the request
Return Type
- HazardousMaterialDetailsResponse|error? - The retrieved hazardous materials labels
getItemConditionPolicies
function getItemConditionPolicies(string marketplaceId, GetItemConditionPoliciesHeaders headers, *GetItemConditionPoliciesQueries queries) returns ItemConditionPolicyResponse|error?Get item condition policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetItemConditionPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetItemConditionPoliciesQueries - Queries to be sent with the request
Return Type
- ItemConditionPolicyResponse|error? - The retrieved item condition policies
getListingStructurePolicies
function getListingStructurePolicies(string marketplaceId, GetListingStructurePoliciesHeaders headers, *GetListingStructurePoliciesQueries queries) returns ListingStructurePolicyResponse|error?Get listing structure policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetListingStructurePoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetListingStructurePoliciesQueries - Queries to be sent with the request
Return Type
- ListingStructurePolicyResponse|error? - The retrieved listing structure policies
getListingTypePolicies
function getListingTypePolicies(string marketplaceId, GetListingTypePoliciesHeaders headers, *GetListingTypePoliciesQueries queries) returns ListingTypePoliciesResponse|error?Get listing type policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetListingTypePoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetListingTypePoliciesQueries - Queries to be sent with the request
Return Type
- ListingTypePoliciesResponse|error? - The retrieved listing type policies
getMinimumListingPricePolicies
function getMinimumListingPricePolicies(string marketplaceId, map<string|string[]> headers) returns GetMinimumListingPricePoliciesResponse|error?Get minimum listing price policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which minimum listing price policy information will be retrieved. See Marketplace ID values for a list of supported eBay marketplace ID values.
Return Type
- GetMinimumListingPricePoliciesResponse|error? - The retrieved minimum listing price policies
getMotorsListingPolicies
function getMotorsListingPolicies(string marketplaceId, GetMotorsListingPoliciesHeaders headers, *GetMotorsListingPoliciesQueries queries) returns MotorsListingPoliciesResponse|error?Get eBay Motors listing policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetMotorsListingPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetMotorsListingPoliciesQueries - Queries to be sent with the request
Return Type
- MotorsListingPoliciesResponse|error? - The retrieved motors listing policies
getNegotiatedPricePolicies
function getNegotiatedPricePolicies(string marketplaceId, GetNegotiatedPricePoliciesHeaders headers, *GetNegotiatedPricePoliciesQueries queries) returns NegotiatedPricePolicyResponse|error?Get negotiated price policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetNegotiatedPricePoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetNegotiatedPricePoliciesQueries - Queries to be sent with the request
Return Type
- NegotiatedPricePolicyResponse|error? - The retrieved negotiated price policies
getProductSafetyLabels
function getProductSafetyLabels(string marketplaceId, map<string|string[]> headers) returns ProductSafetyLabelsResponse|error?Get product safety labels
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values. See the following note for exceptions.Note: This method is not supported in the EBAY_HK, EBAY_MY, EBAY_TW, or EBAY_PH marketplaces.
Return Type
- ProductSafetyLabelsResponse|error? - The retrieved product safety labels
getRegulatoryPolicies
function getRegulatoryPolicies(string marketplaceId, GetRegulatoryPoliciesHeaders headers, *GetRegulatoryPoliciesQueries queries) returns RegulatoryPolicyResponse|error?Get regulatory policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information shall be retrieved. See Request Headers for a list of supported eBay marketplace ID values.Note: This method is not supported in the EBAY_HK, EBAY_MY, EBAY_TW, or EBAY_PH marketplaces.
- headers GetRegulatoryPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetRegulatoryPoliciesQueries - Queries to be sent with the request
Return Type
- RegulatoryPolicyResponse|error? - The retrieved regulatory policies
getReturnPolicies
function getReturnPolicies(string marketplaceId, GetReturnPoliciesHeaders headers, *GetReturnPoliciesQueries queries) returns ReturnPolicyResponse|error?Get return policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetReturnPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetReturnPoliciesQueries - Queries to be sent with the request
Return Type
- ReturnPolicyResponse|error? - The retrieved return policies
getShippingPolicies
function getShippingPolicies(string marketplaceId, GetShippingPoliciesHeaders headers, *GetShippingPoliciesQueries queries) returns ShippingPoliciesResponse|error?Get shipping policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetShippingPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetShippingPoliciesQueries - Queries to be sent with the request
Return Type
- ShippingPoliciesResponse|error? - The retrieved shipping policies
getSiteVisibilityPolicies
function getSiteVisibilityPolicies(string marketplaceId, GetSiteVisibilityPoliciesHeaders headers, *GetSiteVisibilityPoliciesQueries queries) returns SiteVisibilityPoliciesResponse|error?Get site visibility policies
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which policy information is retrieved. See Request Headers for a list of supported eBay marketplace ID values
- headers GetSiteVisibilityPoliciesHeaders (default {}) - Headers to be sent with the request
- queries *GetSiteVisibilityPoliciesQueries - Queries to be sent with the request
Return Type
- SiteVisibilityPoliciesResponse|error? - The retrieved site visibility policies
getCompatibilitiesBySpecification
function getCompatibilitiesBySpecification(GetCompatibilitiesBySpecificationHeaders headers, SpecificationRequest payload) returns SpecificationResponse|error?Get compatibilities by specification
Parameters
- headers GetCompatibilitiesBySpecificationHeaders - Headers to be sent with the request
- payload SpecificationRequest - This type defines the properties and specifications to use to search for compatibilities
Return Type
- SpecificationResponse|error? - The retrieved compatibilities by specification
getCompatibilityPropertyNames
function getCompatibilityPropertyNames(GetCompatibilityPropertyNamesHeaders headers, PropertyNamesRequest payload) returns PropertyNamesResponse|error?Get compatibility property names
Parameters
- headers GetCompatibilityPropertyNamesHeaders - Headers to be sent with the request
- payload PropertyNamesRequest - This type defines the properties used to retrieve compatibility property names
Return Type
- PropertyNamesResponse|error? - The retrieved compatibility property names
getCompatibilityPropertyValues
function getCompatibilityPropertyValues(GetCompatibilityPropertyValuesHeaders headers, PropertyValuesRequest payload) returns PropertyValuesResponse|error?Get compatibility property values
Parameters
- headers GetCompatibilityPropertyValuesHeaders - Headers to be sent with the request
- payload PropertyValuesRequest - This type defines the category ID and property name for which to retrieve values
Return Type
- PropertyValuesResponse|error? - The retrieved compatibility property values
getMultiCompatibilityPropertyValues
function getMultiCompatibilityPropertyValues(GetMultiCompatibilityPropertyValuesHeaders headers, MultiCompatibilityPropertyValuesRequest payload) returns MultiCompatibilityPropertyValuesResponse|error?Get multiple compatibility property values
Parameters
- headers GetMultiCompatibilityPropertyValuesHeaders - Headers to be sent with the request
- payload MultiCompatibilityPropertyValuesRequest - This type defines the category ID and property names for which to retrieve values
Return Type
- MultiCompatibilityPropertyValuesResponse|error? - The retrieved multi compatibility property values
getProductCompatibilities
function getProductCompatibilities(GetProductCompatibilitiesHeaders headers, ProductRequest payload) returns ProductResponse|error?Get product compatibilities
Parameters
- headers GetProductCompatibilitiesHeaders - Headers to be sent with the request
- payload ProductRequest - This type defines properties for which to find compatibilities
Return Type
- ProductResponse|error? - The retrieved product compatibilities
getExcludeShippingLocations
function getExcludeShippingLocations(string marketplaceId, GetExcludeShippingLocationsHeaders headers) returns ShippingExcludeLocationResponse|errorGet excluded shipping locations
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which excluded shipping locations information is retrieved. See Marketplace ID values for supported eBay marketplace ID values. Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.
- headers GetExcludeShippingLocationsHeaders (default {}) - Headers to be sent with the request
Return Type
- ShippingExcludeLocationResponse|error - The retrieved exclude shipping locations
getHandlingTimes
function getHandlingTimes(string marketplaceId, GetHandlingTimesHeaders headers) returns ShippingHandlingTimeResponse|errorGet handling times
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which handling times information is retrieved. See Marketplace ID values for supported eBay marketplace ID values. Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.
- headers GetHandlingTimesHeaders (default {}) - Headers to be sent with the request
Return Type
- ShippingHandlingTimeResponse|error - The retrieved handling times
getShippingCarriers
function getShippingCarriers(string marketplaceId, GetShippingCarriersHeaders headers) returns ShippingCarrierResponse|errorGet shipping carriers
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which shipping carriers information is retrieved. See Marketplace ID values for supported eBay marketplace ID values. Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.
- headers GetShippingCarriersHeaders (default {}) - Headers to be sent with the request
Return Type
- ShippingCarrierResponse|error - The retrieved shipping carriers
getShippingLocations
function getShippingLocations(string marketplaceId, GetShippingLocationsHeaders headers) returns ShippingLocationResponse|errorGet shipping locations
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which shipping locations information is retrieved. See Marketplace ID values for supported eBay marketplace ID values. Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.
- headers GetShippingLocationsHeaders (default {}) - Headers to be sent with the request
Return Type
- ShippingLocationResponse|error - The retrieved shipping locations
getShippingServices
function getShippingServices(string marketplaceId, GetShippingServicesHeaders headers) returns ShippingServiceResponse|errorGet shipping services
Parameters
- marketplaceId string - This path parameter specifies the eBay marketplace for which shipping services information is retrieved. See Marketplace ID values for supported eBay marketplace ID values. Note: When listing the items on the French Canada, French Belgium, and Dutch Belgium marketplaces, also set the Accept-Language header as needed.
- headers GetShippingServicesHeaders (default {}) - Headers to be sent with the request
Return Type
- ShippingServiceResponse|error - The retrieved shipping services
getSalesTaxJurisdictions
function getSalesTaxJurisdictions(string countryCode, map<string|string[]> headers) returns SalesTaxJurisdictions|errorGet sales tax jurisdictions
Parameters
- countryCode string - This path parameter specifies the two-letter ISO 3166 country code for the country whose jurisdictions you want to retrieve.
Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:
- US
- CA
Return Type
- SalesTaxJurisdictions|error - The retrieved sales tax jurisdictions
Records
ebay.metadata: Amount
The type that defines the fields for the currency and a monetary amount
Fields
- currency? CurrencyCodeEnum - The three-letter ISO 4217 code representing a world currency. | - AED: United Arab Emirates dirham - AFN: Afghan afghani - ALL: Albanian lek - AMD: Armenian dram - ANG: Netherlands Antillean guilder - AOA: Angolan kwanza - ARS: Argentine peso - AUD: Australian dollar - AWG: Aruban florin - AZN: Azerbaijani manat - BAM: Bosnia and Herzegovina convertible mark - BBD: Barbados dollar - BDT: Bangladeshi taka - BGN: Bulgarian lev - BHD: Bahraini dinar - BIF: Burundian franc - BMD: Bermudian dollar - BND: Brunei dollar - BOB: Bolivian Boliviano - BRL: Brazilian real - BSD: Bahamian dollar - BTN: Bhutanese ngultrum - BWP: Botswana pula - BYR: Belarusian ruble - BZD: Belize dollar - CAD: Canadian dollar - CDF: Congolese franc - CHF: Swiss franc - CLP: Chilean peso - CNY: Chinese yuan renminbi - COP: Colombian peso - CRC: Costa Rican colon - CUP: Cuban peso - CVE: Cape Verde escudo - CZK: Czech koruna - DJF: Djiboutian franc - DKK: Danish krone - DOP: Dominican peso - DZD: Algerian dinar - EGP: Egyptian pound - ERN: Eritrean nakfa - ETB: Ethiopian birr - EUR: European Union euro - FJD: Fiji dollar - FKP: Falkland Islands pound - GBP: British pound sterling - GEL: Georgian lari - GHS: Ghanaian cedi - GIP: Gibraltar pound - GMD: Gambian dalasi - GNF: Guinean franc - GTQ: Guatemalan quetzal - GYD: Guyanese dollar - HKD: Hong Kong dollar - HNL: Honduran lempira - HRK: Croatian kuna - HTG: Haitian gourde - HUF: Hungarian forint - IDR: Indonesian rupiah - ILS: Israeli new shekel - INR: Indian rupee - IQD: Iraqi dinar - IRR: Iranian rial - ISK: Icelandic krona - JMD: Jamaican dollar - JOD: Jordanian dinar - JPY: Japanese yen - KES: Kenyan shilling - KGS: Kyrgyzstani som - KHR: Cambodian riel - KMF: Comoro franc - KPW: North Korean won - KRW: South Korean won - KWD: Kuwaiti dinar - KYD: Cayman Islands dollar - KZT: Kazakhstani tenge - LAK: Lao kip - LBP: Lebanese pound - LKR: Sri Lankan rupee - LRD: Liberian dollar - LSL: Lesotho loti - LTL: Lithuanian litas - LYD: Libyan dinar - MAD: Moroccan dirham - MDL: Moldovan leu - MGA: Malagasy ariary - MKD: Macedonian denar - MMK: Myanmar kyat - MNT: Mongolian tugrik - MOP: Macanese pataca - MRO: Mauritanian ouguiya - MUR: Mauritian rupee - MVR: Maldivian rufiyaa - MWK: Malawian kwacha - MXN: Mexican peso - MYR: Malaysian ringgit - MZN: Mozambican metical - NAD: Namibian dollar - NGN: Nigerian naira - NIO: Nicaraguan cordoba oro - NOK: Norwegian krone - NPR: Nepalese rupee - NZD: New Zealand dollar - OMR: Omani rial - PAB: Panamanian balboa - PEN: Peruvian sol - PGK: Papua New Guinean kina - PHP: Philippine peso - PKR: Pakistani rupee - PLN: Polish zloty - PYG: Paraguayan guarani - QAR: Qatari riyal - RON: Romanian leu - RSD: Serbian dinar - RUB: Russian ruble - RWF: Rwandan franc - SAR: Saudi riyal - SBD: Solomon Islands dollar - SCR: Seychelles rupee - SDG: Sudanese pound - SEK: Swedish krona - SGD: Singapore dollar - SHP: Saint Helena pound - SLL: Sierra Leonean leone - SOS: Somali shilling - SRD: Surinamese dollar - STD: Sao Tome and Principe dobra - SYP: Syrian pound - SZL: Swazi lilangeni - THB: Thai baht - TJS: Tajikistani somoni - TMT: Turkmenistani manat - TND: Tunisian dinar - TOP: Tongan pa'anga - TRY: Turkish lira - TTD: Trinidad and Tobago dollar - TWD: New Taiwan dollar - TZS: Tanzanian shilling - UAH: Ukrainian hryvnia - UGX: Ugandan shilling - USD: United States dollar - UYU: Uruguayan peso - UZS: Uzbekistani som - VEF: Venezuelan bolivar - VND: Vietnamese dong - VUV: Vanuatu vatu - WST: Samoan tala - XAF: CFA franc BEAC - XCD: East Caribbean dollar - XOF: CFA franc BCEAO - XPF: CFP franc - YER: Yemeni rial - ZAR: South African rand - ZMW: Zambian kwacha - ZWL: Zimbabwean dollar
- value? string - The monetary amount, in the currency specified by the currency field
ebay.metadata: AutomotivePartsCompatibilityPolicy
This type contains applicable compatibility policy metadata for the leaf categories returned for the marketplace
Fields
- compatibilityBasedOn? CompatibilityTypeEnum - This enumerated type defines how the compatibility details are listed on the specified category. | - SPECIFICATIONS: The compatibility details are listed by the specifications of the part. For example, dimensions or other defining characteristics of the part. - ASSEMBLY: The compatibility details are listed by by the vehicle assembly information, such as make, model, year of production, and so on
- categoryTreeId string - A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes
- compatibleVehicleTypes CompatibleVehicleTypeEnum[] - Indicates the compatibility classification of the part based on high-level vehicle types
- maxNumberOfCompatibleVehicles Signed32 - Specifies the maximum number of compatible vehicle-applications allowed per item
- categoryId string - The category ID to which the automotive parts compatibility policies apply
ebay.metadata: AutomotivePartsCompatibilityPolicyResponse
The base response type of the AutomotivePartsCompatibilityPolicy method
Fields
- automotivePartsCompatibilityPolicies? AutomotivePartsCompatibilityPolicy[] - A list of category IDs and the automotive parts compatibility policies for each of the listed categories
- warnings? ErrorDetailV3[] - A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
ebay.metadata: CategoryPolicy
This type contains applicable policy metadata for the leaf categories returned for the marketplace
Fields
- orpa? boolean - This field (Override Reserve Price Allowed) is returned as true if the eBay marketplace's default policy is to allow reserve prices for auction listings, but the corresponding category does not allow a reserve price. This field is not returned if the marketplace does not permit reserve prices
- reservePriceAllowed? boolean - This field indicates whether reserve prices are allowed for auction listings in this category. This field returns as true when the category supports reserve prices, or false if the eBay marketplace does not permit reserve prices or the category override blocks reserve prices (orpa is true)
- virtual? boolean - If this field is returned as true, the corresponding category is an eBay virtual category, a category in which items may not be listed. This field is not returned when false
- autoPayEnabled? boolean - If this field is returned as true, the corresponding category supports immediate payment for listings. The immediate payment feature is applicable to fixed-price listings, to auction listings with the Buy It Now option enabled, and for a motor vehicle listing that requires an initial deposit. If the immediate payment feature is enabled for a listing, the buyer must pay immediately after clicking the 'Buy it Now' button. This field is only returned when true
- orra? boolean - If this field (Override Reduce Reserve Allowed) is returned as true, the seller can reduce or remove a reserve price that had already been reduced for an active auction listing
- upcSupport? ProductIdentifierEnabledEnum - This enumerated type specifies whether a leaf category supports or requires a Universal Product Code (UPC), International Standard Book Number (ISBN), or European Article Number (EAN) for products. Collectively, these identifiers are referred to as Global Trade Item Numbers (GTINs). | - DISABLED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is not supported for the leaf category. - ENABLED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is supported as applicable, but not required for the leaf category - REQUIRED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is required for the leaf category, and an Add/Revise operation will fail without this information
- eanSupport? ProductIdentifierEnabledEnum - This enumerated type specifies whether a leaf category supports or requires a Universal Product Code (UPC), International Standard Book Number (ISBN), or European Article Number (EAN) for products. Collectively, these identifiers are referred to as Global Trade Item Numbers (GTINs). | - DISABLED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is not supported for the leaf category. - ENABLED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is supported as applicable, but not required for the leaf category - REQUIRED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is required for the leaf category, and an Add/Revise operation will fail without this information
- isbnSupport? ProductIdentifierEnabledEnum - This enumerated type specifies whether a leaf category supports or requires a Universal Product Code (UPC), International Standard Book Number (ISBN), or European Article Number (EAN) for products. Collectively, these identifiers are referred to as Global Trade Item Numbers (GTINs). | - DISABLED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is not supported for the leaf category. - ENABLED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is supported as applicable, but not required for the leaf category - REQUIRED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is required for the leaf category, and an Add/Revise operation will fail without this information
- reduceReserveAllowed? boolean - If true, ReduceReserveAllowed indicates that all categories on the site allow the seller to reduce an item's reserve price. If false, this field is not returned in the response and all categories on the site do not normally allow sellers to reduce an item's reserve price. The Category ORRA (override reduce reserve price) field can override (or toggle) the reserve price reduction setting for a given category
- valueCategory boolean - When returned as true, this boolean indicates that the leaf category for the specified site is designated by eBay as a value category. Value categories can be used as a secondary category for a listing at no extra charge
- expired? boolean - If this field is returned as true, the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. This field is not returned when false
- categoryTreeId string - The unique identifier of the category tree
- paymentMethods? PaymentEnum[] - An array that indicates the acceptable offline payment methods that can be used when listing an item for sale in the corresponding category
- intangibleEnabled? boolean - If this field is returned as true, the category supports the listing of intangible goods or services
- b2bVatEnabled? boolean - If this field is returned as true, the corresponding category supports business-to-business (B2B) VAT listings. If this field is not present, the category does not B2B VAT listings. This field is not returned when false. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only
- minimumReservePrice? decimal - Indicates the Minimum Reserve Price for an auction listing in this category. If there is no Minimum Reserve Price, a value of 0.0 is returned in this field
- lsd? boolean - If this field (Lot Size Disabled) is returned as true, the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction. This field is only returned when true (not returned when false).
- categoryId string - The unique identifier of the eBay leaf category for which metadata is being returned
ebay.metadata: CategoryPolicyResponse
This type contains applicable policy metadata for the leaf categories returned for the marketplace
Fields
- warnings? ErrorDetailV3[] - An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
- categoryPolicies CategoryPolicy[] - This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter
ebay.metadata: ClassifiedAdPolicy
This type provides fields that contain applicable Classified Ad policy metadata for the leaf categories returned for the marketplace
Fields
- classifiedAdAutoAcceptEnabled? boolean - Indicates whether the category supports the Best Offer Automatic Accept feature for Classified Ad listings
- classifiedAdBestOfferEnabled? ClassifiedAdBestOfferEnabledEnum - This enumerated type defines values that indicate whether the category supports Classified Ad Best Offers. | - DISABLED: This value indicates that Classified Ad Best Offer feature is disabled for most categories. - ENABLED: This value indicates that Classified Ad Best Offer feature is enabled for most categories. - REQUIRED: This value indicates that Classified Ad Best Offer feature is required for a specific category.
- classifiedAdCompanyNameEnabled? boolean - Indicates whether this category supports including a company name in the seller's contact information. This element is for For Sale By Owner listings
- classifiedAdContactByAddressEnabled? boolean - Indicates whether this category supports including an address in the seller's contact information. This element is for For Sale By Owner listings
- classifiedAdShippingMethodEnabled? boolean - Indicates if shipping methods can be specified and displayed in the View Item page for the category
- classifiedAdContactByPhoneEnabled? boolean - Indicates whether most categories support including a phone number in the seller's contact information
- classifiedAdCounterOfferEnabled? boolean - Indicates whether counter offers are allowed on Best Offers for most categories
- classifiedAdPhoneCount? Signed32 - Indicates how many contact phone numbers can be specified in contact information for the category. This element is for For Sale By Owner listings
- classifiedAdAutoDeclineEnabled? boolean - Indicates whether the category supports the Best Offer Automatic Reject feature for Classified Ad listings
- sellerContactDetailsEnabled? boolean - Indicates whether this category supports seller-level contact information for Classified Ad listings
- categoryTreeId string - The unique identifier of the category tree
- classifiedAdPaymentMethodEnabled? ClassifiedAdPaymentMethodEnabledEnum - This enumerated type defines values that indicate whether the payment method will be displayed for a category. | - ENABLED_WITH_CHECKOUT: This value indicates display of the payment method and permits checkout. - ENABLED_WITHOUT_CHECKOUT: This value indicates display of the payment method and suppresses checkout. - NOT_SUPPORTED: This value indicates the payment method is not displayed
- classifiedAdContactByEmailEnabled? boolean - Indicates whether most categories support including an email address in the seller's contact information
- adFormatEnabled? AdFormatEnabledEnum - This enumerated type contains a list of values indicating type or status of available ad formats for an eBay site or for an eBay category. | - DISABLED: This value indicates that the Classified Ad format feature is disabled for the site or category. - ENABLED: This value indicates that the Classified Ad format feature is enabled for the site or category. - ONLY: This value indicates that the Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - CLASSIFIED_AD_ENABLED: This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - CLASSIFIED_AD_ONLY: This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - LOCAL_MARKET_BEST_OFFER_ONLY: This value indicates that eBay Motors Local Market listings are enabled for the site or category
- categoryId string - The unique identifier of the eBay leaf category for which metadata is being returned
- classifiedAdStreetCount? Signed32 - Indicates how many street addresses can be specified in contact information for the category. This element is for For Sale By Owner listings
ebay.metadata: ClassifiedAdPolicyResponse
This type contains applicable policy metadata for the leaf categories returned for the marketplace
Fields
- warnings? ErrorDetailV3[] - An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
- classifiedAdPolicies ClassifiedAdPolicy[] - This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter
ebay.metadata: Compatibility
This type defines the property names and values that are compatible with the property name values specified in the request
Fields
- compatibilityDetails? CompatibilityDetails[] - This array returns a list of compatibility details associated with the specified property name(s)
ebay.metadata: CompatibilityDetails
This type defines the compatible property names and values associated with the product
Fields
- propertyName? string - The name of the property being described
- propertyValue? string - The value for the property specified in the propertyName field
ebay.metadata: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
ebay.metadata: Currency
The type defining valid currencies for the marketplace
Fields
- code CurrencyCodeEnum - The three-letter ISO 4217 code representing a world currency. | - AED: United Arab Emirates dirham - AFN: Afghan afghani - ALL: Albanian lek - AMD: Armenian dram - ANG: Netherlands Antillean guilder - AOA: Angolan kwanza - ARS: Argentine peso - AUD: Australian dollar - AWG: Aruban florin - AZN: Azerbaijani manat - BAM: Bosnia and Herzegovina convertible mark - BBD: Barbados dollar - BDT: Bangladeshi taka - BGN: Bulgarian lev - BHD: Bahraini dinar - BIF: Burundian franc - BMD: Bermudian dollar - BND: Brunei dollar - BOB: Bolivian Boliviano - BRL: Brazilian real - BSD: Bahamian dollar - BTN: Bhutanese ngultrum - BWP: Botswana pula - BYR: Belarusian ruble - BZD: Belize dollar - CAD: Canadian dollar - CDF: Congolese franc - CHF: Swiss franc - CLP: Chilean peso - CNY: Chinese yuan renminbi - COP: Colombian peso - CRC: Costa Rican colon - CUP: Cuban peso - CVE: Cape Verde escudo - CZK: Czech koruna - DJF: Djiboutian franc - DKK: Danish krone - DOP: Dominican peso - DZD: Algerian dinar - EGP: Egyptian pound - ERN: Eritrean nakfa - ETB: Ethiopian birr - EUR: European Union euro - FJD: Fiji dollar - FKP: Falkland Islands pound - GBP: British pound sterling - GEL: Georgian lari - GHS: Ghanaian cedi - GIP: Gibraltar pound - GMD: Gambian dalasi - GNF: Guinean franc - GTQ: Guatemalan quetzal - GYD: Guyanese dollar - HKD: Hong Kong dollar - HNL: Honduran lempira - HRK: Croatian kuna - HTG: Haitian gourde - HUF: Hungarian forint - IDR: Indonesian rupiah - ILS: Israeli new shekel - INR: Indian rupee - IQD: Iraqi dinar - IRR: Iranian rial - ISK: Icelandic krona - JMD: Jamaican dollar - JOD: Jordanian dinar - JPY: Japanese yen - KES: Kenyan shilling - KGS: Kyrgyzstani som - KHR: Cambodian riel - KMF: Comoro franc - KPW: North Korean won - KRW: South Korean won - KWD: Kuwaiti dinar - KYD: Cayman Islands dollar - KZT: Kazakhstani tenge - LAK: Lao kip - LBP: Lebanese pound - LKR: Sri Lankan rupee - LRD: Liberian dollar - LSL: Lesotho loti - LTL: Lithuanian litas - LYD: Libyan dinar - MAD: Moroccan dirham - MDL: Moldovan leu - MGA: Malagasy ariary - MKD: Macedonian denar - MMK: Myanmar kyat - MNT: Mongolian tugrik - MOP: Macanese pataca - MRO: Mauritanian ouguiya - MUR: Mauritian rupee - MVR: Maldivian rufiyaa - MWK: Malawian kwacha - MXN: Mexican peso - MYR: Malaysian ringgit - MZN: Mozambican metical - NAD: Namibian dollar - NGN: Nigerian naira - NIO: Nicaraguan cordoba oro - NOK: Norwegian krone - NPR: Nepalese rupee - NZD: New Zealand dollar - OMR: Omani rial - PAB: Panamanian balboa - PEN: Peruvian sol - PGK: Papua New Guinean kina - PHP: Philippine peso - PKR: Pakistani rupee - PLN: Polish zloty - PYG: Paraguayan guarani - QAR: Qatari riyal - RON: Romanian leu - RSD: Serbian dinar - RUB: Russian ruble - RWF: Rwandan franc - SAR: Saudi riyal - SBD: Solomon Islands dollar - SCR: Seychelles rupee - SDG: Sudanese pound - SEK: Swedish krona - SGD: Singapore dollar - SHP: Saint Helena pound - SLL: Sierra Leonean leone - SOS: Somali shilling - SRD: Surinamese dollar - STD: Sao Tome and Principe dobra - SYP: Syrian pound - SZL: Swazi lilangeni - THB: Thai baht - TJS: Tajikistani somoni - TMT: Turkmenistani manat - TND: Tunisian dinar - TOP: Tongan pa'anga - TRY: Turkish lira - TTD: Trinidad and Tobago dollar - TWD: New Taiwan dollar - TZS: Tanzanian shilling - UAH: Ukrainian hryvnia - UGX: Ugandan shilling - USD: United States dollar - UYU: Uruguayan peso - UZS: Uzbekistani som - VEF: Venezuelan bolivar - VND: Vietnamese dong - VUV: Vanuatu vatu - WST: Samoan tala - XAF: CFA franc BEAC - XCD: East Caribbean dollar - XOF: CFA franc BCEAO - XPF: CFP franc - YER: Yemeni rial - ZAR: South African rand - ZMW: Zambian kwacha - ZWL: Zimbabwean dollar
- description string - The description of the returned three-letter code. For example, if the code is USD, the description returned would be US Dollar
ebay.metadata: DisabledProductFilter
This type defines the booleans used to determine if a product is excluded from eBay selling and/or review
Fields
- excludeForEbaySelling? boolean - Specifies whether to filter out products excluded for eBay selling. If set to true, items excluded from eBay selling are not returned
- excludeForEbayReviews? boolean - Specifies whether to filter out products excluded for eBay reviews. If set to true, items excluded from eBay reviews are not returned
ebay.metadata: ErrorDetailV3
This type defines the elements of error and warning messages
Fields
- domain? string - Name of the domain containing the service or application
- subdomain? string - Name of the domain's subsystem or subdivision. For example, checkout is a subdomain in the buying domain
- outputRefIds? string[] - Identifies specific response elements associated with the error, if any. Path format is the same as inputRefId
- errorId? Signed32 - A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms
- inputRefIds? string[] - Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation
- category? string - The category type for this error or warning. It takes an ErrorCategory object which can have one of three values:
- Application: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.
- Business: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.
- Request: Used when there is anything wrong with the request, such as authentication, syntactical errors, rate limiting or missing headers, bad HTTP header values, and so on.
- longMessage? string - An expanded version of message that should be around 100-200 characters long, but is not required to be such
- message? string - An end user and app developer friendly device agnostic message. It explains what the error or warning is, and how to fix it (in a general sense). Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale
- parameters? ErrorParameterV3[] - This optional complex field type contains a list of one or more context-specific ErrorParameter objects, with each item in the list entry being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value
ebay.metadata: ErrorParameterV3
This type defines error parameters
Fields
- name? string - Name of the entity that threw the error
- value? string - A description of the error
ebay.metadata: ExtendedProducerResponsibility
A type that defines the attributes of an Extended Producer Responsibility policy
Fields
- usage GenericUsageEnum - An enumerated type that indicates whether an Extended Producer Responsibility attribute is optional, recommended, or required. | - OPTIONAL: This enum value indicates that the attribute is optional. - RECOMMENDED: This enum value indicates that the attribute is recommended. - REQUIRED: This enum value indicates that the attribute is required
- name ExtendedProducerResponsibilityEnum - An enumerated type that identifies the attributes used in Extended Producer Responsibility policies.Note: Extended Producer Responsibility IDs are no longer set at the listing level so category-level metadata is no longer returned for PRODUCER_PRODUCT_ID, PRODUCT_DOCUMENTATION_ID, PRODUCT_PACKAGE_ID, and SHIPMENT_PACKAGE_ID. Sellers will provide/manage these IDs at the account level by going to Account Settings. | - ECO_PARTICIPATION_FEE: This enum value is used to identify the eco participation fee attribute. - TAKE_BACK_POLICY: This enum value is used to identify the take-back policy attribute. - REPAIR_SCORE: This enum value is used to identify the repair score attribute.
- enabledForVariations boolean - An indication of whether the attribute can be enabled for listing variations. If the value is true, the attribute may be specified at the variation level
ebay.metadata: ExtendedProducerResponsibilityPolicy
A type that defines the Extended Producer Responsibility policy
Fields
- categoryTreeId string - The unique identifier for the category tree under which the policy applies
- supportedAttributes ExtendedProducerResponsibility[] - The details regarding the attributes included in the policy, such as their usage guidelines and whether they can be specified at the listing variation level
- categoryId string - The unique identifier for the category under which the policy applies
ebay.metadata: ExtendedProducerResponsibilityPolicyResponse
A type that defines the response fields for the getExtendedProducerResponsibilityPolicies method
Fields
- extendedProducerResponsibilities ExtendedProducerResponsibilityPolicy[] - An array of response fields detailing the Extended Producer Responsibility policies supported for the specified marketplace
- warnings? ErrorDetailV3[] - A collection of warnings generated for the request
ebay.metadata: GetAutomotivePartsCompatibilityPoliciesHeaders
Represents the Headers record for the operation: getAutomotivePartsCompatibilityPolicies
Fields
- acceptEncoding? string - This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip. For more information, refer to Request Headers
ebay.metadata: GetAutomotivePartsCompatibilityPoliciesQueries
Represents the Queries record for the operation: getAutomotivePartsCompatibilityPolicies
Fields
- filter? string - This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned. Use the Taxonomy API to retrieve category ID values. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{183521|183523|183524} Note: URL-encoding of the parameter list is no longer required.
ebay.metadata: GetCategoryPoliciesHeaders
Represents the Headers record for the operation: getCategoryPolicies
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetCategoryPoliciesQueries
Represents the Queries record for the operation: getCategoryPolicies
Fields
- filter? string - This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a "leafCategory": true tag. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{3767|171784}
ebay.metadata: GetClassifiedAdPoliciesHeaders
Represents the Headers record for the operation: getClassifiedAdPolicies
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetClassifiedAdPoliciesQueries
Represents the Queries record for the operation: getClassifiedAdPolicies
Fields
- filter? string - This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a "leafCategory": true tag. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example:filter=categoryIds:{3767|171784}
ebay.metadata: GetCompatibilitiesBySpecificationHeaders
Represents the Headers record for the operation: getCompatibilitiesBySpecification
Fields
- xEBAYCMARKETPLACEID string - This header identifies the seller's eBay marketplace. See Marketplace ID values for a list of supported eBay marketplace ID values
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to Request Headers
ebay.metadata: GetCompatibilityPropertyNamesHeaders
Represents the Headers record for the operation: getCompatibilityPropertyNames
Fields
- xEBAYCMARKETPLACEID string - This header identifies the seller's eBay marketplace. See Marketplace ID values for a list of supported eBay marketplace ID values
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to Request Headers
ebay.metadata: GetCompatibilityPropertyValuesHeaders
Represents the Headers record for the operation: getCompatibilityPropertyValues
Fields
- xEBAYCMARKETPLACEID string - This header identifies the seller's eBay marketplace. See Marketplace ID values for a list of supported eBay marketplace ID values
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to Request Headers
ebay.metadata: GetCurrenciesHeaders
Represents the Headers record for the operation: getCurrencies
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada and French Belgium marketplaces.
Follow the instructions below to retrieve metadata for these marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA and include the Accept-Language header with a value of fr-CA.Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetCurrenciesResponse
This type defines the response fields specifying the default currency for the marketplace
Fields
- marketplaceId MarketplaceIdEnum - This type contains enumerated values of the standard codes that represent each of the eBay marketplaces. | - EBAY_US: Indicates the eBay marketplace for the United States. - EBAY_CA: Indicates the eBay marketplace for Canada. Note: When targeting the French locale of the Canadian marketplace, add the Accept-Language request header and pass in fr-CA. If this locale is not specified, the language will default to English. - EBAY_GB: Indicates the eBay marketplace for Great Britain (United Kingdom). - EBAY_AU: Indicates the eBay marketplace for Australia. - EBAY_AT: Indicates the eBay marketplace for Austria. - EBAY_BE: Indicates the eBay marketplace for Belgium. Note: When targeting the French locale of the Belgium marketplace, add the Accept-Language request header and pass in fr-BE. If this locale is not specified, the language will default to Dutch. - EBAY_DE: Indicates the eBay marketplace for Germany. - EBAY_IT: Indicates the eBay marketplace for Italy. - EBAY_NL: Indicates the eBay marketplace for The Netherlands. - EBAY_ES: Indicates the eBay marketplace for Spain. - EBAY_CH: Indicates the eBay marketplace for Switzerland. - EBAY_TW: Indicates the eBay marketplace for Taiwan. - EBAY_CZ: This marketplace is not currently supported. - EBAY_DK: This marketplace is not currently supported. - EBAY_FI: This marketplace is not currently supported. - EBAY_FR: Indicates the eBay marketplace for France. - EBAY_GR: This marketplace is not currently supported. - EBAY_HK: Indicates the eBay marketplace for Hong Kong. - EBAY_HU: This marketplace is not currently supported. - EBAY_IN: This marketplace is not currently supported. - EBAY_ID: This marketplace is not currently supported. - EBAY_IE: Indicates the eBay marketplace for Indicates the eBay marketplace for Ireland. - EBAY_IL: This marketplace is not currently supported. - EBAY_MY: Indicates the eBay marketplace for Malaysia. - EBAY_NZ: This marketplace is not currently supported. - EBAY_NO: This marketplace is not currently supported. - EBAY_PH: This marketplace is not currently supported. - EBAY_PL: Indicates the eBay marketplace for Poland. - EBAY_PT: Indicates the eBay marketplace for Portugal. - EBAY_PR: This marketplace is not currently supported. - EBAY_RU: This marketplace is not currently supported. - EBAY_SG: Indicates the eBay marketplace for Singapore. - EBAY_ZA: This marketplace is not currently supported. - EBAY_SE: This marketplace is not currently supported. - EBAY_TH: This marketplace is not currently supported. - EBAY_VN: This marketplace is not currently supported. - EBAY_CN: This marketplace is not currently supported. - EBAY_JP: This marketplace is not currently supported. - EBAY_PE: This marketplace is not currently supported. - EBAY_HALF_US: No longer used. - EBAY_MOTORS_US: Indicates the eBay marketplace is eBay Motors
- defaultCurrency Currency - The type defining valid currencies for the marketplace
ebay.metadata: GetExcludeShippingLocationsHeaders
Represents the Headers record for the operation: getExcludeShippingLocations
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetExtendedProducerResponsibilityPoliciesHeaders
Represents the Headers record for the operation: getExtendedProducerResponsibilityPolicies
Fields
- acceptEncoding? string - This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip. For more information, refer to Request Headers
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetExtendedProducerResponsibilityPoliciesQueries
Represents the Queries record for the operation: getExtendedProducerResponsibilityPolicies
Fields
- filter? string - A query parameter that can be used to limit the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree that should be returned. When a categoryId value is specified, the returned category tree includes the policies for that parent node, as well as the policies for any child nodes below that parent node. Pass in the categoryId values using a URL-encoded, pipe-separated ('|') list. For example: filter=categoryIds%3A%7B100%7C101%7C102%7D Maximum: 50
ebay.metadata: GetHandlingTimesHeaders
Represents the Headers record for the operation: getHandlingTimes
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetHazardousMaterialsLabelsHeaders
Represents the Headers record for the operation: getHazardousMaterialsLabels
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetItemConditionPoliciesHeaders
Represents the Headers record for the operation: getItemConditionPolicies
Fields
- acceptEncoding? string - This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip. For more information, refer to Request Headers
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetItemConditionPoliciesQueries
Represents the Queries record for the operation: getItemConditionPolicies
Fields
- filter? string - This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned. When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{100|101|102} Note that you must URL-encode the parameter list, which results in the following filter for the above example: filter=categoryIds%3A%7B100%7C101%7C102%7D
ebay.metadata: GetListingStructurePoliciesHeaders
Represents the Headers record for the operation: getListingStructurePolicies
Fields
- acceptEncoding? string - This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip. For more information, refer to Request Headers
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetListingStructurePoliciesQueries
Represents the Queries record for the operation: getListingStructurePolicies
Fields
- filter? string - This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned. When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{100|101|102} Note that you must URL-encode the parameter list, which results in the following filter for the above example: filter=categoryIds%3A%7B100%7C101%7C102%7D
ebay.metadata: GetListingTypePoliciesHeaders
Represents the Headers record for the operation: getListingTypePolicies
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetListingTypePoliciesQueries
Represents the Queries record for the operation: getListingTypePolicies
Fields
- filter? string - This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a "leafCategory": true tag. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{3767|171784}
ebay.metadata: GetMinimumListingPricePoliciesResponse
This type defines the response container for the getMinimumListingPricePolicies method
Fields
- minimumListingPricePolicies MinimumListingPricePoliciesType[] - This array returns a list of minimum listing price policies for supported types of listings on the specific marketplace
ebay.metadata: GetMotorsListingPoliciesHeaders
Represents the Headers record for the operation: getMotorsListingPolicies
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetMotorsListingPoliciesQueries
Represents the Queries record for the operation: getMotorsListingPolicies
Fields
- filter? string - This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a "leafCategory": true tag. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{3767|171784}
ebay.metadata: GetMultiCompatibilityPropertyValuesHeaders
Represents the Headers record for the operation: getMultiCompatibilityPropertyValues
Fields
- xEBAYCMARKETPLACEID string - This header identifies the seller's eBay marketplace. See Marketplace ID values for a list of supported eBay marketplace ID values
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to Request Headers
ebay.metadata: GetNegotiatedPricePoliciesHeaders
Represents the Headers record for the operation: getNegotiatedPricePolicies
Fields
- acceptEncoding? string - This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip. For more information, refer to Request Headers
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetNegotiatedPricePoliciesQueries
Represents the Queries record for the operation: getNegotiatedPricePolicies
Fields
- filter? string - This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned. When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{100|101|102} Note that you must URL-encode the parameter list, which results in the following filter for the above example: filter=categoryIds%3A%7B100%7C101%7C102%7D
ebay.metadata: GetProductCompatibilitiesHeaders
Represents the Headers record for the operation: getProductCompatibilities
Fields
- xEBAYCMARKETPLACEID string - This header identifies the seller's eBay marketplace. See Marketplace ID values for a list of supported eBay marketplace ID values
- contentType string - This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to Request Headers
ebay.metadata: GetRegulatoryPoliciesHeaders
Represents the Headers record for the operation: getRegulatoryPolicies
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetRegulatoryPoliciesQueries
Represents the Queries record for the operation: getRegulatoryPolicies
Fields
- filter? string - A query parameter that can be used to limit the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree that should be returned. Pass in the categoryId values using a URL-encoded, pipe-separated ('|') list. For example: filter=categoryIds%3A%7B100%7C101%7C102%7D Maximum: 50
ebay.metadata: GetReturnPoliciesHeaders
Represents the Headers record for the operation: getReturnPolicies
Fields
- acceptEncoding? string - This header indicates the compression-encoding algorithms the client accepts for the response. This value should be set to gzip. For more information, refer to Request Headers
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetReturnPoliciesQueries
Represents the Queries record for the operation: getReturnPolicies
Fields
- filter? string - This query parameter limits the response by returning policy information for only the selected sections of the category tree. Supply categoryId values for the sections of the tree you want returned. When you specify a categoryId value, the returned category tree includes the policies for that parent node, plus the policies for any leaf nodes below that parent node. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{100|101|102} Note that you must URL-encode the parameter list, which results in the following filter for the above example: filter=categoryIds%3A%7B100%7C101%7C102%7D
ebay.metadata: GetShippingCarriersHeaders
Represents the Headers record for the operation: getShippingCarriers
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetShippingLocationsHeaders
Represents the Headers record for the operation: getShippingLocations
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetShippingPoliciesHeaders
Represents the Headers record for the operation: getShippingPolicies
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetShippingPoliciesQueries
Represents the Queries record for the operation: getShippingPolicies
Fields
- filter? string - This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a "leafCategory": true tag. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example: filter=categoryIds:{3767|171784}
ebay.metadata: GetShippingServicesHeaders
Represents the Headers record for the operation: getShippingServices
Fields
- acceptLanguage? string - This header is required to retrieve metadata for the French Canada, French Belgium, and Dutch Belgium marketplaces.
Follow the instructions below to retrieve metadata for these three marketplaces:
- French Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of fr-BE.
- Dutch Belgium: Set the marketplace_id path parameter value to EBAY_BE, and include the Accept-Language header with a value of nl-BE.
- French Canada: Set the marketplace_id path parameter value to EBAY_CA, and include the Accept-Language header with a value of fr-CA. Note: If EBAY_CA is set as the marketplace_id path parameter and the Accept-Language header is not used, the marketplace will default to the English Canada marketplace.
ebay.metadata: GetSiteVisibilityPoliciesHeaders
Represents the Headers record for the operation: getSiteVisibilityPolicies
Fields
- acceptLanguage? string - This header advertises which natural language the client prefers
ebay.metadata: GetSiteVisibilityPoliciesQueries
Represents the Queries record for the operation: getSiteVisibilityPolicies
Fields
- filter? string - This query parameter limits the response by only returning metadata for the specified leaf categories. Supply the categoryId for one or more leaf categories. You can verify if a category is a leaf category by using the Taxonomy API and looking for a "leafCategory": true tag. The parameter takes a list of categoryId values and you can specify up to 50 separate category IDs. Separate multiple values with a pipe character ('|'). If you specify more than 50 categoryId values, eBay returns the policies for the first 50 IDs and a warning that not all categories were returned. Example:filter=categoryIds:{3767|171784}
ebay.metadata: HazardousMaterialDetailsResponse
A type that defines the response fields for the getHazardousMaterialsLabels method
Fields
- pictograms? Pictogram[] - This array contains available hazardous materials hazard pictograms for the specified marketplace
- signalWords? SignalWord[] - This array contains available hazardous materials signal words for the specified marketplace
- statements? HazardStatement[] - This array contains available hazardous materials hazard statements for the specified marketplace
ebay.metadata: HazardStatement
A type that describes hazard statements for hazardous materials labels
Fields
- statementDescription? string - The description of the statement localized to the default language of the marketplace. For sample values, see Hazard statement sample values
- statementId? string - The identifier of the statement. For sample values, see Hazard statement sample values
ebay.metadata: ItemCondition
Note: In all eBay marketplaces, Condition ID 2000 now maps to an item condition of 'Certified Refurbished', and not 'Manufacturer Refurbished'. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition. Any active listings on any eBay marketplace that had 'Manufacturer Refurbished' as the item condition should have been automatically updated by eBay to the 'Seller Refurbished' item condition (Condition ID 2500).
Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the Certified refurbished program page in Seller Center.
Fields
- conditionHelpText? string - A detailed description of the condition denoted by the conditionID and conditionDescription.
- conditionId string - The ID value of the selected item condition. For information on the supported condition ID values, see Item condition ID and name values
- conditionDescriptors? ItemConditionDescriptor[] - This array contains the possible condition descriptors and condition descriptor values applicable for the specified category. It also returns usage requirements, maximum length, cardinality, and help text. Note: This array is only returned for categories that support condition descriptors.
- usage? UsageEnum - This enumeration type contains a list of usage values for using item conditions. Currently, the only supported value is RESTRICTED. | - RESTRICTED: This value indicates that the usage of the corresponding item condition in the corresponding category is restricted to users who are eligible to use that item condition in the category. usage:RESTRICTED applies to items with these conditions:
- ConditionId 2000 (CERTIFIED_REFURBISHED)
- ConditionId 2010 (EXCELLENT_REFURBISHED)
- ConditionId 2020 (VERY_GOOD_REFURBISHED)
- ConditionId 2030 (GOOD_REFURBISHED) Note: Condition IDs 2010, 2020, and 2030 are only usable in the category Cell Phones & Smartphones - 9355. These IDs will become available beginning September 1, 2021. Sellers must be pre-approved to use these item conditions.
- conditionDescription string - The human-readable label for the condition (e.g., "New"). This value is typically localized for each site. Note that the display name can vary by category. For example, the description for condition ID 1000 could be called "New: with Tags" in one category and "Brand New" in another. For details on condition IDs and descriptions, see Item condition ID and name values
ebay.metadata: ItemConditionDescriptor
This type is used to display the possible condition descriptors and condition values applicable for a specified category. It also returns usage requirements, maximum length, cardinality, and help text
Fields
- conditionDescriptorHelpText? string - A description of the condition descriptor that directs a user to its condition descriptor values. For example, the help text for Card Condition is Select ungraded condition
- conditionDescriptorName? string - The human-readable label for the condition descriptor associated with the conditionDescriptorID. For example, Card Condition is the condition descriptor name for ID 40001
- conditionDescriptorConstraint? ItemConditionDescriptorConstraint - This type specifies the constraints on a condition descriptor, such as the maximum length, default condition descriptor value ID, cardinality, mode, usage, and applicable descriptor IDs
- conditionDescriptorValues? ItemConditionDescriptorValue[] - This array shows the possible values that map to the corresponding conditionDescriptorName values. Constraint information and help text are also shown for each value. For example, The ID 40001 is ID for the condition descriptor card condition. The ID 400012 is the ID for the Very Good card condition value
- conditionDescriptorId? string - The unique identification number of a condition descriptor associated with with a conditionDescriptorName. For example, 40001 is the ID for Card Condition. These IDs are used in the addItem family of calls of the Trading API to provide condition descriptor names for the item. These IDs are used by the inventoryItem family of calls of the Inventory API to provide condition descriptor names for the item
ebay.metadata: ItemConditionDescriptorConstraint
This type specifies the constraints on a condition descriptor, such as the maximum length, default condition descriptor value ID, cardinality, mode, usage, and applicable descriptor IDs
Fields
- mode? ModeEnum - This enumeration value indicates whether a condition descriptor input is selection only or free text. | - SELECTION_ONLY: This enum indicates that the input is selection only. - FREE_TEXT: This enum indicates that the input is free text
- defaultConditionDescriptorValueId? string - The default condition descriptor value that will be set if there are multiple values
- usage? DescriptorUsageEnum - This enumeration type indicates if there are any usage restrictions for the corresponding condition descriptor in the corresponding category. Currently, the only supported value is REQUIRED. | - REQUIRED: This value indicates that the usage of the condition descriptor in the corresponding category is required.
- cardinality? CardinalityEnum - This enumeration type is used to indicate whether a condition descriptor can have just a single value or multiple values. | - SINGLE: This enumeration value indicates that only a single value can be used for the condition descriptor. - MULTI: This enumeration value indicates that multiple values can be used for the condition descriptor
- maxLength? Signed32 - The maximum characters allowed for a condition descriptor. This field is only returned/applicable for condition descriptors that allow free text for condition descriptor values.
- applicableToConditionDescriptorIds? string[] - This array is returned if the corresponding condition descriptor requires that one or more other associated condition descriptors must also be specified in a listing. The condition descriptor IDs for the associated condition descriptors are returned here. For example, the Grade and Grader condition descriptors must always be specified together in a listing for Graded cards
ebay.metadata: ItemConditionDescriptorValue
This type displays the possible values for the corresponding condition descriptor, along with help text and constraint information
Fields
- conditionDescriptorValueId? string - The unique identification number of a condition descriptor value associated with the conditionDescriptorValueName
- conditionDescriptorValueConstraints? ItemConditionDescriptorValueConstraint[] - The constraints on a condition descriptor value, such as which descriptor value IDs and Descriptor ID it is associated with
- conditionDescriptorValueHelpText? string - A detailed description of the condition descriptor value.
- conditionDescriptorValueName? string - The human-readable label for the condition descriptor value associated with the conditionDescriptorValueID
- conditionDescriptorValueAdditionalHelpText? string[] - Additional information about the the condition of the item that is not included in the conditionDescriptorValueHelpText field
ebay.metadata: ItemConditionDescriptorValueConstraint
This type shows the constraints on a condition descriptor value, such as any associated condition descriptor ID and condition descriptor value IDs required for a listing
Fields
- applicableToConditionDescriptorId? string - This string is returned if the corresponding condition descriptor value requires an associated condition descriptor that must also be specified in a listing. The condition descriptor ID for the associated condition descriptors is returned here
- applicableToConditionDescriptorValueIds? string[] - This array is returned if the corresponding condition descriptor value is required for one or more associated condition descriptor values that must also be specified in a listing. The condition descriptor values IDs for the associated condition descriptor values are returned here
ebay.metadata: ItemConditionPolicy
This type contains applicable item condition policy metadata for the leaf categories returned for the marketplace
Fields
- categoryTreeId string - A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes
- itemConditions ItemCondition[] - The item-condition values allowed in the category. Note: The ‘Seller Refurbished’ item condition (condition ID 2500) has been replaced by the 'Excellent - Refurbished', 'Very Good - Refurbished', and 'Good - Refurbished' item conditions in a select number of eBay marketplaces and categories. Similar to the ‘Certified Refurbished’ item condition (condition ID 2000), a seller’s OAuth user token will have to be used instead of an OAuth application token, since each seller must go through an application and qualification process before using any of these new refurbished item conditions in supported categories. If a seller is not qualified to use the new refurbished item conditions, these item condition values will not be returned by getItemConditionPolicies.
- itemConditionRequired boolean - This flag denotes whether or not you must list the item condition in a listing for the specified category. If set to true, you must specify an item condition for the associated category
- categoryId string - The category ID to which the item-condition policy applies
ebay.metadata: ItemConditionPolicyResponse
This type defines the base response fields for the getItemConditionPolicies method
Fields
- warnings? ErrorDetailV3[] - A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
- itemConditionPolicies ItemConditionPolicy[] - A list of category IDs and the policies for how to indicate an item's condition in each of the listed categories
ebay.metadata: ListingDuration
This type identifies the kind of listing and its duration periods
Fields
- listingType? ListingTypeEnum - This enumerated type contains the selling formats for eBay listings. | - AUCTION: This value indicates that the corresponding leaf category supports auction listings. - AD_TYPE: This value indicates that the corresponding leaf category supports classified ads in a Real Estate category listings. - PERSONAL_OFFER: This value indicates that the corresponding leaf category supports Second chance offer made to a non-winning bidder listings. - FIXED_PRICE_ITEM: This value indicates that the corresponding leaf category supports fixed-price listings. - LEAD_GENERATION: This value indicates that the corresponding leaf category supports non-Real Estate classified ad listings (the AD_TYPE enumeration value represents Real Estate classified ads)
- durationValues? DurationEnum[] - This array defines the supported time duration options available for the listing type
ebay.metadata: ListingStructurePolicy
This type contains applicable listing structure policy metadata for the leaf categories returned for the marketplace
Fields
- categoryTreeId string - A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes
- variationsSupported boolean - This flag denotes whether or not the associated category supports listings with item variations. If set to true, the category does support item variations
- categoryId string - The category ID to which the listing-structure policy applies
ebay.metadata: ListingStructurePolicyResponse
This type defines the base response fields of the getListingStructuresPolicies method
Fields
- warnings? ErrorDetailV3[] - Collection of warnings generated for the request
- listingStructurePolicies ListingStructurePolicy[] - Returns a list of category IDs plus a flag indicating whether or not each listed category supports item variations
ebay.metadata: ListingTypePoliciesResponse
This type contains the selling formats for eBay listings
Fields
- listingTypePolicies ListingTypePolicy[] - This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter
- warnings? ErrorDetailV3[] - An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
ebay.metadata: ListingTypePolicy
This type contains the policies governing the listing type by category
Fields
- listingDurations? ListingDuration[] - An array of eBay listing types and the supported durations for the corresponding leaf category. If a specific eBay listing type does not appear for a leaf category, it indicates that the category does not support that listing type
- pickupDropOffEnabled? boolean - A true value in this field indicates that items listed in the category (specified in the Category.CategoryID field) may be enabled with the 'Click and Collect' feature. With the 'Click and Collect' feature, a buyer can purchase certain items on an eBay site and collect them at a local store. Buyers are notified by eBay once their items are available. A false value in this field indicates that items listed in the category are not eligible for the 'Click and Collect' feature
- categoryTreeId string - The unique identifier of the category tree
- digitalGoodDeliveryEnabled? boolean - A true value in this field indicates that the leaf category supports the listing of items (such as gift cards) that can be delivered electronically via a download link or sent to a buyer's email address
- categoryId string - The unique identifier of the eBay leaf category for which metadata is being returned
ebay.metadata: LocalListingDistance
This type contains the kind of distance and radius of the selling area for Local Market Vehicle listings
Fields
- distances? int[] - This array indicates the radius (in miles) of the selling area for Local Market Vehicle listings
- distanceType? DistanceType - This enumeration type indicates support of local listing distances for items listed by sellers. | - LOCAL_LISTING_DISTANCES_REGULAR: Indicates that one or more eBay marketplaces allow dealership subscribers with a regular subscription to specify local market radius for Motors Local Market listings. - LOCAL_LISTING_DISTANCES_SPECIALTY: Indicates that one or more eBay marketplaces allow dealership subscribers with a specialty subscription to specify local market radius for Motors Local Market listings. - LOCAL_LISTING_DISTANCES_NON_SUBSCRIPTION: Indicates that one or more eBay marketplaces allow dealership subscribers without a subscription to specify local market radius for Motors Local Market listings.
ebay.metadata: MinimumListingPricePoliciesType
This type defines the minimum starting prices for the supported types of eBay listings
Fields
- startPrice Amount - The type that defines the fields for the currency and a monetary amount
- description string - The description of the listing type for which the pricing data is intended
- listingType ListingTypeEnum - This enumerated type contains the selling formats for eBay listings. | - AUCTION: This value indicates that the corresponding leaf category supports auction listings. - AD_TYPE: This value indicates that the corresponding leaf category supports classified ads in a Real Estate category listings. - PERSONAL_OFFER: This value indicates that the corresponding leaf category supports Second chance offer made to a non-winning bidder listings. - FIXED_PRICE_ITEM: This value indicates that the corresponding leaf category supports fixed-price listings. - LEAD_GENERATION: This value indicates that the corresponding leaf category supports non-Real Estate classified ad listings (the AD_TYPE enumeration value represents Real Estate classified ads)
- minBuyItNowPricePercent? string - The minimum percentage value that a Buy It Now price for an auction listing must be above the starting bid price
ebay.metadata: MotorsListingPoliciesResponse
This type defines the base response fields of the getMotorsListingPolicies method
Fields
- warnings? ErrorDetailV3[] - An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
- motorsListingPolicies MotorsListingPolicy[] - This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter
ebay.metadata: MotorsListingPolicy
This type contains applicable motors listing policy metadata for the leaf categories returned for the marketplace
Fields
- minItemCompatibility? Signed32 - Indicates the minimum number of required compatible applications for listing items. A value of 0 indicates it is not mandatory to specify parts compatibilities when listing
- localMarketStreetCount? Signed32 - Indicates which address option is enabled for the seller's contact information
- ebayMotorsProAutoAcceptEnabled? boolean - Indicates whether or not the category supports the Best Offer Auto Accept feature for eBay Motors Pro listings. This element is for eBay Motors Pro users
- localMarketPremiumSubscription? boolean - Indicates whether the category supports the Premium level subscription Motors Local Market listings. This feature is only available to licensed vehicle dealers
- vinSupported? boolean - Indicates if Vehicle Identification Number is supported
- localMarketContactByPhoneEnabled? boolean - Indicates whether this category supports including the telephone in the seller's contact information
- localMarketCompanyNameEnabled? boolean - Indicates whether the category supports the seller's company name being specified when using Motors Local Market classified ads
- maxItemCompatibility? Signed32 - Indicates the maximum number of compatible applications allowed per item when adding or revising items. This is relevant for specifying parts compatibility by application manually only. See Specify parts compatibility manually and Managing product compatibility for more information
- specialitySubscription? GeographicExposureEnum - An enumerated type that indicates if an eBay site or category supports Motors National Listings and/or Motors Local Market listings. | - National: This enumeration value indicates the eBay site or category only supports Motors National Listings for the corresponding Motors dealer subscription level/type. - LocalOnly: This enumeration value the eBay site or category only supports Motors Local Market Listings for the corresponding Motors dealer subscription level/type. - LocalOptional: This enumeration value the eBay site or category supports Motors National Listings and Motors Local Market listing for the corresponding Motors dealer subscription level/type
- ebayMotorsProAdFormatEnabled? AdFormatEnabledEnum - This enumerated type contains a list of values indicating type or status of available ad formats for an eBay site or for an eBay category. | - DISABLED: This value indicates that the Classified Ad format feature is disabled for the site or category. - ENABLED: This value indicates that the Classified Ad format feature is enabled for the site or category. - ONLY: This value indicates that the Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - CLASSIFIED_AD_ENABLED: This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - CLASSIFIED_AD_ONLY: This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - LOCAL_MARKET_BEST_OFFER_ONLY: This value indicates that eBay Motors Local Market listings are enabled for the site or category
- ebayMotorsProAutoDeclineEnabled? boolean - Indicates whether or not the category allows auto-decline for Best Offers for eBay Motors Classified Ad listings. This element is for eBay Motors Pro users
- regularSubscription? GeographicExposureEnum - An enumerated type that indicates if an eBay site or category supports Motors National Listings and/or Motors Local Market listings. | - National: This enumeration value indicates the eBay site or category only supports Motors National Listings for the corresponding Motors dealer subscription level/type. - LocalOnly: This enumeration value the eBay site or category only supports Motors Local Market Listings for the corresponding Motors dealer subscription level/type. - LocalOptional: This enumeration value the eBay site or category supports Motors National Listings and Motors Local Market listing for the corresponding Motors dealer subscription level/type
- kTypeSupported? boolean - This field indicates whether or not the category supports the use of a K type to identify the cars and trucks compatible with a motor vehicle part or accessory. Only the AU, DE, ES, FR, IT, and UK marketplaces support the use of K types. See Compatibility by K type for more information
- localMarketContactByAddressEnabled? boolean - Indicates whether this category supports including the address in the seller's contact information
- maxGranularFitmentCount? Signed32 - Indicates the maximum number of compatible applications allowed per item when adding or revising items with compatibilities provided at the most detailed granularity. For example, in Car and Truck Parts on the US site, the most granular application would include Year, Make, Model, Trim, and Engine
- ebayMotorsProShippingMethodEnabled? boolean - Indicates if shipping options should be displayed to the user for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users
- epidSupported? boolean - If returned as true, this indicates the category supports the use of an eBay Product ID (e.g. ePID) to identify which motorcycles and/or scooters are compatible with a motor vehicle part or accessory. ePIDs can only be used to identify motorcycles and scooters on the Germany and UK sites
- ebayMotorsProCounterOfferEnabled? boolean - Indicates whether counter offers are allowed on Best Offers for this category in an eBay Motors Classified Ad listing. This element is for eBay Motors Pro users
- localMarketAutoAcceptEnabled? boolean - Specifies whether this category supports auto-accept for Best Offers for Motors Local Market Classified Ads
- ebayMotorsProContactByEmailEnabled? boolean - Indicates whether this category supports including an email address in the seller's contact information. This element is for eBay Motors Pro users
- localMarketPaymentMethodCheckOutEnabled? ClassifiedAdPaymentMethodEnabledEnum - This enumerated type defines values that indicate whether the payment method will be displayed for a category. | - ENABLED_WITH_CHECKOUT: This value indicates display of the payment method and permits checkout. - ENABLED_WITHOUT_CHECKOUT: This value indicates display of the payment method and suppresses checkout. - NOT_SUPPORTED: This value indicates the payment method is not displayed
- ebayMotorsProPaymentMethodCheckOutEnabled? ClassifiedAdPaymentMethodEnabledEnum - This enumerated type defines values that indicate whether the payment method will be displayed for a category. | - ENABLED_WITH_CHECKOUT: This value indicates display of the payment method and permits checkout. - ENABLED_WITHOUT_CHECKOUT: This value indicates display of the payment method and suppresses checkout. - NOT_SUPPORTED: This value indicates the payment method is not displayed
- localMarketContactByEmailEnabled? boolean - Indicates whether the category supports including an email address in the seller's contact information.
- ebayMotorsProContactByAddressEnabled? boolean - Indicates whether this category supports including the address in the seller's contact information. This element is for eBay Motors Pro users
- sellerProvidedTitleSupported? boolean - This field is returned as true if the corresponding category supports the use of a seller-provided title for a motor vehicle listing on the US or Canada Motors marketplaces. A seller-provided title is a descriptive title, given by the seller, that appears below eBay's pre-filled listing title for the motor vehicle. Visually, the seller-provided title is similar to a subtitle on other types of eBay listings (non-vehicle). A seller-provided title can assist in helping buyers discover the vehicle
- localMarketAdFormatEnabled? AdFormatEnabledEnum - This enumerated type contains a list of values indicating type or status of available ad formats for an eBay site or for an eBay category. | - DISABLED: This value indicates that the Classified Ad format feature is disabled for the site or category. - ENABLED: This value indicates that the Classified Ad format feature is enabled for the site or category. - ONLY: This value indicates that the Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - CLASSIFIED_AD_ENABLED: This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - CLASSIFIED_AD_ONLY: This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - LOCAL_MARKET_BEST_OFFER_ONLY: This value indicates that eBay Motors Local Market listings are enabled for the site or category
- localMarketCounterOfferEnabled? boolean - Indicates whether counter offers are allowed on Best Offers for this category for Motors Local Market Classified Ad listings
- nonSubscription? GeographicExposureEnum - An enumerated type that indicates if an eBay site or category supports Motors National Listings and/or Motors Local Market listings. | - National: This enumeration value indicates the eBay site or category only supports Motors National Listings for the corresponding Motors dealer subscription level/type. - LocalOnly: This enumeration value the eBay site or category only supports Motors Local Market Listings for the corresponding Motors dealer subscription level/type. - LocalOptional: This enumeration value the eBay site or category supports Motors National Listings and Motors Local Market listing for the corresponding Motors dealer subscription level/type
- ebayMotorsProCompanyNameEnabled? boolean - Indicates whether this category supports including the company name in the seller's contact information. This element is for eBay Motors Pro users
- localMarketRegularSubscription? boolean - Indicates whether the category supports the Regular level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers
- ebayMotorsProStreetCount? Signed32 - This field indicates the number of street addresses allowed in contact information for this category. This element is for eBay Motors Pro users
- localMarketAutoDeclineEnabled? boolean - Specifies whether this category supports auto-decline for Best Offers for Motors Local Market Classified Ads
- ebayMotorsProSellerContactDetailsEnabled? boolean - Indicates whether this category allows seller-level contact information for eBay Motors Classified Ad listings. A value of true means seller-level contact information is available for Classified Ad listings. This element is for eBay Motors Pro users
- localMarketNonSubscription? boolean - Indicates whether the category supports a seller creating a Motors Local Market listing without a subscription. This feature is only available to licensed vehicle dealers
- localMarketShippingMethodEnabled? boolean - Indicates if shipping methods should be displayed to the user for this category in an Motors Local Market Classified Ad listing. Even if enabled, checkout may or may not be enabled
- localMarketSellerContactDetailsEnabled? boolean - Specifies the whether this category allows seller-level contact information for Motors Local Market Classified Ad listings
- ebayMotorsProPhoneCount? Signed32 - Indicates the number of phone numbers that can be included through contact information for this category. This element is for eBay Motors Pro users
- localListingDistances? LocalListingDistance[] - This array shows the supported distances (in miles) for different types of Local Market subscription types in this category. Motor vehicle listings will be shown to buyers located within these proximities of the vehicle's location
- localMarketSpecialitySubscription? boolean - Indicates whether the category supports the Specialty level subscription to Motors Local Market listings. This feature is only available to licensed vehicle dealers
- ebayMotorsProContactByPhoneEnabled? boolean - Indicates whether this category supports including the telephone in the seller's contact information. This element is for eBay Motors Pro users
- categoryTreeId string - The unique identifier of the category tree
- depositSupported? boolean - This field is returned as true if the corresponding category supports the use of a deposit/down payment on a motor vehicle listing. In an AddItem call, the seller can configure a down payment for a motor vehicle listing using the PaymentDetails container
- localMarketBestOfferEnabled? ClassifiedAdBestOfferEnabledEnum - This enumerated type defines values that indicate whether the category supports Classified Ad Best Offers. | - DISABLED: This value indicates that Classified Ad Best Offer feature is disabled for most categories. - ENABLED: This value indicates that Classified Ad Best Offer feature is enabled for most categories. - REQUIRED: This value indicates that Classified Ad Best Offer feature is required for a specific category.
- ebayMotorsProBestOfferEnabled? ClassifiedAdBestOfferEnabledEnum - This enumerated type defines values that indicate whether the category supports Classified Ad Best Offers. | - DISABLED: This value indicates that Classified Ad Best Offer feature is disabled for most categories. - ENABLED: This value indicates that Classified Ad Best Offer feature is enabled for most categories. - REQUIRED: This value indicates that Classified Ad Best Offer feature is required for a specific category.
- premiumSubscription? GeographicExposureEnum - An enumerated type that indicates if an eBay site or category supports Motors National Listings and/or Motors Local Market listings. | - National: This enumeration value indicates the eBay site or category only supports Motors National Listings for the corresponding Motors dealer subscription level/type. - LocalOnly: This enumeration value the eBay site or category only supports Motors Local Market Listings for the corresponding Motors dealer subscription level/type. - LocalOptional: This enumeration value the eBay site or category supports Motors National Listings and Motors Local Market listing for the corresponding Motors dealer subscription level/type
- categoryId string - The unique identifier of the eBay leaf category for which metadata is being returned
- localMarketPhoneCount? Signed32 - Indicates the number of phone numbers that can be included through contact information for this category
- vrmSupported? boolean - Indicates if Vehicle Registration Mark is supported
ebay.metadata: MultiCompatibilityPropertyValuesRequest
This type defines the request fields used in the getMultiCompatibilityPropertyValues method
Fields
- propertyFilters PropertyFilter[] - This array can be used to specify the compatibility properties used to limit the result set. Only values associated with the specified name-value pairs will be returned in the response. For example, if the propertyName is set to Year and the propertyValue is set to 2022, only compatible vehicles from 2022 will be returned. At least one property name-value pair must be used
- propertyNames string[] - This comma-delimited array specifies the names of the properties for which to retrieve associated property values. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category
- categoryId string - The unique identifier of the eBay leaf category for which to retrieve property values. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility
ebay.metadata: MultiCompatibilityPropertyValuesResponse
This type defines the response fields for the getMultiCompatibilityPropertyValues method
Fields
- metadataVersion? string - The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace
- compatibilities? Compatibility[] - This container defines the compatibility details associated with the specified property name value(s)
ebay.metadata: NegotiatedPricePolicy
This type contains applicable negotiation price policy metadata for the leaf categories returned for the marketplace
Fields
- bestOfferAutoAcceptEnabled boolean - This flag denotes whether or not the category supports the setting of a price at which best offers are automatically accepted. If set to true, the category does support the setting of an automatic price for best-offers
- bestOfferAutoDeclineEnabled boolean - This flag denotes whether or not the category supports the setting of an auto-decline price for best offers. If set to true, the category does support the setting of an automatic-decline price for best-offers
- categoryTreeId string - A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes
- bestOfferCounterEnabled boolean - This flag denotes whether or not the category supports the setting for an automatic counter-offer on best offers. If set to true, the category does support the setting of an automatic counter-offer price for best-offers
- categoryId string - The category ID to which the negotiated-price policies apply
ebay.metadata: NegotiatedPricePolicyResponse
This type defines the base response fields of the getNegotiatedPricePolicies method
Fields
- negotiatedPricePolicies NegotiatedPricePolicy[] - A list of category IDs and the policies related to negotiated-price items for each of the listed categories
- warnings? ErrorDetailV3[] - A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
ebay.metadata: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://api.ebay.com/identity/v1/oauth2/token") - Token URL
ebay.metadata: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://api.ebay.com/identity/v1/oauth2/token") - Refresh URL
ebay.metadata: PackageLimits
The packageLimits field is used to specify the physical constraints and measurement units of packages, ensuring compliance with various shipping requirements
Fields
- minHeight? decimal - The minimum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit
- maxHeight? decimal - The maximum height allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit
- minLength? decimal - The minimum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit
- dimensionUnit? string - Unit of dimensional measurement, for example INCH or CENTIMETER.
- minWeight? decimal - The minimum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit
- minWidth? decimal - The minimum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit
- maxWeight? decimal - The maximum weight allowed for a package shipped through the corresponding shipping service, as measured in units of weightUnit
- maxGirth? decimal - The maximum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit
- maxLength? decimal - The maximum length allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit
- maxWidth? decimal - The maximum width allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit
- minGirth? decimal - The minimum girth allowed for a package shipped through the corresponding shipping service, as measured in units of dimensionUnit
- weightUnit? string - Unit of weight measurement, for example KILOGRAM or OUNCE.
ebay.metadata: Pagination
This type defines the pagination settings for a result set
Fields
- total? Signed32 - The total number of results in a result set
- offset? Signed32 - The number of items that will be skipped in the result set before returning the first item in the paginated response
- count? Signed32 - The number of results showing on the current page of results
- 'limit? Signed32 - The max number of entries that can be returned on a single page
ebay.metadata: PaginationInput
This type defines the fields used to control the pagination of the result set
Fields
- offset? Signed32 - The number of items that will be skipped in the result set before returning the first item in the paginated response. Combine offset with limit to control the items returned in the response. For example, if you supply an offset of 10 and a limit of 20, the first page of the response contains items 11-30 from the complete result set. Default: 0
- 'limit? Signed32 - The max number of items, from the current result set, returned on a single page. Note: For getProductCompatibilities, the max value is 100. If no limit is specified, this field defaults to the max value.
ebay.metadata: Pictogram
A type that describes pictograms for hazardous materials labels
Fields
- pictogramId? string - The identifier of the pictogram. For sample values, see Pictogram sample values
- pictogramDescription? string - The description of the pictogram localized to the default language of the marketplace. For sample values, see Pictogram sample values
- pictogramUrl? string - The URL of the pictogram
ebay.metadata: ProductIdentifier
This type defines the supported product identifiers
Fields
- ean? string - The EAN of the item, if applicable. EAN is the European Article Number, a barcode standard for retail product labeling primarily used outside of North America
- productId? string - The product ID of the item, if applicable. The product ID is a general term for a unique identifier assigned to a product
- isbn? string - The ISBN of the item, if applicable. ISBN is the International Standard Book Number, a unique identifier for books
- epid? string - The ePID (eBay Product Identifier) of the item, if applicable. ePID is a unique identifier used by eBay to track products in its catalog. Use the getProduct method of the Catalog API to retrieve the ePID of an item
- upc? string - The UPC of the item, if applicable. UPC stands for Universal Product Code, a unique identifier for products, primarily in North America
ebay.metadata: ProductRequest
This type defines the request fields for the getProductCompatibilities method
Fields
- disabledProductFilter? DisabledProductFilter - This type defines the booleans used to determine if a product is excluded from eBay selling and/or review
- paginationInput? PaginationInput - This type defines the fields used to control the pagination of the result set
- productIdentifier? ProductIdentifier - This type defines the supported product identifiers
- sortOrders? SortOrder[] - This array controls the sort order of compatibility properties
- applicationPropertyFilters? PropertyFilter[] - This array is used to filter the properties of an application, such as a vehicle's make or model, that will be returned in the response. Application property filters are specified as name-value pairs. Only products compatible with these name-value pairs will be returned
- datasetPropertyName? string[] - This comma-delimted array can be used to define the specific property name(s) that will be returned in the response. For example, if you specify Engine, the result set will only contain engines that are compatible with the input criteria. Note: This array cannot be used alongside dataset. If both are used, an error will occur.
- dataset? string[] - This array defines the type of properties that are returned for the catalog-enabled category.
For example, if you specify Searchable, the compatibility details will contain properties that can be used to search for products, such as make or model.
Note: This field cannot be used alongside dataPropertyName. If both are used, an error will occur.
Valid values:
- DisplayableProductDetails: Properties for use in a user interface to describe products.
- DisplayableSearchResults: Properties for use in results for product searches.
- Searchable: Properties for use in searches.
- Sortable: Properties that are suitable for sorting.
ebay.metadata: ProductResponse
This type defines the response fields for the getProductCompatibilities method
Fields
- pagination? Pagination - This type defines the pagination settings for a result set
- compatibilityDetails ProductResponseCompatibilityDetails[] - This container provides compatibility details for the specified product
ebay.metadata: ProductResponseCompatibilityDetails
This type defines the compatibility details for a product
Fields
- noteDetails? PropertyFilter[] - This array returns additional comments about the corresponding product in the form of name-value pairs
- productDetails? PropertyValues[] - This array returns details about the product in the form of name-value pairs.
ebay.metadata: ProductSafetyLabelPictogram
A type that describes pictograms for product safety labels
Fields
- pictogramId string - The identifier of the pictogram
- pictogramDescription string - The description of the pictogram localized to the default language of the marketplace.
- pictogramUrl string - The URL of the pictogram
ebay.metadata: ProductSafetyLabelsResponse
A type that defines the response fields for the getProductSafetyLabels method
Fields
- pictograms ProductSafetyLabelPictogram[] - This array contains a list of pictograms of product safety labels for the specified marketplace
- statements ProductSafetyLabelStatement[] - This array contains available product safety labels statements for the specified marketplace.
ebay.metadata: ProductSafetyLabelStatement
A type that describes statements for product safety labels
Fields
- statementDescription string - The description of the statement localized to the default language of the marketplace.
- statementId string - The identifier of the statement
ebay.metadata: PropertyFilter
This type is used to define the available compatibility property filters
Fields
- unitOfMeasurement? string - The unit of measurement of the property being described, if applicable
- propertyName? string - The name of the property being described. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category
- propertyValue? string - The value for the property specified in the properyName field. For example, if the propertyName is Make, then the propertyValue will be the specific make of the vehicle, such as Toyota. Use the getCompatibilityPropertyValues to retrieve valid property values associated with a specified property name
- url? string - The URL associated with the property being described, if applicable
ebay.metadata: PropertyNamesRequest
This type defines the request fields for the getCompatibilityPropertyNames method
Fields
- dataset? string[] - This array defines the properties that will be returned for the compatibility-enabled category.
For example, if you specify Searchable, the compatibility details will contain properties that can be used to search for products, such as make or model.
Valid values:
- DisplayableProductDetails: Properties for use in a user interface to describe products.
- DisplayableSearchResults: Properties for use in results for product searches.
- Searchable: Properties for use in searches.
- Sortable: Properties that are suitable for sorting. Default: DisplayableSearchResults
- categoryId string - The unique identifier of the eBay leaf category for which to retrieve compatibility property names. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility
ebay.metadata: PropertyNamesResponse
This type defines the fields returned in the getCompatibilityPropertyNames method
Fields
- categoryId string - The unique identifier of the eBay category specified in the request
- properties PropertyNamesResponseProperties[] - This array contains all of the properties for the specified category
ebay.metadata: PropertyNamesResponseProperties
This type defines the properties and dataset for a specified category
Fields
- propertyNames? PropertyNamesResponsePropertyNames[] - This array specifies the names of the properties associated with the specified category in the specified marketplace. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category
- dataset? string - This field defines the types of properties are returned for the specified catalog-enabled category.
Valid values:
- DisplayableProductDetails: Properties for use in a user interface to describe products.
- DisplayableSearchResults: Properties for use in results for product searches.
- Searchable: Properties for use in searches.
- Sortable: Properties that are suitable for sorting.
ebay.metadata: PropertyNamesResponsePropertyNameMetadata
This type defines the property name metadata
Fields
- displaySequence? Signed32 - The numeric value indicating the ordering position of the property
ebay.metadata: PropertyNamesResponsePropertyNames
This type defines the fields associated with a property name
Fields
- propertyDisplayName? string - The display name of a property. This is the localized name of the compatible property
- propertyName? string - The canonical name of a property. This value is used as part of the name-value pairs used to specify compatibility
- propertyNameMetadata? PropertyNamesResponsePropertyNameMetadata - This type defines the property name metadata
ebay.metadata: PropertyValues
This type defines the name-value pair associated with a property value
Fields
- propertyName? string - The name of the property. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category
- propertyValue? string - The value for the property specified in the properyName field. For example, if the propertyName is make, then the propertyValue will be the specific make of the vehicle, such as Toyota
ebay.metadata: PropertyValuesRequest
This type defines the request fields used in the getCompatibilityPropertyValues method
Fields
- propertyFilters? PropertyFilter[] - This array can be used to specify the compatibility properties used limit the result set. Only values associated with the specified name-value pairs will be returned in the response. For example, if the propertyName is set to Make and the propertyValue is set to Honda, only compatible Honda vehicles will be returned
- propertyName? string - This field specifies the name of the property for which to retrieve associated property values. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category
- sortOrder? string - This field specifies the sort order for the property values in the result set.
Valid values:
- Ascending
- Descending Note: If no search order is specified, values are sorted in ascending order.
- categoryId string - The unique identifier of the eBay leaf category for which to retrieve compatibility property values. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility
ebay.metadata: PropertyValuesResponse
This type defines the response fields used in the getCompatibilityPropertyValues method
Fields
- propertyName string - The name of the property specified in the request
- propertyValues string[] - This array specifies the property values associated with the specified propertyName, in the specified category
- metadataVersion string - The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace
ebay.metadata: RegulatoryAttribute
A type that defines the attributes of a regulatory policy
Fields
- usage GenericUsageEnum - An enumerated type that indicates whether an Extended Producer Responsibility attribute is optional, recommended, or required. | - OPTIONAL: This enum value indicates that the attribute is optional. - RECOMMENDED: This enum value indicates that the attribute is recommended. - REQUIRED: This enum value indicates that the attribute is required
- name RegulatoryAttributeEnum - An enumerated type that indicates supported regulatory attributes. | - HAZMAT: Indicates hazardous materials labels support in listing flows. - ENERGY_EFFICIENCY: Indicates energy efficiency class support in listing flows. - MANUFACTURER_CONTACT: Indicates support for manufacturer contacts in listing flows. - PRODUCT_SAFETY: Indicates product safety support in listing flows.
ebay.metadata: RegulatoryPolicy
A type that defines the regulatory policy
Fields
- categoryTreeId string - The unique identifier of the category tree, which reflects the specified marketplace
- supportedAttributes RegulatoryAttribute[] - A list of supported regulatory attributes for this marketplace
- categoryId string - The unique identifier of the leaf category to which the corresponding policies pertain
ebay.metadata: RegulatoryPolicyResponse
A type that defines the response fields for the getRegulatoryPolicies method
Fields
- warnings? ErrorDetailV3[] - A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
- regulatoryPolicies RegulatoryPolicy[] - A list of eBay policies that define whether or not you must include required regulatory information for leaf categories on the given marketplace
ebay.metadata: ReturnPolicy
This type contains applicable return policy metadata for the leaf categories returned for the marketplace
Fields
- domestic? ReturnPolicyDetails - This container defines the category policies that relate to domestic and international return policies (the return shipping is made via a domestic or an international shipping service, respectively)
- categoryTreeId string - A value that indicates the root node of the category tree used for the response set. Each marketplace is based on a category tree whose root node is indicated by this unique category ID value. All category policy information returned by this call pertains to the categories included below this root node of the tree. A category tree is a hierarchical framework of eBay categories that begins at the root node of the tree and extends to include all the child nodes in the tree. Each child node in the tree is an eBay category that is represented by a unique categoryId value. Within a category tree, the root node has no parent node and leaf nodes are nodes that have no child nodes
- international? ReturnPolicyDetails - This container defines the category policies that relate to domestic and international return policies (the return shipping is made via a domestic or an international shipping service, respectively)
- categoryId string - The category ID to which the return policies apply
- required? boolean - If set to true, this flag indicates that you must specify a return policy for items listed in the associated category. Note that not accepting returns (setting returnsAcceptedEnabled to false) is a valid return policy
ebay.metadata: ReturnPolicyDetails
This container defines the category policies that relate to domestic and international return policies (the return shipping is made via a domestic or an international shipping service, respectively)
Fields
- returnsAcceptanceEnabled? boolean - A value of true in this field indicates that return policies are applicable to the corresponding leaf category.
Note: Depending on the API used to setup your return policy, whether or not you accept returns is configured as follows:
- Account v1 API When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use returnsAccepted and internationalOverride.returnsAccepted to indicate whether or not you accept returns.
- Trading API or Sell Feed API
- refundMethods? RefundMethodEnum[] - A list of refund methods allowed for the associated category.
Note: Depending on the API used to setup your return policy, available refund methods are defined differently.
- Account v1 API When using the createReturnPolicy and updateReturnPolicy methods to create/manage business policies, use the appropriate refundMethod field to specify the refund method for both domestic and international returns for the business policy.
- Trading API or Sell Feed API
- returnShippingCostPayers? ReturnShippingCostPayerEnum[] - A list of allowed values for who pays for the return shipping cost.
Note that for SNAD returns, the seller is always responsible for the return shipping cost.
Note: Depending on the API used to setup your return policy, specifiying that the buyer or seller is responsible for paying for return shipping costs is defined differently.
- Account v1 API When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use returnShippingCostPayer and internationalOverride.returnShippingCostPayer to specify if the buyer or seller is responsible for paying return shipping charges for the business policy.
- Trading API or Sell Feed API
- returnMethods? ReturnMethodEnum[] - A list of return methods allowed for the associated category.
Note: Depending on the API used to setup your return policy, available return methods are defined differently.
- Account v1 API When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use returnMethod and internationalOverride.returnMethod to specify the domestic and international return method, respectively, for the business policy.
- policyDescriptionEnabled? boolean - If set to true, this flag indicates you can supply a detailed return policy description within your return policy (for example, by populating the returnInstructions field in the Account API's createReturnPolicy). User-supplied return policy details are allowed only in the DE, ES, FR, and IT marketplaces.
Note: Depending on the API used to setup your return policy, return instructions are defined differently.
- Account v1 API When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use returnInstructions to provide both domestic and international return instructions for the business policy.
- Trading API or Sell Feed API
- returnPeriods? TimeDuration[] - A list of return periods allowed for the associated category.
Note: Depending on the API used to setup your return policy, return periods are defined differently.
- Account v1 API When using createReturnPolicy and updateReturnPolicy to create/manage business policies, use the returnPeriod and internationalOverride.returnPeriod containers to set the return period(s) for the business policy. You will use the supported values returned under the returnPeriods array in the getReturnPolicies response.
- Trading API or Sell Feed API
ebay.metadata: ReturnPolicyResponse
This type defines the base response fields of the getReturnPolicies method
Fields
- warnings? ErrorDetailV3[] - A list of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
- returnPolicies ReturnPolicy[] - A list of elements, where each contains a category ID and a flag that indicates whether or not listings in that category require a return policy
ebay.metadata: SalesTaxJurisdiction
A unique ID for a sales tax jurisdiction
Fields
- salesTaxJurisdictionId string - The unique ID for a sales-tax jurisdiction.
Important! When countryCode is set to US, IDs for all 50 states, Washington, DC, and all US territories will be returned. However, the only salesTaxJurisdictionId values currently supported are:
- AS (American Samoa)
- GU (Guam
- MP Northern Mariana Islands
- PW (Palau)
- VI (US Virgin Islands)
ebay.metadata: SalesTaxJurisdictions
This complex type contains a list of sales-tax jurisdictions
Fields
- salesTaxJurisdictions SalesTaxJurisdiction[] - A list of sales-tax jurisdictions
ebay.metadata: ShippingCarrier
This type provides applicable shipping carrier metadata for the marketplace
Fields
- shippingCarrier string - An enumerated value describing the shipping carrier returned, for example, UPS, FedEx, and USPS. These values are needed when providing shipment tracking information for each specific shipping carrier
- description string - The localized description of the shipping carrier, such as UPS, FedEx, and USPS
ebay.metadata: ShippingCarrierResponse
This type provides applicable shipping carrier metadata for returned for the marketplace
Fields
- shippingCarriers ShippingCarrier[] - A list of shipping carriers available for the marketplace
ebay.metadata: ShippingExcludeLocation
This type provides applicable locations or region codes to be excluded set by the seller
Fields
- description string - The localized location name
- location string - The location or region to be excluded. Countries are returned through ISO 3166 codes. This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii). The values returned in this field are used in fulfillment business policies (such as in regionName) or through the ExcludeShipToLocation field in an AddItem call
- region string - The region of the excluded shipping area specified, such as:
- Africa
- Americas
- Asia
- Central America and Caribbean
- Europe
- Middle East
- North America
- Oceania
- South America
- Southeast Asia
ebay.metadata: ShippingExcludeLocationResponse
This type provides applicable locations or region codes to be excluded
Fields
- excludeShippingLocations ShippingExcludeLocation[] - The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that the seller has designated as excluded shipping locations
ebay.metadata: ShippingHandlingTime
This type provides applicable shipping handling time metadata
Fields
- maxHandlingTime Signed32 - The integer value returned in this field indicates the maximum number of business days that the eBay site allows as a seller's handling time measured from when the buyer pays for the order. For example, if the maxHandlingTime value is set to 1 and a buyer pays for the order on a Wednesday, the seller would have to ship the item by the next day (Thursday). A maxHandlingTime value of 0 indicates same day handling for an item. In this case, the seller's handling time commitment depends on the order cut off time set in the seller's user preferences. This defaults to 2:00 PM local time on most eBay sites. For orders placed (and cleared payment received) before the local order cut off time, the item must be shipped by the end of the current day. For orders completed on or after the order cut off time, the item must be shipped by the end of the following day (excluding weekends and local holidays)
- description string - The localized description of the maximum handling time
- extendedHandling? boolean - This field is only returned if its value is true. If returned, it indicates that the corresponding handling time is considered extended handling for the marketplace. Extended handling times may be used for freight shipping, but should generally be avoided if possible, as they might adversely affect the buying decisions of potential customers
ebay.metadata: ShippingHandlingTimeResponse
This type provides applicable shipping handling times returned for the specified marketplace
Fields
- handlingTimes ShippingHandlingTime[] - A list of supported handling times for the marketplace
ebay.metadata: ShippingLocation
This type provides applicable shipping location metadata
Fields
- shippingLocation? string - The name or abbreviation of the shipping location or region. Countries are returned through ISO 3166 codes. This field may also include continents and other larger geographical regions (for example, the Middle East, Southeast Asia), as well as domestic/special locations (like APO/FPO, PO Box, Alaska/Hawaii). The values returned in this field are used in fulfillment business policies (such as in regionName) or through the ExcludeShipToLocation field in an AddItem call
- description string - The localized location name
ebay.metadata: ShippingLocationResponse
This type provides applicable shipping location metadata returned
Fields
- shippingLocations ShippingLocation[] - The complete list of geographical regions, countries, domestic areas, and special locations for the specified eBay marketplace that can be set as shipping locations
ebay.metadata: ShippingPoliciesResponse
This type provides fields applicable for shipping policy metadata for the leaf categories returned for the marketplace
Fields
- warnings? ErrorDetailV3[] - An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
- shippingPolicies ShippingPolicy[] - This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter
ebay.metadata: ShippingPolicy
This type contains applicable shipping policy metadata for the leaf categories returned for the marketplace
Fields
- shippingTermsRequired? boolean - Indicates whether the category requires sellers to specify shipping details at listing time
- categoryTreeId string - The unique identifier of the category tree
- group2MaxFlatShippingCost? Amount - The type that defines the fields for the currency and a monetary amount
- globalShippingEnabled? boolean - Indicates if the Global Shipping Program (GSP) is supported for the category
- maxFlatShippingCost? Amount - The type that defines the fields for the currency and a monetary amount
- group3MaxFlatShippingCost? Amount - The type that defines the fields for the currency and a monetary amount
- group1MaxFlatShippingCost? Amount - The type that defines the fields for the currency and a monetary amount
- categoryId string - The unique identifier of the eBay leaf category for which metadata is being returned
- handlingTimeEnabled? boolean - Indicates if a seller's stated handling time is enabled for a category. A handling time is generally needed for items that are shipped to the buyer, but not necessarily applicable to freight shipping or local pickup
ebay.metadata: ShippingService
This type provides applicable shipping service metadata
Fields
- validForSellingFlow boolean - A value of true indicates that the shippingService can be set as an available shipping service in the listing or through the fulfillment business policy
- minShippingTime? Signed32 - This value indicates the minimum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService.
- shippingCategory string - The shipping category of the shipping service including: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, and other similar categories
- maxShippingTime? Signed32 - This value indicates the maximum number of business days that it takes the shippingCarrier to ship an item using the corresponding shippingService.
- packageLimits PackageLimits - The packageLimits field is used to specify the physical constraints and measurement units of packages, ensuring compliance with various shipping requirements
- shippingCostTypes string[] - A list of shipping cost types that this shipping service option supports. For example, FLAT_RATE, CALCULATED, and FREIGHT
- shippingCarrier? string - The code for the shipping carrier returned, for example, UPS, FedEx, and USPS
- description string - This field returns the localized name of the shipping service
- shippingService string - The name of the shipping service. The shipping service named here can only be used in listings or in business policies if validForSellingFlow is true. The value returned in this field is used in listing APIs and business policies to set the shipping service
- internationalService boolean - A value of true indicates that the shipping service is international. An international shipping service option is required if an item is being shipped from one country (origin) to another (destination)
ebay.metadata: ShippingServiceResponse
This type provides applicable shipping service metadata returned
Fields
- shippingServices ShippingService[] - A complete list of shipping service options that can be used on the marketplace for shipping items
ebay.metadata: SignalWord
A type that describes signal words for hazardous materials labels
Fields
- signalWordId? string - The identifier of the signal word. For more information, see Signal word information
- signalWordDescription? string - The description of the signal word localized to the default language of the marketplace. For more information, see Signal word information
ebay.metadata: SiteVisibilityPoliciesResponse
A type that contains eBay international site visibility policy metadata fields
Fields
- warnings? ErrorDetailV3[] - An array of the warnings that were generated as a result of the request. This field is not returned if no warnings were generated by the request
- siteVisibilityPolicies SiteVisibilityPolicy[] - This array contains applicable policy metadata for the leaf categories returned for the marketplace specified in the path parameter marketplace_id and optionally limited by only those leaf category IDs specified in the query parameter filter
ebay.metadata: SiteVisibilityPolicy
A type that contains eBay international cross border trade policy metadata fields
Fields
- categoryTreeId string - The unique identifier of the category tree
- crossBorderTradeNorthAmericaEnabled? boolean - If true, the category supports specifying that listings of a seller on the US or Canada marketplaces can pass in North America as a value in a field to expose that item on the eBay US (ebay.com) and eBay Canada (ebay.ca) sites (English). For more information, see Cross-border trading.
- crossBorderTradeGBEnabled? boolean - If true, the category supports specifying that listings of a seller on the US or Canada marketplaces can pass in UK as a value in a field to expose that item on the eBay UK (ebay.co.uk) and eBay IE (ebay.ie) sites. For more information, see Cross-border trading
- categoryId string - The unique identifier of the eBay leaf category for which metadata is being returned
- crossBorderTradeAustraliaEnabled? boolean - If true, the category supports specifying that listings of a seller on the UK marketplace can pass in Australia as a value in a field to expose that item on the eBay Australia site (ebay.com.au). For more information, see Cross-border trading
ebay.metadata: SortOrder
This type is used to provide the sort order of compatibility properties returned in the response
Fields
- sortPriority? string - The priority of the specified sort order provided.
For example, when a property is assigned Sort1, its values are sorted first. Values for the property assigned Sort2 are sorted second, and so on.
Valid values:
- Sort1
- Sort2
- Sort3
- Sort4
- Sort5
- sortOrder? SortOrderProperties - This type is used to define the property to be used in sorting.
ebay.metadata: SortOrderProperties
This type is used to define the property to be used in sorting.
Fields
- propertyName? string - The name of the searchable property to be used for sorting. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category
- 'order? string - Defines the order of the sort.
Valid values:
- Ascending
- Descending
ebay.metadata: SpecificationRequest
This type provides the properties and specifications to use to search for compatibilities
Fields
- compatibilityPropertyFilters? PropertyFilter[] - This comma-delimited array can be used to restrict the number of compatible application name-value pairs returned in the response by specifying the properties that the seller wishes to be included in the response. Only compatible applications with the specified properties will be returned. Properties that can be specified here include make, model, year, and trim
- exactMatch? boolean - This boolean can be used to specify that the compatibilities returned in the response are to be defined by an exact match on the input value of specification properties. By default, an expanded compatibility match is done when it applies, such as for Load Index, where a compatible vehicle is one that has a load index requirement that is less than or equal to the input. By specifying this field as true, only exact matches are returned
- paginationInput? PaginationInput - This type defines the fields used to control the pagination of the result set
- sortOrders? SortOrder[] - This array specifies the sorting order of the compatibility properties. Any of the searchable properties can be used to specify search order. Up to 5 levels of sort order may be specified. Note: If no sort order is specified through this field, the default sort order of popularity descending is applied.
- datasetPropertyName? string[] - This comma-delimited array can be used to define the specific property name(s) that will be returned in the response. For example, if you specify Engine, the result set will only contain engines that are compatible with the input criteria. Note: This array cannot be used alongside dataset. If both are used, an error will occur.
- dataset? string - This field can be used to define the type of properties that will be returned in the response.
For example, if you specify Searchable, the compatibility details will contain properties that can be used to search for products, such as make or model.
Note: This field cannot be used alongside dataPropertyName. If both are used, an error will occur.
Valid values:
- DisplayableProductDetails: Properties for use in a user interface to describe products.
- DisplayableSearchResults: Properties for use in results for product searches.
- Searchable: Properties for use in searches.
- Sortable: Properties that are suitable for sorting. Default value: DisplayableSearchResults
- specifications PropertyFilter[] - This array defines the specifications of the part, in the form of name-value pairs, for which compatible applications will be retrieved
- categoryId string - The unique identifier of the eBay leaf category for which compatibility details are being retrieved. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcycles. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility by specification. For the categories in the response that support compatibility by specification, you’ll see SPECIFICATIONS as the value for the compatibilityBasedOn field
ebay.metadata: SpecificationResponse
This type defines the fields used in the getCompatibilitiesBySpecification response
Fields
- pagination? Pagination - This type defines the pagination settings for a result set
- compatibilityDetails? Compatibility[] - This container returns the list of all compatible application name-value pairs for the given filter criteria
ebay.metadata: TimeDuration
A complex type that specifies a period of time using a specified time-measurement unit
Fields
- unit? TimeDurationUnitEnum - An enum value that specifies the time-measurement unit that's used to express a time span. | - YEAR: Time duration is based on a number of years. - MONTH: Time duration is based on a number of months - DAY: Time duration is based on a number of days. - HOUR: Time duration is based on a number of hours. - CALENDAR_DAY: Time duration is based on a number of calendar days, including Saturday and Sunday. This time duration does not exclude holidays. - BUSINESS_DAY: Time duration is based on a number of business days, or 'working days' (normally Monday through Friday). This excludes Sunday and all holidays in the time duration and, depending on the location, can include or exclude Saturday. - MINUTE: Time duration is based on a number of minutes. - SECOND: Time duration is based on a number of seconds. - MILLISECOND: Time duration is based on a number of milliseconds
- value? Signed32 - An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field
Union types
ebay.metadata: ListingTypeEnum
ListingTypeEnum
This enumerated type contains the selling formats for eBay listings. | - AUCTION: This value indicates that the corresponding leaf category supports auction listings. - AD_TYPE: This value indicates that the corresponding leaf category supports classified ads in a Real Estate category listings. - PERSONAL_OFFER: This value indicates that the corresponding leaf category supports Second chance offer made to a non-winning bidder listings. - FIXED_PRICE_ITEM: This value indicates that the corresponding leaf category supports fixed-price listings. - LEAD_GENERATION: This value indicates that the corresponding leaf category supports non-Real Estate classified ad listings (the AD_TYPE enumeration value represents Real Estate classified ads)
ebay.metadata: ReturnShippingCostPayerEnum
ReturnShippingCostPayerEnum
An enum list that defines the values you can supply for who pays for the return shipping cost. | - BUYER: Indicates the buyer pays for the return shipping cost.
Note that the seller is responsible for the return shipping cost for all SNAD-related returns. - SELLER: Indicates the seller pays for the return shipping cost
ebay.metadata: DistanceType
DistanceType
This enumeration type indicates support of local listing distances for items listed by sellers. | - LOCAL_LISTING_DISTANCES_REGULAR: Indicates that one or more eBay marketplaces allow dealership subscribers with a regular subscription to specify local market radius for Motors Local Market listings. - LOCAL_LISTING_DISTANCES_SPECIALTY: Indicates that one or more eBay marketplaces allow dealership subscribers with a specialty subscription to specify local market radius for Motors Local Market listings. - LOCAL_LISTING_DISTANCES_NON_SUBSCRIPTION: Indicates that one or more eBay marketplaces allow dealership subscribers without a subscription to specify local market radius for Motors Local Market listings.
ebay.metadata: CurrencyCodeEnum
CurrencyCodeEnum
The three-letter ISO 4217 code representing a world currency. | - AED: United Arab Emirates dirham - AFN: Afghan afghani - ALL: Albanian lek - AMD: Armenian dram - ANG: Netherlands Antillean guilder - AOA: Angolan kwanza - ARS: Argentine peso - AUD: Australian dollar - AWG: Aruban florin - AZN: Azerbaijani manat - BAM: Bosnia and Herzegovina convertible mark - BBD: Barbados dollar - BDT: Bangladeshi taka - BGN: Bulgarian lev - BHD: Bahraini dinar - BIF: Burundian franc - BMD: Bermudian dollar - BND: Brunei dollar - BOB: Bolivian Boliviano - BRL: Brazilian real - BSD: Bahamian dollar - BTN: Bhutanese ngultrum - BWP: Botswana pula - BYR: Belarusian ruble - BZD: Belize dollar - CAD: Canadian dollar - CDF: Congolese franc - CHF: Swiss franc - CLP: Chilean peso - CNY: Chinese yuan renminbi - COP: Colombian peso - CRC: Costa Rican colon - CUP: Cuban peso - CVE: Cape Verde escudo - CZK: Czech koruna - DJF: Djiboutian franc - DKK: Danish krone - DOP: Dominican peso - DZD: Algerian dinar - EGP: Egyptian pound - ERN: Eritrean nakfa - ETB: Ethiopian birr - EUR: European Union euro - FJD: Fiji dollar - FKP: Falkland Islands pound - GBP: British pound sterling - GEL: Georgian lari - GHS: Ghanaian cedi - GIP: Gibraltar pound - GMD: Gambian dalasi - GNF: Guinean franc - GTQ: Guatemalan quetzal - GYD: Guyanese dollar - HKD: Hong Kong dollar - HNL: Honduran lempira - HRK: Croatian kuna - HTG: Haitian gourde - HUF: Hungarian forint - IDR: Indonesian rupiah - ILS: Israeli new shekel - INR: Indian rupee - IQD: Iraqi dinar - IRR: Iranian rial - ISK: Icelandic krona - JMD: Jamaican dollar - JOD: Jordanian dinar - JPY: Japanese yen - KES: Kenyan shilling - KGS: Kyrgyzstani som - KHR: Cambodian riel - KMF: Comoro franc - KPW: North Korean won - KRW: South Korean won - KWD: Kuwaiti dinar - KYD: Cayman Islands dollar - KZT: Kazakhstani tenge - LAK: Lao kip - LBP: Lebanese pound - LKR: Sri Lankan rupee - LRD: Liberian dollar - LSL: Lesotho loti - LTL: Lithuanian litas - LYD: Libyan dinar - MAD: Moroccan dirham - MDL: Moldovan leu - MGA: Malagasy ariary - MKD: Macedonian denar - MMK: Myanmar kyat - MNT: Mongolian tugrik - MOP: Macanese pataca - MRO: Mauritanian ouguiya - MUR: Mauritian rupee - MVR: Maldivian rufiyaa - MWK: Malawian kwacha - MXN: Mexican peso - MYR: Malaysian ringgit - MZN: Mozambican metical - NAD: Namibian dollar - NGN: Nigerian naira - NIO: Nicaraguan cordoba oro - NOK: Norwegian krone - NPR: Nepalese rupee - NZD: New Zealand dollar - OMR: Omani rial - PAB: Panamanian balboa - PEN: Peruvian sol - PGK: Papua New Guinean kina - PHP: Philippine peso - PKR: Pakistani rupee - PLN: Polish zloty - PYG: Paraguayan guarani - QAR: Qatari riyal - RON: Romanian leu - RSD: Serbian dinar - RUB: Russian ruble - RWF: Rwandan franc - SAR: Saudi riyal - SBD: Solomon Islands dollar - SCR: Seychelles rupee - SDG: Sudanese pound - SEK: Swedish krona - SGD: Singapore dollar - SHP: Saint Helena pound - SLL: Sierra Leonean leone - SOS: Somali shilling - SRD: Surinamese dollar - STD: Sao Tome and Principe dobra - SYP: Syrian pound - SZL: Swazi lilangeni - THB: Thai baht - TJS: Tajikistani somoni - TMT: Turkmenistani manat - TND: Tunisian dinar - TOP: Tongan pa'anga - TRY: Turkish lira - TTD: Trinidad and Tobago dollar - TWD: New Taiwan dollar - TZS: Tanzanian shilling - UAH: Ukrainian hryvnia - UGX: Ugandan shilling - USD: United States dollar - UYU: Uruguayan peso - UZS: Uzbekistani som - VEF: Venezuelan bolivar - VND: Vietnamese dong - VUV: Vanuatu vatu - WST: Samoan tala - XAF: CFA franc BEAC - XCD: East Caribbean dollar - XOF: CFA franc BCEAO - XPF: CFP franc - YER: Yemeni rial - ZAR: South African rand - ZMW: Zambian kwacha - ZWL: Zimbabwean dollar
ebay.metadata: TimeDurationUnitEnum
TimeDurationUnitEnum
An enum value that specifies the time-measurement unit that's used to express a time span. | - YEAR: Time duration is based on a number of years. - MONTH: Time duration is based on a number of months - DAY: Time duration is based on a number of days. - HOUR: Time duration is based on a number of hours. - CALENDAR_DAY: Time duration is based on a number of calendar days, including Saturday and Sunday. This time duration does not exclude holidays. - BUSINESS_DAY: Time duration is based on a number of business days, or 'working days' (normally Monday through Friday). This excludes Sunday and all holidays in the time duration and, depending on the location, can include or exclude Saturday. - MINUTE: Time duration is based on a number of minutes. - SECOND: Time duration is based on a number of seconds. - MILLISECOND: Time duration is based on a number of milliseconds
ebay.metadata: ClassifiedAdBestOfferEnabledEnum
ClassifiedAdBestOfferEnabledEnum
This enumerated type defines values that indicate whether the category supports Classified Ad Best Offers. | - DISABLED: This value indicates that Classified Ad Best Offer feature is disabled for most categories. - ENABLED: This value indicates that Classified Ad Best Offer feature is enabled for most categories. - REQUIRED: This value indicates that Classified Ad Best Offer feature is required for a specific category.
ebay.metadata: CardinalityEnum
CardinalityEnum
This enumeration type is used to indicate whether a condition descriptor can have just a single value or multiple values. | - SINGLE: This enumeration value indicates that only a single value can be used for the condition descriptor. - MULTI: This enumeration value indicates that multiple values can be used for the condition descriptor
ebay.metadata: CompatibilityTypeEnum
CompatibilityTypeEnum
This enumerated type defines how the compatibility details are listed on the specified category. | - SPECIFICATIONS: The compatibility details are listed by the specifications of the part. For example, dimensions or other defining characteristics of the part. - ASSEMBLY: The compatibility details are listed by by the vehicle assembly information, such as make, model, year of production, and so on
ebay.metadata: GeographicExposureEnum
GeographicExposureEnum
An enumerated type that indicates if an eBay site or category supports Motors National Listings and/or Motors Local Market listings. | - National: This enumeration value indicates the eBay site or category only supports Motors National Listings for the corresponding Motors dealer subscription level/type. - LocalOnly: This enumeration value the eBay site or category only supports Motors Local Market Listings for the corresponding Motors dealer subscription level/type. - LocalOptional: This enumeration value the eBay site or category supports Motors National Listings and Motors Local Market listing for the corresponding Motors dealer subscription level/type
ebay.metadata: CompatibleVehicleTypeEnum
CompatibleVehicleTypeEnum
This type contains enumerated values defining different motor vehicle groups across eBay marketplaces. | - US_CARS_AND_TRUCKS: This value indicates that the corresponding leaf category contains Cars & Trucks listings on the US Motors marketplace. - US_MOTORCYCLES: This value indicates that the corresponding leaf category contains Motorcycles on the United States marketplace. - DE_CARS_AND_TRUCKS: This value indicates that the corresponding leaf category contains Cars & Trucks listings on the on the Germany marketplace. - UK_CARS_AND_TRUCKS: This value indicates that the corresponding leaf category contains Cars & Trucks listings on the on the Great Britain marketplace. - US_ATV: This value indicates that the corresponding leaf category contains ATVs on the United States marketplace. - AU_CARS_AND_TRUCKS: This value indicates that the corresponding leaf category contains Cars & Trucks listings on the on the Australia marketplace. - US_BOATS: This value indicates that the corresponding leaf category contains Boats on the United States marketplace. - US_ATV_UTV: This value indicates that the corresponding leaf category contains ATVs and UTVs on the United States marketplace. - US_SNOWMOBILES: This value indicates that the corresponding leaf category contains Snowmobiles on the United States marketplace. - US_POWERSPORTS: This value indicates that the corresponding leaf category contains Powersports vehicles on the United States marketplace. - US_SCOOTERS: This value indicates that the corresponding leaf category contains Scooters on the United States marketplace. - US_GOLF_CARTS: This value indicates that the corresponding leaf category contains Golf Carts on the United States marketplace. - US_WATERCRAFTS: This value indicates that the corresponding leaf category contains Watercraft vehicles on the United States marketplace. - DE_MOTORCYCLES: This value indicates that the corresponding leaf category contains Motorcycles on the Germany marketplace. - DE_SCOOTERS: This value indicates that the corresponding leaf category contains Scooters on the Germany marketplace. - UK_MOTORCYCLES: This value indicates that the corresponding leaf category contains Motorcycles on the Great Britain marketplace. - UK_SCOOTERS: This value indicates that the corresponding leaf category contains Scooters on the Great Britain marketplace. - IT_CARS_AND_TRUCKS: This value indicates that the corresponding leaf category contains Cars & Trucks listings on the on the Italy marketplace. - FR_CARS_AND_TRUCKS: This value indicates that the corresponding leaf category contains Cars & Trucks listings on the on the France marketplace. - ES_CARS_AND_TRUCKS: This value indicates that the corresponding leaf category contains Cars & Trucks listings on the on the Spain marketplace. - CA_CARS_AND_TRUCKS: This value indicates that the corresponding leaf category contains Cars & Trucks listings on the on the Canada marketplace. - DEFAULT_VALUE: This enumeration value may be returned if the vehicle group cannot be determined
ebay.metadata: ModeEnum
ModeEnum
This enumeration value indicates whether a condition descriptor input is selection only or free text. | - SELECTION_ONLY: This enum indicates that the input is selection only. - FREE_TEXT: This enum indicates that the input is free text
ebay.metadata: ExtendedProducerResponsibilityEnum
ExtendedProducerResponsibilityEnum
An enumerated type that identifies the attributes used in Extended Producer Responsibility policies.Note: Extended Producer Responsibility IDs are no longer set at the listing level so category-level metadata is no longer returned for PRODUCER_PRODUCT_ID, PRODUCT_DOCUMENTATION_ID, PRODUCT_PACKAGE_ID, and SHIPMENT_PACKAGE_ID. Sellers will provide/manage these IDs at the account level by going to Account Settings. | - ECO_PARTICIPATION_FEE: This enum value is used to identify the eco participation fee attribute. - TAKE_BACK_POLICY: This enum value is used to identify the take-back policy attribute. - REPAIR_SCORE: This enum value is used to identify the repair score attribute.
ebay.metadata: PaymentEnum
PaymentEnum
An enumerated type that defines the different payment methods that can be used by buyers to pay sellers for purchases. Note: This value is only applicable for offline payments. | - CASH_ON_PICKUP: This enumeration value indicates that cash on pickup is accepted for payment. This value is only applicable for offline payments. - PAYMENT_SEE_DESCRIPTION: This enumeration value indicates that payment format is described in the listing description. This value is only applicable for offline payments and is not supported on all marketplaces. - MOCC: This enumeration value indicates that a money order or cashiers check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces. - PERSONAL_CHECK: This enumeration value indicates that a personal check is accepted for payment. This value is only applicable for offline payments and is not supported on all marketplaces. - OTHER: This enumeration value indicates that the payment format accepted for payment is not described by any of the other payment methods. This value is only applicable for offline payments
ebay.metadata: GenericUsageEnum
GenericUsageEnum
An enumerated type that indicates whether an Extended Producer Responsibility attribute is optional, recommended, or required. | - OPTIONAL: This enum value indicates that the attribute is optional. - RECOMMENDED: This enum value indicates that the attribute is recommended. - REQUIRED: This enum value indicates that the attribute is required
ebay.metadata: RegulatoryAttributeEnum
RegulatoryAttributeEnum
An enumerated type that indicates supported regulatory attributes. | - HAZMAT: Indicates hazardous materials labels support in listing flows. - ENERGY_EFFICIENCY: Indicates energy efficiency class support in listing flows. - MANUFACTURER_CONTACT: Indicates support for manufacturer contacts in listing flows. - PRODUCT_SAFETY: Indicates product safety support in listing flows.
ebay.metadata: DurationEnum
DurationEnum
This enumerated type defines the supported listing duration periods. | - GTC: This value indicates that the corresponding leaf category and listing type supports GTC (Good 'til Cancelled) listing duration. GTC is typically the only supported value for fixed-price listings. - DAYS_1: This enumerated value indicates that the listing is valid for 1 day.
Note: Legacy support: If DAYS_1 is supported for your listing category, use Days_1 as the value in the ListingDuration field when creating/revising a listing with the Trading API. - DAYS_3: This value indicates that the corresponding leaf category and listing type supports a 3-day listing duration.
Note: Legacy support: If DAYS_3 is supported for your listing category, use Days_3 when creating/revising a listing with the Trading API. - DAYS_5: This value indicates that the corresponding leaf category and listing type supports a 5-day listing duration.
Note: Legacy support: If DAYS_5 is supported for your listing category, use Days_5 as the value in the ListingDuration field when creating/revising a listing with the Trading API. - DAYS_7: This value indicates that the corresponding leaf category and listing type supports a 7-day listing duration.
Note: Legacy support: If DAYS_7 is supported for your listing category, use Days_7 as the value in the ListingDuration field when creating/revising a listing with the Trading API. - DAYS_10: This value indicates that the corresponding leaf category and listing type supports a 10-day listing duration.
Note: Legacy support: If DAYS_10 is supported for your listing category, use Days_10 as the value in the ListingDuration field when creating/revising a listing with the Trading API. - DAYS_30: This value indicates that the corresponding leaf category and listing type supports a 30-day listing duration. This is a typical listing duration for Classified Ad listings.
Note: Legacy support: If DAYS_30 is supported for your listing category, use Days_30 as the value in the ListingDuration field when creating/revising a listing with the Trading API. - DAYS_90: This value indicates that the corresponding leaf category and listing type supports a 90-day listing duration. This is a typical listing duration for Classified Ad listings.
Note: Legacy support: If DAYS_90 is supported for your listing category, use Days_90 as the value in the ListingDuration field when creating/revising a listing with the Trading API.
ebay.metadata: AdFormatEnabledEnum
AdFormatEnabledEnum
This enumerated type contains a list of values indicating type or status of available ad formats for an eBay site or for an eBay category. | - DISABLED: This value indicates that the Classified Ad format feature is disabled for the site or category. - ENABLED: This value indicates that the Classified Ad format feature is enabled for the site or category. - ONLY: This value indicates that the Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - CLASSIFIED_AD_ENABLED: This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - CLASSIFIED_AD_ONLY: This value indicates that the lead-generation Classified Ad format is the only listing type supported by the eBay category. This value is not applicable at the eBay site level. - LOCAL_MARKET_BEST_OFFER_ONLY: This value indicates that eBay Motors Local Market listings are enabled for the site or category
ebay.metadata: ProductIdentifierEnabledEnum
ProductIdentifierEnabledEnum
This enumerated type specifies whether a leaf category supports or requires a Universal Product Code (UPC), International Standard Book Number (ISBN), or European Article Number (EAN) for products. Collectively, these identifiers are referred to as Global Trade Item Numbers (GTINs). | - DISABLED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is not supported for the leaf category. - ENABLED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is supported as applicable, but not required for the leaf category - REQUIRED: This value indicates that the corresponding Global Trade Item Number (GTIN) type is required for the leaf category, and an Add/Revise operation will fail without this information
ebay.metadata: MarketplaceIdEnum
MarketplaceIdEnum
This type contains enumerated values of the standard codes that represent each of the eBay marketplaces. | - EBAY_US: Indicates the eBay marketplace for the United States. - EBAY_CA: Indicates the eBay marketplace for Canada.
Note: When targeting the French locale of the Canadian marketplace, add the Accept-Language request header and pass in fr-CA. If this locale is not specified, the language will default to English. - EBAY_GB: Indicates the eBay marketplace for Great Britain (United Kingdom). - EBAY_AU: Indicates the eBay marketplace for Australia. - EBAY_AT: Indicates the eBay marketplace for Austria. - EBAY_BE: Indicates the eBay marketplace for Belgium.
Note: When targeting the French locale of the Belgium marketplace, add the Accept-Language request header and pass in fr-BE. If this locale is not specified, the language will default to Dutch. - EBAY_DE: Indicates the eBay marketplace for Germany. - EBAY_IT: Indicates the eBay marketplace for Italy. - EBAY_NL: Indicates the eBay marketplace for The Netherlands. - EBAY_ES: Indicates the eBay marketplace for Spain. - EBAY_CH: Indicates the eBay marketplace for Switzerland. - EBAY_TW: Indicates the eBay marketplace for Taiwan. - EBAY_CZ: This marketplace is not currently supported. - EBAY_DK: This marketplace is not currently supported. - EBAY_FI: This marketplace is not currently supported. - EBAY_FR: Indicates the eBay marketplace for France. - EBAY_GR: This marketplace is not currently supported. - EBAY_HK: Indicates the eBay marketplace for Hong Kong. - EBAY_HU: This marketplace is not currently supported. - EBAY_IN: This marketplace is not currently supported. - EBAY_ID: This marketplace is not currently supported. - EBAY_IE: Indicates the eBay marketplace for Indicates the eBay marketplace for Ireland. - EBAY_IL: This marketplace is not currently supported. - EBAY_MY: Indicates the eBay marketplace for Malaysia. - EBAY_NZ: This marketplace is not currently supported. - EBAY_NO: This marketplace is not currently supported. - EBAY_PH: This marketplace is not currently supported. - EBAY_PL: Indicates the eBay marketplace for Poland. - EBAY_PT: Indicates the eBay marketplace for Portugal. - EBAY_PR: This marketplace is not currently supported. - EBAY_RU: This marketplace is not currently supported. - EBAY_SG: Indicates the eBay marketplace for Singapore. - EBAY_ZA: This marketplace is not currently supported. - EBAY_SE: This marketplace is not currently supported. - EBAY_TH: This marketplace is not currently supported. - EBAY_VN: This marketplace is not currently supported. - EBAY_CN: This marketplace is not currently supported. - EBAY_JP: This marketplace is not currently supported. - EBAY_PE: This marketplace is not currently supported. - EBAY_HALF_US: No longer used. - EBAY_MOTORS_US: Indicates the eBay marketplace is eBay Motors
ebay.metadata: ClassifiedAdPaymentMethodEnabledEnum
ClassifiedAdPaymentMethodEnabledEnum
This enumerated type defines values that indicate whether the payment method will be displayed for a category. | - ENABLED_WITH_CHECKOUT: This value indicates display of the payment method and permits checkout. - ENABLED_WITHOUT_CHECKOUT: This value indicates display of the payment method and suppresses checkout. - NOT_SUPPORTED: This value indicates the payment method is not displayed
Import
import ballerinax/ebay.metadata;Metadata
Released date: 1 day ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-21 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 51
Current verison: 1
Weekly downloads
Keywords
Vendor/eBay
Area/E-Commerce
Type/Connector
Contributors