Use this method to obtain the details about one or more feed types that are available to be downloaded. If no query parameters are used, all possible feed types are returned.
You can filter your search by adding feed_scope and/or marketplace_ids parameters to the URI.For instance, a call using GET https://api.ebay.com/buy/feed/v1/feed_type will return all available feed files. A call using GET https://api.ebay.com/buy/feed/v1/feed_type?feed_scope=DAILY&marketplace_ids=EBAY_US will limit the returned list to daily feed files available from the US marketplace.
For a list of supported sites and other restrictions, see API restrictions.
","operationId":"getFeedTypes","parameters":[{"name":"continuation_token","in":"query","description":"The server returns this token to the web client when the responses received require multiple pages to display. The web client sends this token back to the server to get the next page of results.","required":false,"schema":{"type":"string"}},{"name":"feed_scope","in":"query","description":"This query parameter specifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).DAILY and HOURLY are supported.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the number of records to show in the current response.GET https://api.ebay.com/buy/feed/v1/feedtype?marketplaceids=EBAY_FR,EBAY_AU.Use this method to download a selected feed file. Use the getFiles methods to obtain the file_id of the specific feed file you require. The feed files are binary gzip files. If the file is larger than 200 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a GZIP feed file. In addition to the API, there is an open source Feed V1 SDK written in .NET that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.","operationId":"downloadFile","parameters":[{"name":"file_id","in":"path","description":"This path parameter specifies the unique identifier of the feed file that you wish to download. Details in the response include: the feed's file_id, the date it became available, eBay categories that support the feed, its frequency, the time span it covers, its feed type, its format, its size in bytes, the schema under which it was pulled, and the marketplaces it applies to. This method provides a list of the feed files available for download. Details for each feed returned include the date the feed was generated, the frequency with which it is pulled, its feed type, its fileId, its format, the eBay marketplaces it applies to, the schema version under which it was generated, its size in bytes, and the time span it covers (in hours). You can limit your search results by feed type, marketplace, scope, eBay L1 category, and how far back in time from the present the feed was made available. Set the For a list of supported sites and other restrictions, see API Restrictions. Important! Unless the look_back filter is used, available files generated approximately within the last 48 hours are returned in the response. The look_back filter can be used to increase or decrease this time frame. The maximum (minutes) value set for this parameter should not exceed the lookBack threshold for the feed type returned in getFeedType/getFeedTypes. This enumerated type defines the list of the values that represent the level of access to a feed. The enumerated type defines the key element for a value in the dimensions array, paired with its value(s). This enumerated type defines the list of possible feed scopes. Currently only This enumerated type defines the list of the values that represent the availability of the feed. This enumerated type defines the list of available format types in which a feed file can be downloaded.
Note:The downloaded file will be gzipped automatically, so there is no reason to supply Accept-Encoding:gzip as a header. If this header is supplied, the downloaded file will be compressed twice, and this has no extra benefit.Downloading feed files
Use the getFiles method to obtain the file_id value for the desired feed file.","required":true,"schema":{"type":"string"}},{"name":"Range","in":"header","description":"Indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file.
Example: bytes=0-102400.
For more information about using this header, see Retrieving a GZIP feed file.","required":false,"schema":{"type":"string"}},{"name":"X-EBAY-C-MARKETPLACE-ID","in":"header","description":"Indicates the unique identifier of the eBay marketplace that the feed file belongs to.
Example: X-EBAY-C-MARKETPLACE-ID: EBAY_US.
See MarketplaceIdEnum for supported values.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"Content-range":{"schema":{"type":"string","description":"The content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes.
Maximum range: 200 MB
The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.
0-10/1000
For more information and examples, see Retrieving a GZIP feed file."}}},"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/OutputStream"}}}},"206":{"description":"Partial Content","headers":{"Content-range":{"schema":{"type":"string","description":"The content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes.
Maximum range: 200 MB
The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.
0-10/1000
For more information and examples, see Retrieving a GZIP feed file."}}},"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/OutputStream"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"13014":{"domain":"API_FEED","category":"REQUEST","description":"Invalid or missing header X-EBAY-C-MARKETPLACE-ID."},"13015":{"domain":"API_FEED","category":"REQUEST","description":"Range header is required for file size greater than {allowedLength} bytes."},"13016":{"domain":"API_FEED","category":"REQUEST","description":"The Range request header format is invalid. Format: 'bytes=start position-end position'. For help, see the API Reference documentation for this call."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"14007":{"domain":"API_FEED","category":"REQUEST","description":"Insufficient permissions to download this file. Please check oauth scopes required for this feed type and buy/feed/v1/access for access constraints."},"14009":{"domain":"API_FEED","category":"REQUEST","description":"Insufficient permissions for the feed type for the specified marketplace. Please contact eBay Technical Support for further assistance."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"14004":{"domain":"API_FEED","category":"REQUEST","description":"The specified file Id does not exist for marketplace specified or may have expired. Please check the maximum allowed look back for the feed type and scope."}}}},"416":{"description":"Range Not Satisfiable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"13017":{"domain":"API_FEED","category":"REQUEST","description":"The Range header is invalid. Please verify that the start and end positions are correct, 'range start-range end' does not exceed the allowed maximum of {allowedLength} bytes and is consistent with the file size."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"13006":{"domain":"API_FEED","category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/buy.item.feed"]}]}},"/file/{file_id}":{"get":{"tags":["file"],"description":"Use this method to fetch the details of a feed file available to download, as specified by the file's file_id.
Use the getFiles method to obtain the fileId value for the desired feed file.","required":true,"schema":{"type":"string"}},{"name":"X-EBAY-C-MARKETPLACE-ID","in":"header","description":"Indicates the unique identifier of the eBay marketplace on which the feed file exists.
Example: X-EBAY-C-MARKETPLACE-ID: EBAY_US.
See MarketplaceIdEnum for supported values.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileMetadata"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"13014":{"domain":"API_FEED","category":"REQUEST","description":"Invalid or missing header X-EBAY-C-MARKETPLACE-ID."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"14009":{"domain":"API_FEED","category":"REQUEST","description":"Insufficient permissions for the feed type for the specified marketplace. Please contact eBay Technical Support for further assistance."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"14004":{"domain":"API_FEED","category":"REQUEST","description":"The specified file Id does not exist for marketplace specified or may have expired. Please check the maximum allowed look back for the feed type and scope."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"13006":{"domain":"API_FEED","category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/buy.item.feed"]}],"summary":"Retrieves detailed metadata on a specific feed file."}},"/file":{"get":{"tags":["file"],"description":"Restrictions
If this filter is used, only feed files that are supported for the specified category (or categories) will be returned in the response. Each category ID value must be delimited by a comma.
For details, see Get Categories for Buy APIs.
Max: 20 values","required":false,"schema":{"type":"string"}},{"name":"continuation_token","in":"query","description":"The server returns this token to the web client when the responses received require multiple pages to display. The web client sends this token back to the server to get the next page of results.","required":false,"schema":{"type":"string"}},{"name":"feed_scope","in":"query","description":"This query parameter specifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).
Note: Currently only DAILY and HOURLY are supported.","required":false,"schema":{"type":"string"}},{"name":"feed_type_id","in":"query","description":"This query parameter specifies the unique identifier for the feed type to be used as a search filter.
Use the getFeedTypes method to identify available feed types.
Note: Refer to Supported feed types to learn more about the feed types supported by the Feed API.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Indicates the number of records to show in the response.
Default: 20
Minimum: 20
Maximum: 100","required":false,"schema":{"type":"string"}},{"name":"look_back","in":"query","description":"This filter controls how far back from the current time to limit the returned feed files and is specified in minutes. The returned feed files will be those generated between the current time and the look-back time.
Example: A value of 120 will limit the returned feed files to those generated in the past 2 hours (120 minutes). If 3 feed files have been generated in the past 2 hours, those 3 files will be returned. A feed file generated 4 hours earlier will not be returned.
Example: X-EBAY-C-MARKETPLACE-ID: EBAY_US.
See MarketplaceIdEnum for supported values.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileMetadataSearchResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"13003":{"domain":"API_FEED","category":"REQUEST","description":"Invalid 'feed_scope'. Valid values: [HOURLY,DAILY,WEEKLY]"},"13014":{"domain":"API_FEED","category":"REQUEST","description":"Invalid or missing header X-EBAY-C-MARKETPLACE-ID."},"14001":{"domain":"API_FEED","category":"REQUEST","description":"Invalid limit. Supported ranges 20 - 100."},"14002":{"domain":"API_FEED","category":"REQUEST","description":"Invalid or expired continuation token."},"14005":{"domain":"API_FEED","category":"REQUEST","description":"Maximum number of category_ids exceeded.Limit: 20."},"14006":{"domain":"API_FEED","category":"REQUEST","description":"Invalid look back period for the feedType and feedScope.Please refer to documentation."},"14008":{"domain":"API_FEED","category":"REQUEST","description":"Invalid or missing feed type Id."}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"14009":{"domain":"API_FEED","category":"REQUEST","description":"Insufficient permissions for the feed type for the specified marketplace. Please contact eBay Technical Support for further assistance."}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"x-response-codes":{"errors":{"13006":{"domain":"API_FEED","category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/buy.item.feed"]}],"summary":"Retrieves detailed metadata on one or more feed files based on search criteria."}}},"components":{"schemas":{"Access":{"type":"object","required":["constraints","feedType"],"properties":{"constraints":{"type":"array","description":"This array shows the eBay marketplace and eBay L1 categories that the corresponding feed type applies to. If there are no marketplaceId constraints, the application has access to all marketplaces. If there are no categoryId constraints, then the application has access to all categories within the given marketplace.","items":{"$ref":"#/components/schemas/FeedTypeConstraint"}},"feedType":{"type":"string","description":"The identifier of the feed type that the application has access to."}},"description":"This type defines the constraints on the feed files available for download within the specified feed type."},"AccessEnum":{"type":"object","description":"
Code so that your app gracefully handles any future changes to this list. | - **TEMPORARILY_UNAVAILABLE**: Indicates the item is not available now but could be available again in a near future. This could be due to an out-of-stock condition, the seller is on vacation, etc. - **AVAILABLE**: Indicates there are items available for purchase. - **UNAVAILABLE**: Indicates that the item is no longer available. This could be due to the seller ending the listing or the listing being removed due to a listing violation.","enum":["TEMPORARILY_UNAVAILABLE","AVAILABLE","UNAVAILABLE"]},"Category":{"type":"object","properties":{"categoryId":{"type":"string","description":"The unique identifier of the category."},"categoryLevel":{"type":"object","description":"The level of the category in the hierarchy."},"categoryName":{"type":"string","description":"The name of the category."},"categoryFullName":{"type":"string","description":" The full category name from the root category level (the full breadcrumb path)."}},"description":"This type defines information about a specific eBay category, including its ID, name, and hierarchy information."},"ConditionDescriptor":{"type":"object","description":"This type defines the name/value pairs of a condition descriptor.","properties":{"name":{"type":"string","description":"The name of a condition descriptor. The value(s) for this condition descriptor are returned in the associated values array."},"values":{"type":"array","description":"This array displays the value(s) for a condition descriptor (denoted by the associated name field), as well as any other additional information about the condition of the item.","items":{"$ref":"#/components/schemas/ConditionDescriptorValue"}}}},"ConditionDescriptorValue":{"type":"object","description":"This type defines the content and additionalInfo fields of a condition descriptor value.","properties":{"content":{"type":"string","description":"The value for the condition descriptor indicated in the associated name field."},"additionalInfo":{"type":"array","description":"Additional information about the condition of an item as it relates to a condition descriptor. This array elaborates on the value specified in the content field and provides additional details about the condition of an item.","items":{"type":"string"}}}},"Constraint":{"type":"object","properties":{"marketplaceIds":{"type":"array","description":"A list of the marketplaces to which the application is constrained within the feed type.
Example: A value of EBAY_US means the application is constrained to the U.S. marketplace for the listed feed.
Note: The Buy Feed API is not supported by all eBay marketplaces. See API restrictions for information about regional constraints.","items":{"$ref":"#/components/schemas/MarketplaceIdEnum"}}},"description":"This type defines the parameter of the application's configuration used to define the feed files that the application can access."},"Criteria":{"type":"object","properties":{"itemIds":{"type":"array","description":"An array of item IDs included in the discount.
eBay RESTful format: v1|itemId|skuId","items":{"type":"string"}},"excludedItemIds":{"type":"array","description":"An array of item IDs excluded from the discount.","items":{"type":"string"}},"sellerUserIds":{"type":"array","description":"An array of seller IDs included in the discount.","items":{"type":"string"}},"excludedSellerUserIds":{"type":"array","description":"An array of seller IDs excluded from the discount.","items":{"type":"string"}},"categories":{"description":"An array of included category objects, with metadata, included in the discount.","$ref":"#/components/schemas/Category"},"excludedCategories":{"description":"An array of categories, with metadata, excluded from the discount.","$ref":"#/components/schemas/Category"}},"description":"This type defines the criteria for which items are eligible based on item IDs, seller IDs, and category IDs"},"CurrencyCodeEnum":{"type":"object","description":"This enumerated type lists the three-letter ISO 4217 code representing the supported world currencies. | - **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","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"]},"Dimension":{"type":"object","properties":{"dimensionKey":{"description":"The key element for a value in the dimensions array, paired with its value(s).","$ref":"#/components/schemas/DimensionKeyEnum"},"values":{"type":"array","description":"The dimension value(s) paired with the dimensionKey in the dimensions array.","items":{"type":"string"}}},"description":"This type defines a key-pair array of values used to define the feed files available to the application."},"DimensionKeyEnum":{"type":"object","description":"172008, not Gift Cards & Coupons. - **LISTING_MARKETPLACE_ID**: The two-letter code of the eBay marketplace on which listings are available for Cross Border Trading (CBT). - **LISTING_CATEGORY**: The eBay category for which listings are available for Cross Border Trading (CBT).","enum":["CATEGORY","LISTING_MARKETPLACE_ID","LISTING_CATEGORY"]},"DiscountBenefitEnum":{"type":"object","description":"An enumerated type that defines the types of supported Discount Benefits. | - **AMOUNT_OFF_ITEM**: An amount discounted off the item. - **AMOUNT_OFF_ORDER**: An amount discounted off an order. - **PERCENTAGE_OFF_ITEM**: A percentage discounted off the sales price of the item. - **PERCENTAGE_OFF_ORDER**: A percentage discounted off the order price.","enum":["AMOUNT_OFF_ITEM","AMOUNT_OFF_ORDER","PERCENTAGE_OFF_ITEM","PERCENTAGE_OFF_ORDER"]},"DiscountSpecificationEnum":{"type":"object","description":"An enumerated type that defines the criteria for when the discount triggers. | - **MIN_AMOUNT**: The minimum monetary amount, or threshold, the buyer must spend to trigger the discount. - **FOR_EACH_AMOUNT**: The discount triggers each time the buyer purchases the specified monetary amount. - **MIN_QUANTITY**: The minimum number of items the buyer must purchase to trigger the discount. - **FOR_EACH_QUANTITY**: The discount triggers each time the buyer purchases the specified quantity of discounted items.","enum":["MIN_AMOUNT","FOR_EACH_AMOUNT","MIN_QUANTITY","FOR_EACH_QUANTITY"]},"Error":{"type":"object","properties":{"category":{"type":"string","description":"Identifies the type of error."},"domain":{"type":"string","description":"Name for the primary system where the error occurred. This is relevant for application errors."},"errorId":{"type":"integer","description":"A unique number to identify the error.","format":"int32"},"inputRefIds":{"type":"array","description":"An array of request elements most closely associated to the error.","items":{"type":"string"}},"longMessage":{"type":"string","description":"A more detailed explanation of the error."},"message":{"type":"string","description":"Information on how to correct the problem, in the end user's terms and language where applicable."},"outputRefIds":{"type":"array","description":"An array of request elements most closely associated to the error.","items":{"type":"string"}},"parameters":{"type":"array","description":"An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.","items":{"$ref":"#/components/schemas/ErrorParameter"}},"subdomain":{"type":"string","description":"Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc."}},"description":"This type defines the fields that can be returned in an error."},"ErrorParameter":{"type":"object","description":"This type defines the parameters of an error.","properties":{"name":{"type":"string","description":"The object of the error."},"value":{"type":"string","description":"The value of the object."}}},"FeedScopeEnum":{"type":"object","description":"DAILY and HOURLY are supported.
Note: Refer to Supported feed types for additional details."},"supportedFeeds":{"type":"array","description":"An array of the feed files of the indicated feed type that are available to be downloaded.","items":{"$ref":"#/components/schemas/SupportedFeed"}}},"description":"This type is used by the getFeedType and getFeedTypes methods to provide more details about a feed type, including the OAuth scopes required to download the feed files and the constraints on the feed type."},"FeedTypeConstraint":{"type":"object","properties":{"categoryIds":{"type":"array","description":"An array of the eBay categories the application can access in a feed. See the Taxonomy API for details about obtaining a list eBay L1 categories. The category is expressed as the category's categoryId, not its categoryName; e.g., 172008, not Gift Cards & Coupons.
If no categoryIds are listed, the application can access all categories in the specified marketplace.","items":{"type":"string"}},"listingMarketplaceConstraints":{"type":"array","description":"An array of the eBay marketplace and categories in which listings are available for Cross Border Trading (CBT). Listings on the specified marketplace and categories can be shipped to the marketplace specified for the feed type.
Note: This array will only be returned for the CBT_ITEM_ALL_ACTIVE feed type.","items":{"$ref":"#/components/schemas/ListingMarketplaceFeedTypeConstraint"}},"marketplaceId":{"description":"This enum value indicates an eBay marketplace for which the application can access feed files for the corresponding feed type
Example: EBAY_US for the U.S. or EBAY_DE for Germany.","$ref":"#/components/schemas/MarketplaceIdEnum"}},"description":"This type is used to define the eBay marketplaces and eBay L1 categories that support the corresponding feed type"},"FeedTypeSearchResponse":{"type":"object","required":["feedTypes","href","limit","total"],"properties":{"feedTypes":{"type":"array","description":"An array of the feed types that match the search criteria.","items":{"$ref":"#/components/schemas/FeedType"}},"href":{"type":"string","description":"The URL to the current set of results."},"limit":{"type":"integer","description":"The number of records to show in the current response.","format":"int32"},"next":{"type":"string","description":"You can use this URL to retrieve the next page of results beyond those displayed on the page if there are more results that match the search criteria."},"total":{"type":"integer","description":"The total number of matches for the search criteria.","format":"int32"}},"description":"This type is used by the base response of the getFeedTypes method."},"FileMetadata":{"type":"object","required":["access","feedDate","feedScope","feedTypeId","fileId","format","marketplaceId","schemaVersion","size","span"],"properties":{"access":{"description":"Indicates whether the application is permitted to access the feed file. One of ALLOWED or RESTRICTED.","$ref":"#/components/schemas/AccessEnum"},"dimensions":{"type":"array","description":"An array of dimensions supported by the corresponding feed file.
Example:"dimensionKey": "CATEGORY",","items":{"$ref":"#/components/schemas/Dimension"}},"feedDate":{"type":"string","description":"The date on which the feed was created.
"values": ["15032"]
Format: UTC format (yyyy-MM-ddThh:00:00.000Z)."},"feedScope":{"description":"Specifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).
Currently only DAILY and HOURLY are supported.","$ref":"#/components/schemas/FeedScopeEnum"},"feedTypeId":{"type":"string","description":"The unique identifier of the feed type.
Note: Refer to Supported feed types for additional details."},"fileId":{"type":"string","description":"The file's unique identifier. This fileId is used to select the feed file when using the downloadFile method."},"format":{"description":"Format of the returned feed file.","$ref":"#/components/schemas/FormatEnum"},"marketplaceId":{"description":"The eBay marketplace identifier for the marketplace(s) to which the feed applies.
Example: EBAY_UK.","$ref":"#/components/schemas/MarketplaceIdEnum"},"schemaVersion":{"type":"string","description":"Version of the API schema under which the feed was created."},"size":{"type":"integer","description":"Size of the feed file in bytes.","format":"int32"},"span":{"description":"The time span between feed files that applies to the feed type (e.g., hourly, daily, weekly).
Possible Values: YEAR, MONTH, DAY, HOUR","$ref":"#/components/schemas/TimeDuration"}},"description":"This type is used to provide metadata about each feed file in a getFile or getFiles response."},"FileMetadataSearchResponse":{"type":"object","required":["fileMetadata","href","limit","total"],"properties":{"fileMetadata":{"type":"array","description":"An array of metadata values describing the available feed files that match the input criteria.","items":{"$ref":"#/components/schemas/FileMetadata"}},"href":{"type":"string","description":"The URL to the current set of results."},"limit":{"type":"integer","description":"The number of results that will be displayed on each page, as set by the limit URI parameter.
Default: 20","format":"int32"},"next":{"type":"string","description":"You can use this URL to retrieve the next page of results beyond those displayed on the page if there are more results that match the search criteria."},"total":{"type":"integer","description":"The total number of matches for the search criteria.","format":"int32"}},"description":"This type is used by the base response of the getFiles method."},"FormatEnum":{"type":"object","description":"
Note: This enum value will be returned for all feed types except CBT_ITEM_ALL_ACTIVE and PROMOTION_V2. - **AVRO**: The feed file is in Avro format.
Note: This enum value will only be returned for the CBT_ITEM_ALL_ACTIVE and PROMOTION_V2 feed types.","enum":["TSV","AVRO"]},"HazardPictogram":{"type":"object","properties":{"pictogramId":{"type":"string","description":"The unique identifier of the hazmat pictogram."},"pictogramDescription":{"type":"string","description":"The description of the hazmat pictogram, localized to the default language of the marketplace."},"pictogramUrl":{"type":"string","description":"The URL of the hazmat pictogram."}},"description":"This type defines the picogram for the type of hazard that a hazardous material represents."},"HazardStatement":{"type":"object","properties":{"statementId":{"type":"string","description":"The unique identifier of the hazmat statement."},"statementDescription":{"type":"string","description":"The description of the hazmat statement, localized to the default language of the marketplace."}},"description":"This type defines the hazard statement for a hazardous material."},"HazardousMaterialsLabels":{"type":"object","properties":{"statements":{"type":"array","description":"An array of hazmat statements for the item.","items":{"$ref":"#/components/schemas/HazardStatement"}},"pictograms":{"type":"array","description":"An array of hazmat pictograms for the item.","items":{"$ref":"#/components/schemas/HazardPictogram"}},"signalWordId":{"type":"string","description":"The unique identifier of the signal word for the hazardous materials label."},"signalWord":{"type":"string","description":"The signal word for the hazardous materials in the listing."},"additionalInformation":{"type":"string","description":"Additional information about hazardous materials labels."}},"description":"This type defines the fields used to describe the hazard materials label(s) for a hazardous material."},"ListingMarketplaceFeedTypeConstraint":{"type":"object","properties":{"listingCategoryIds":{"type":"array","description":"An array of the eBay categories the application can access in a feed. See the Taxonomy API for details about obtaining a list eBay L1 categories. The category is expressed as the category's categoryId, not its categoryName; e.g., 172008, not Gift Cards & Coupons.
If no categoryIds are listed, the application can access all categories in the specified marketplace.","items":{"type":"string"}},"listingMarketplaceId":{"description":"This enum value indicates an eBay marketplace for which the application can access feed files for the corresponding feed type.
Example: EBAY_US for the U.S. or EBAY_DE for Germany.","$ref":"#/components/schemas/MarketplaceIdEnum"}},"description":"This type is used to define the eBay marketplace and eBay L1 categories for which listings are available for Cross Border Trading."},"MarketplaceIdEnum":{"type":"object","description":"The list of supported marketplaces for which a feed file can be downloaded.
Note: Although this enumeration type is a complete list of all eBay marketplaces, the Buy Feed API is not supported by all eBay marketplaces. For a list of supported sites, see Buy API Support by Marketplace. | - **EBAY_US**: This enumeration value indicates that the eBay Marketplace is the US site (ebay.com). - **EBAY_CA**: This enumeration value indicates that the eBay Marketplace is the Canada (English) site (ebay.ca). - **EBAY_GB**: This enumeration value indicates that the eBay Marketplace is the UK site (ebay.co.uk). - **EBAY_AU**: This enumeration value indicates that the eBay Marketplace is the Australia site (ebay.com.au). - **EBAY_AT**: This enumeration value indicates that the eBay Marketplace is the Austria site (ebay.at). - **EBAY_BE**: This enumeration value indicates that the eBay marketplace is the Belgium (Dutch) site (www.ebay.be). - **EBAY_DE**: This enumeration value indicates that the eBay Marketplace is the Germany site (ebay.de). - **EBAY_IT**: This enumeration value indicates that the eBay Marketplace is the Italy site (ebay.it). - **EBAY_NL**: This enumeration value indicates that the eBay Marketplace is the Netherlands site (ebay.nl). - **EBAY_ES**: This enumeration value indicates that the eBay Marketplace is the Spain site (ebay.es). - **EBAY_CH**: This enumeration value indicates that the eBay Marketplace is the Switzerland site (ebay.ch). - **EBAY_TW**: This enumeration value indicates that the eBay Marketplace is the Taiwan site (ebay.com/tw). - **EBAY_CZ**: This enumeration value indicates that the eBay Marketplace is the Czech Republic site (ebay.com/sch/Czech-Republic). - **EBAY_DK**: This enumeration value indicates that the eBay Marketplace is the Denmark site (ebay.com/sch/Denmark). - **EBAY_FI**: This enumeration value indicates that the eBay Marketplace is the Finland site (ebay.com/sch/Finland). - **EBAY_FR**: This enumeration value indicates that the eBay Marketplace is the France site (ebay.fr). - **EBAY_GR**: This enumeration value indicates that the eBay Marketplace is the Greece site (ebay.com/sch/Greece). - **EBAY_HK**: This enumeration value indicates that the eBay Marketplace is the Hong Kong site (ebay.com.hk). - **EBAY_HU**: This enumeration value indicates that the eBay Marketplace is the Hungary site (ebay.com/sch/Hungary). - **EBAY_IN**: This enumeration value indicates that the eBay Marketplace is the India site (ebay.in). Note: eBay India is no longer a functioning eBay marketplace. - **EBAY_ID**: This enumeration value indicates that the eBay Marketplace is the Indonesia site (id.ebay.com). - **EBAY_IE**: This enumeration value indicates that the eBay Marketplace is the Ireland site (ebay.ie). - **EBAY_IL**: This enumeration value indicates that the eBay Marketplace is the Israel site (ebay.com/sch/Israel). - **EBAY_MY**: This enumeration value indicates that the eBay Marketplace is the Malaysia site (ebay.com/my). - **EBAY_NZ**: This enumeration value indicates that the eBay Marketplace is the New Zealand site (ebay.com/sch/New-Zealand). - **EBAY_NO**: This enumeration value indicates that the eBay Marketplace is the Norway site (ebay.com/sch/Norway). - **EBAY_PH**: This enumeration value indicates that the eBay Marketplace is the Philippines site (ebay.ph). - **EBAY_PL**: This enumeration value indicates that the eBay Marketplace is the Poland site (ebay.pl). - **EBAY_PT**: This enumeration value indicates that the eBay Marketplace is the Portugal site (ebay.com/sch/Portugal). - **EBAY_PR**: This enumeration value indicates that the eBay Marketplace is the Puerto Rico site (ebay.com/sch/Puerto-Rico). - **EBAY_RU**: This enumeration value indicates that the eBay Marketplace is the Russia site (ebay.com/sch/Russia). - **EBAY_SG**: This enumeration value indicates that the eBay Marketplace is the Singapore site (ebay.com/sg). - **EBAY_ZA**: This enumeration value indicates that the eBay Marketplace is the South Africa site (ebay.com/sch/South-Africa). - **EBAY_SE**: This enumeration value indicates that the eBay Marketplace is the Sweden site (ebay.com/sch/Sweden). - **EBAY_TH**: This enumeration value indicates that the eBay Marketplace is the Thailand site (export.ebay.co.th). - **EBAY_VN**: This enumeration value indicates that the eBay Marketplace is the Vietnam site (ebay.vn). - **EBAY_CN**: This enumeration value indicates that the eBay Marketplace is the China site (ebay.com/sch/China). - **EBAY_JP**: This enumeration value indicates that the eBay Marketplace is the Japan site (ebay.co.jp). - **EBAY_PE**: This enumeration value indicates that the eBay Marketplace is the Peru site (ebay.com/sch/Peru). - **EBAY_HALF_US**: This enumeration value is no longer applicable as the Half.com site no longer exists. - **EBAY_MOTORS_US**: This enumeration value indicates that the eBay Marketplace is the US eBay Motors site (ebay.com/motors).","enum":["EBAY_US","EBAY_CA","EBAY_GB","EBAY_AU","EBAY_AT","EBAY_BE","EBAY_DE","EBAY_IT","EBAY_NL","EBAY_ES","EBAY_CH","EBAY_TW","EBAY_CZ","EBAY_DK","EBAY_FI","EBAY_FR","EBAY_GR","EBAY_HK","EBAY_HU","EBAY_IN","EBAY_ID","EBAY_IE","EBAY_IL","EBAY_MY","EBAY_NZ","EBAY_NO","EBAY_PH","EBAY_PL","EBAY_PT","EBAY_PR","EBAY_RU","EBAY_SG","EBAY_ZA","EBAY_SE","EBAY_TH","EBAY_VN","EBAY_CN","EBAY_JP","EBAY_PE","EBAY_HALF_US","EBAY_MOTORS_US"]},"Offer":{"type":"object","properties":{"offerId":{"type":"string","description":"The unique identifier of the offer within the promotion."},"ruleTemplateName":{"description":"This enumeration value indicates the conditions of the discount, such as 'Buy N items, and get Y off total'. See the RuleTemplateNameEnum type description for more information on what each value indicates.
This value affects discountBenefit and discountSpecification.","$ref":"#/components/schemas/RuleTemplateNameEnum"},"discountBenefit":{"description":"This enumeration value indicates the discount benefit as either a monetary amount or percentage of the item/order price. See the DiscountBenefitEnum type description for more information on what each value indicates.","$ref":"#/components/schemas/DiscountBenefitEnum"},"discountSpecification":{"description":"This enumeration value indicates the criteria for when the discount triggers. The discount is applied each time the specified criteria is met. See the DiscountSpecificationEnum type description for more information on what each value indicates.","$ref":"#/components/schemas/DiscountSpecificationEnum"},"criteria":{"description":"The criteria used to define which items are eligible for this offer.","$ref":"#/components/schemas/Criteria"},"percentageOffItemValue":{"type":"object","description":"The percentage that is discounted off the sales price of the item (or items) when the discount criteria is met.
This field will only applicable if the discountBenefit value is PERCENTAGE_OFF_ITEM; it is returned as null otherwise."},"percentageOffOrderValue":{"type":"object","description":"Used for threshold discounts, this is the percentage of the order price that is discounted off the order when the discount criteria is met.
This field will only applicable if the discountBenefit value is PERCENTAGE_OFF_ORDER; it is returned as null otherwise."},"amountOffItemValue":{"type":"object","description":"The monetary amount that is discounted off an item (or items) when the discount criteria is met.
This field will only applicable if the discountBenefit value is AMOUNT_OFF_ITEM; it is returned as null otherwise."},"amountOffItemCurrency":{"description":"The currency of the dollar value expressed in the amountOffItemValue field.
The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.
This field will only applicable if the discountBenefit value is AMOUNT_OFF_ITEM; it is returned as null otherwise.","$ref":"#/components/schemas/CurrencyCodeEnum"},"amountOffOrderValue":{"type":"object","description":"Used for threshold discounts, this is the monetary amount that is discounted off an order when the discount criteria is met.
This field will only applicable if the discountBenefit value is AMOUNT_OFF_ORDER; it is returned as null otherwise."},"amountOffOrderCurrency":{"description":"The currency of the dollar value expressed in the amountoffOrderValue field.
The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.
This field will only applicable if the discountBenefit value is AMOUNT_OFF_ORDER; it is returned as null otherwise.","$ref":"#/components/schemas/CurrencyCodeEnum"},"minAmountValue":{"type":"object","description":"Known as the threshold amount, this is the minimum dollar amount that needs to be spent on discounted items in order to qualify for the discount."},"minAmountCurrency":{"description":"The base currency applied to the value field of minAmountValue to establish a monetary amount.
The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.","$ref":"#/components/schemas/CurrencyCodeEnum"},"forEachAmountValue":{"type":"object","description":"The monetary amount that must be spent on discounted items before the discount is applied, which applies for each multiple of this value on a repeating basis."},"forEachAmountCurrency":{"description":"The base currency applied to the value field of forEachAmountValue to establish a monetary amount.
The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.","$ref":"#/components/schemas/CurrencyCodeEnum"},"minQuantity":{"type":"object","description":"The minimum quantity of discounted items that need to be bought in order to qualify for the discount."},"forEachQuantity":{"type":"object","description":"The number of items that must be purchased in order to qualify for the discount, which applies for each multiple of this quantity on a repeating basis."},"numberOfDiscountedItems":{"type":"object","description":"The number of items to be discounted when other criteria are met, such as forEachQuantity or minQuantity.
For example, when a buyer adds the number of items identified by these fields value to their cart, they can be eligible to receive the stated discount for an additional number of like items (specified by this field). To receive the discount, the buyer must purchase the number of items indicated by forEachQuantity or minQuantity, plus the number indicated by this field (for which they will get the discount)."},"maxDiscountAmountValue":{"type":"object","description":"The maximum monetary amount a buyer can save per discount."},"maxDiscountAmountCurrency":{"description":"The base currency applied to the value field of maxDiscountAmountValue to establish a monetary amount.
The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.","$ref":"#/components/schemas/CurrencyCodeEnum"}},"description":"This type defines the details of an offer object, including its discount rules and criteria."},"OutputStream":{"type":"object","description":"This type defines the object for the feed file being downloaded."},"PromotionSourceTypeEnum":{"type":"object","description":"An enumerated type that defines the source of a discount. | - **ebay**: Indicates that the discount was created and managed by eBay. - **seller**: Indicates that the discount was created and managed by an eBay seller.","enum":["ebay","seller"]},"PromotionTypeEnum":{"type":"object","description":"Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made
An enumerated type that defines the types of supported discounts. | - **CODED_COUPON**: A discount where the seller offers a coupon to buyers. - **ORDER_DISCOUNT**: Note: This value is not currently supported.
A discount where the seller offers an order discount based on order size or the amount spent by a buyer. - **VOLUME_DISCOUNT**: Note: This value is not currently supported.
A discount where the seller offers a tiered discount to buyers who purchase multiple quantities of a single item.","enum":["CODED_COUPON","ORDER_DISCOUNT","VOLUME_DISCOUNT"]},"RuleTemplateNameEnum":{"type":"object","description":"An enumerated type that defines the condition of a discount. | - **BUY_1_ITEMS_GET_Y_AMT_OFF_SUBTOTAL**: Indicates that the buyer will receive a dollar value discount on their order when they buy an item.
The dollar value discount is shown in the corresponding amountOffOrderValue field. - **BUY_1_ITEMS_GET_Y_PCT_OFF_SUBTOTAL**: Indicates that the buyer will receive a percentage value discount on their order when they buy an item.
The percentage value discount is shown in the corresponding percentageOffOrderValue field. - **BUY_N_ITEMS_GET_Y_AMT_OFF_SUBTOTAL**: Indicates that for every N items purchased, the buyer will receive a dollar value discount on their the order.
The number of items that must be purchased is shown in the corresponding minQuantity field, and the dollar value discount is shown in the corresponding amountOffOrderValue field. - **BUY_N_ITEMS_GET_Y_PCT_OFF_SUBTOTAL**: Indicates that for every N items purchased, the buyer will receive a percentage value discount on their order.
The number of items that must be purchased is shown in the corresponding minQuantity field, and the percentage value discount is shown in the corresponding percentageOffOrderValue field. - **FOR_EVERY_BUY_1_ITEMS_GET_Y_AMT_OFF_SUBTOTAL**: Indicates that for each item purchased, the buyer will receive a dollar value discount on their order.
The dollar value discount for each item purchased is shown in the corresponding amountOffItemValue field. - **FOR_EVERY_N_ITEMS_GET_Y_AMT_OFF_SUBTOTAL**: Indicates that for every N items purchased, the buyer will receive a dollar value discount on their order.
The number of items that must be purchased is shown in the corresponding forEachQuantity field, and the dollar value discount is shown in the corresponding amountOffItemValue field. - **FOR_EVERY_N_ITEMS_GET_M_ITEMS_AT_Y_PCT_OFF**: Indicates that for every N items purchased, the buyer will receive a percentage value discount on M items.
The number of items that must be purchased is shown in the corresponding forEachQuantity field, the number of items being discounted is shown in the corresponding numberOfDiscountedItems field, and the percentage value discount for these items is shown in the percentageOffItemValue field. - **FOR_EVERY_N_ITEMS_GET_M_ITEMS_FREE**: Indicates that for every N items purchased, the buyer will receive M items free.
The number of items that must be purchased is shown in the corresponding forEachQuantity field, and the number of items being received for free is shown in the corresponding numberOfDiscountedItems field. - **SPEND_X_AMT_GET_Y_AMT_OFF_SUBTOTAL**: Indicates that if a buyer spends X amount, they will receive a dollar value discount on their order.
The required amount to spend is shown in the corresponding minAmountValue field, and the dollar value discount is shown in the corresponding amountOffOrderValue field. - **SPEND_X_AMT_GET_Y_PCT_OFF_SUBTOTAL**: Indicates that if a buyer spends X amount, they will receive a percentage value discount on their order.
The required amount to spend is shown in the corresponding minAmountValue field, and the percentage value discount is shown in the corresponding percentageOffOrderValue field. - **FOR_EVERY_X_AMT_SPENT_GET_Y_AMT_OFF_SUBTOTAL**: Indicates that the buyer will receive a dollar value discount on their order for every X dollar amount they spend.
The dollar value that must be spent is shown in the corresponding forEachAmountValue field, and the dollar value discount is shown in the corresponding amountOffItemValue field. - **FOR_EVERY_X_AMT_SPENT_GET_Y_PCT_OFF_SUBTOTAL**: Indicates that the buyer will receive a percentage value discount on their order for every X dollar amount they spend.
The dollar value that must be spent is shown in the corresponding forEachAmountValue field, and the percentage value discount is shown in the corresponding percentageOffItemValue field. ","enum":["BUY_1_ITEMS_GET_Y_AMT_OFF_SUBTOTAL","BUY_1_ITEMS_GET_Y_PCT_OFF_SUBTOTAL","BUY_N_ITEMS_GET_Y_AMT_OFF_SUBTOTAL","BUY_N_ITEMS_GET_Y_PCT_OFF_SUBTOTAL","FOR_EVERY_BUY_1_ITEMS_GET_Y_AMT_OFF_SUBTOTAL","FOR_EVERY_N_ITEMS_GET_Y_AMT_OFF_SUBTOTAL","FOR_EVERY_N_ITEMS_GET_M_ITEMS_AT_Y_PCT_OFF","FOR_EVERY_N_ITEMS_GET_M_ITEMS_FREE","SPEND_X_AMT_GET_Y_AMT_OFF_SUBTOTAL","SPEND_X_AMT_GET_Y_PCT_OFF_SUBTOTAL","FOR_EVERY_X_AMT_SPENT_GET_Y_AMT_OFF_SUBTOTAL","FOR_EVERY_X_AMT_SPENT_GET_Y_PCT_OFF_SUBTOTAL"]},"SellerTrustLevelEnum":{"type":"object","description":"An enumerated type for the values that represent the eBay seller's trust level.
Valid Values: TOP_RATED, ABOVE_STANDARD, or an empty value.
An empty value indicates a return of anything other than TOP_RATED or ABOVE_STANDARD.
Code so that your app gracefully handles any future changes to this list. | - **TOP_RATED**: Indicates the seller is an eBay top rated seller (the highest standing). - **ABOVE_STANDARD**: Indicates the seller is above the eBay standard.","enum":["TOP_RATED","ABOVE_STANDARD"]},"SupportedFeed":{"type":"object","required":["authorizationScopes","feedScope","lookBack","status","supportedSchemas"],"properties":{"authorizationScopes":{"type":"array","description":"The oauth authorization scopes which grant access to the feed files.
Currently the only applicable authorization scope is https://api.ebay.com/oauth/api_scope/buy.item.feed.
Note: You can view your application's oauth scopes on the Application Keys page.","items":{"type":"string"}},"constraint":{"description":"This container shows the eBay marketplaces that support the corresponding feed type. If no constraints are returned, all marketplaces are supported.","$ref":"#/components/schemas/Constraint"},"feedScope":{"description":"Specifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).
Currently only DAILY and HOURLY are supported.","$ref":"#/components/schemas/FeedScopeEnum"},"lookBack":{"description":"How far back from the current time to limit the returned feed files. The returned feed files will be those generated between the current time and the look-back time.
Example: A value of 120 will limit the returned feed files to those generated in the past 2 hours (120 minutes). If 3 feed files have been generated in the past 2 hours, those 3 files will be returned. A feed file generated 4 hours earlier will not be returned.","$ref":"#/components/schemas/TimeDuration"},"status":{"description":"The status for this feed. One of ACTIVE, PAUSED, or DEPRECATED.","$ref":"#/components/schemas/FeedStatusEnum"},"supportedSchemas":{"type":"array","description":"An array of the supported Feed API schemas for this feed type.","items":{"$ref":"#/components/schemas/SupportedSchema"}}},"description":"This type defines the object that is returned by a successful getFeedType or getFeedTypes search describing the characteristics of a feed type."},"SupportedSchema":{"type":"object","required":["definition","deprecated","formats","schemaVersion"],"properties":{"definition":{"type":"string","description":"A list of the fields that will be returned in the feed file.
Note: Refer to Supported feed types to learn about the feed fields that are included in each supported feed type."},"deprecated":{"type":"boolean","description":"Indicates whether the schema is still functional or deprecated. One of either true or false."},"formats":{"type":"array","description":"An list of the available formats in which the schema can be downloaded.","items":{"$ref":"#/components/schemas/FormatEnum"}},"schemaVersion":{"type":"string","description":"The version of the Feed API schema under which the feed type was created.
Example: 1.0."}},"description":"The type defines the Feed API schema version(s) supported by the feed type."},"TimeDuration":{"type":"object","required":["unit","value"],"properties":{"unit":{"description":"This enumeration value indicates the time unit used for the time period.","$ref":"#/components/schemas/TimeDurationUnitEnum"},"value":{"type":"integer","description":"The number of units of time in the span.","format":"int32"}},"description":"This type defines the time span between feed files that applies to the feed type (e.g., hourly, daily, weekly)."},"TimeDurationUnitEnum":{"type":"object","description":"This enumerated type defines the list of possible values for the unit attribute of the TimeDuration object of a feed_type object. Currently only HOUR is supported. | - **YEAR**: Time duration is based on the number of years. - **MONTH**: Time duration is based on the number of months - **DAY**: Time duration is based on the number of days. - **HOUR**: Time duration is based on the number of hours. - **CALENDAR_DAY**: Time duration is based on the calendar, meaning Sunday through Saturday and does not exclude holidays. - **BUSINESS_DAY**: Time duration is based on the number of business days, meaning 'working days'. So it excludes all holidays for the location and in some locations can include Saturday. - **MINUTE**: Time duration is based on the number of minutes. - **SECOND**: Time duration is based on the number of seconds. - **MILLISECOND**: Time duration is based on the number of milliseconds. ","enum":["YEAR","MONTH","DAY","HOUR","CALENDAR_DAY","BUSINESS_DAY","MINUTE","SECOND","MILLISECOND"]},"TypedNameValue":{"type":"object","description":"This type defines the type and name/value pair for an aspect.","properties":{"type":{"description":"Indicates if the value being returned is a string or an array of strings.","$ref":"#/components/schemas/ValueTypeEnum"},"name":{"type":"string","description":"The text representing the name of the aspect for the name/value pair."},"value":{"type":"string","description":"The text representing the value of the aspect for the name/value pair."}}},"ValueTypeEnum":{"type":"object","description":"This enumerated type specifies the type for a value. | - **STRING**: Indicates that the value returned is a string. - **STRING_ARRAY**: Indicates that the value returned is an array of strings. ","enum":["STRING","STRING_ARRAY"]}},"securitySchemes":{"api_auth":{"type":"oauth2","description":"The security definitions for this API. Please check individual operations for applicable scopes.","flows":{"clientCredentials":{"tokenUrl":"https://api.ebay.com/identity/v1/oauth2/token","scopes":{"https://api.ebay.com/oauth/api_scope/buy.item.feed":"View curated feeds of eBay items"}}}},"bearerAuth":{"type":"http","scheme":"bearer"}}}}