---
openapi: "3.0.0"
info:
  title: "Browse API"
  description: "The Browse API has the following resources:<ul><li><b>item_summary:</b><br>Allows\
    \ shoppers to search for specific items by keyword, GTIN, category, charity, product,\
    \ image, or item aspects and refine the results by using filters, such as aspects,\
    \ compatibility, and fields values, or UI parameters.</li><li><b>item:</b><br>Allows\
    \ shoppers to retrieve the details of a specific item or all items in an item\
    \ group, which is an item with variations such as color and size and check if\
    \ a product is compatible with the specified item, such as if a specific car is\
    \ compatible with a specific part.<br><br>This resource also provides a bridge\
    \ between the eBay legacy APIs, such as the <a href=\"/api-docs/user-guides/static/finding-user-guide-landing.html\"\
    \ target=\"_blank\">Finding</b>, and the RESTful APIs, which use different formats\
    \ for the item IDs.</li></ul>The <b>item_summary</b>, <b>search_by_image</b>,\
    \ and <b>item</b> resource calls require an <a href=\"/api-docs/static/oauth-client-credentials-grant.html\"\
    \ target=\"_blank\">Application access token</a>."
  contact:
    name: "eBay Inc,"
  license:
    name: "eBay API License Agreement"
    url: "https://developer.ebay.com/join/api-license-agreement"
  version: "v1.20.4"
servers:
- url: "https://api.ebay.com{basePath}"
  description: "Production"
  variables:
    basePath:
      default: "/buy/browse/v1"
paths:
  /item_summary/search:
    get:
      tags:
      - "item_summary"
      description: "This method searches for eBay items by various query parameters\
        \ and retrieves summaries of the items. You can search by keyword, category,\
        \ eBay product ID (ePID), or GTIN, charity ID, or a combination of these.<br><br><span\
        \ class=\"tablenote\"><b>Note:</b> Only listings where <code>FIXED_PRICE</code>\
        \ (Buy It Now) is a buying option are returned by default. To retrieve listings\
        \ that do not have <code>FIXED_PRICE</code> as a buying option, the <code>buyingOptions</code>\
        \ filter can be used to retrieve those listings.<br><br>Note that an auction\
        \ listing enabled with the <i>Buy it Now</i> feature will initially show <code>AUCTION</code>\
        \ and <code>FIXED_PRICE</code> as buying options, but if/when that auction\
        \ listing receives a qualifying bid, only <code>AUCTION</code> remains as\
        \ a buying option. If this happens, the <code>buyingOptions</code> filter\
        \ would need to be used to retrieve that auction listing.</span><br>This method\
        \ also supports the following:<ul><li>Filtering by the value of one or multiple\
        \ fields, such as listing format, item condition, price range, location, and\
        \ more. For the fields supported by this method, refer to the <a href=\"#uri.filter\"\
        >filter</a> parameter.</li><li>Retrieving the refinements (metadata) of an\
        \ item, such as item aspects (color, brand) condition, category, etc. using\
        \ the <a href=\"#uri.fieldgroups\">fieldgroups</a> parameter.</li><li>Filtering\
        \ by item aspects and other refinements using the <a href=\"#uri.aspect_filter\"\
        >aspect_filter</a> parameter.</li><li>Filtering for items that are compatible\
        \ with a specific product, using the <a href=\"#uri.compatibility_filter\"\
        >compatibility_filter</a> parameter.</li><li>Creating aspects histograms,\
        \ which enables shoppers to drill down in each refinement narrowing the search\
        \ results.</li></ul>For additional information and examples of these capabilities,\
        \ refer to <a href=\"/api-docs/buy/static/api-browse.html\" target=\"_blank\"\
        >Browse API</a> in the Buying Integration Guide.</br><h3>Pagination and sort\
        \ controls</h3>There are pagination controls (<b>limit</b> and <b>offset</b>\
        \ fields) and <b>sort</b> query parameters that control/sort the data that\
        \ are returned. By default, results are sorted by <i>Best Match</i>. For more\
        \ information about Best Match, refer to <a href=\"https://pages.ebay.com/help/sell/searchstanding.html\
        \ \" target=\"_blank\">Best Match</a>.</br><h3>Restrictions</h3>This method\
        \ can return a maximum of 10,000 items. For a list of supported sites and\
        \ other restrictions, refer to <a href=\"/api-docs/buy/browse/overview.html#API\"\
        >API Restrictions</a>.<br><br><span class=\"tablenote\"><b>eBay Partner Network:</b>\
        \ In order to receive a commission for your sales, you must use the URL returned\
        \ in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the\
        \ ebay.com site.</span>"
      operationId: "search"
      parameters:
      - name: "aspect_filter"
        in: "query"
        description: "This field lets you filter by item aspects. The aspect name/value\
          \ pairs and category, which is required, is used to limit the results to\
          \ specific aspects of the item. For example, in a clothing category one\
          \ aspect pair would be Color/Red.<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ The category ID must be specified <i>twice</i>:<ul><li>Once as a URI parameter\
          \ in the <code>category_ids</code> field</li><li>Once as part of the <code>aspect_filter</code>\
          \ field</li></ul>These two values <b>must</b> be the same.</span><br>For\
          \ example, to return items for a woman's red shirt, issue the following\
          \ request:<br><pre>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</pre>To\
          \ get a list of the aspect pairs and the category, which is returned in\
          \ the <code>dominantCategoryId</code> field, set <code>fieldgroups</code>\
          \ to <code>ASPECT_REFINEMENTS</code> as illustrated here:<pre>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</pre><span\
          \ class=\"tablenote\"><b> Note:</b> The pipe symbol is used as a delimiter\
          \ between aspect filter values. If a value contains a pipe symbol (for example,\
          \ the brand name 'Bed|Stü'), you must enter a backslash before the pipe\
          \ character to prevent it from being evaluated as a delimiter.<br><br>The\
          \ following example illustrates the correct format for entering two brand\
          \ names as aspect filter values, one of which contains a pipe symbol:<pre>/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed&bsol;|Stü\
          |Nike}</pre></span> For implementation help, refer to eBay API documentation\
          \ at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter"
        required: false
        schema:
          type: "string"
      - name: "auto_correct"
        in: "query"
        description: "A query parameter that enables auto correction.<br><br>A sample\
          \ is shown below:<pre>/buy/browse/v1/item_summary/search?auto_correct=KEYWORD</pre><span\
          \ class=\"tablenote\"><b>Note:</b> Auto correction is currently supported\
          \ in the following marketplaces:<ul><li>United States</li><li>Austria</li><li>Australia</li><li>Canada</li><li>Switzerland</li><li>Germany</li><li>Spain</li><li>France</li><li>United\
          \ Kingdom</li><li>Ireland</li><li>Italy</li></ul></span><br><b>Valid Values:</b>\
          \ <code>KEYWORD</code>"
        required: false
        schema:
          type: "string"
      - name: "category_ids"
        in: "query"
        description: "<a name=\"category_ids\"></a>The category ID is used to limit\
          \ the results that are returned. This field may pass in one category ID\
          \ or a comma separated list of IDs as illustrated in the following examples:<pre>/buy/browse/v1/item_summary/search?category_ids=29792</pre><pre>/buy/browse/v1/item_summary/search?category_ids=267,29792</pre><span\
          \ class=\"tablenote\"><b>Note:</b> Currently, you can pass in only one category\
          \ ID per request.</span><br>To refine the set of information that is returned,\
          \ <code>category_ids</code> may be combined with <b>EITHER</b>:<ul><li><code>epid</code>\
          \ and/or <code>gtin</code> values</li><li><code>q</code> keywords</li></ul>For\
          \ example, when looking of a toy phone, simply searching for \"phone\" will\
          \ return mobile phones because that is the \"Best Match\" for the search.\
          \ To further refine the request to include toy phones, include the <b>Toys\
          \ &amp; Hobbies</b> category ID as illustrated here:<pre>/buy/browse/v1/item_summary/search?q=phone&category_ids=220</pre>Because\
          \ the list of eBay category IDs is not published and category IDs are not\
          \ the same across all eBay marketplaces, category IDs may be determined\
          \ by:<ul><li>Visiting the <a href=\"https://pages.ebay.com/sellerinformation/news/categorychanges.html\
          \ \" target=\"_blank\">Category Changes page</a></li><li>Using the Taxonomy\
          \ API. Refer to <a href=\"/api-docs/buy/buy-categories.html\" target=\"\
          _blank\">Get Categories for Buy APIs</a> for complete information.</li><li>Issuing\
          \ the following call to retrieve the <code>dominantCategoryId</code> for\
          \ an item:<pre>/buy/browse/v1/item_summary/search?q=<i> keyword</i>&fieldgroups=ASPECT_REFINEMENTS</pre></li></ul><span\
          \ class=\"tablenote\"><b>Note:</b> If a top-level (L1) category is specified,\
          \ you <b>must</b> also include a <code>q</code> query parameter.</span>"
        required: false
        schema:
          type: "string"
      - name: "charity_ids"
        in: "query"
        description: "The charity ID filters results to return only those items associated\
          \ with the specified charity.<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ <code>charity_ids</code> is only supported by the US and UK marketplaces.</span><br>Charity\
          \ ID is a charity's unique identification number:<ul><li>In the US, this\
          \ is the <b>Employer Identification Number (EIN)</b>.</li><li>In the UK,\
          \ this is the Charity Registration Number (CRN), commonly called <b>Charity\
          \ Number</b>.</li></ul><br><code>charity_ids</code> may be retrieved/determined\
          \ as follows:<ul><li>Search for a supported charity using the Charity API's\
          \ <a href=\"/api-docs/commerce/charity/resources/charity_org/methods/getCharityOrgs\
          \ \" target=\"_blank\">getCharityOrgs</a> method.<br><br><div class=\"msgbox_important\"\
          ><p class=\"msgbox_importantInDiv\" data-mc-autonum=\"&lt;b&gt;&lt;span\
          \ style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
          \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
          color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
          \ The value to be passed in as <code>charity_ids</code> is that returned\
          \ in the <code>registrationId</code> field.</p></div></li><li>Search for\
          \ a supported charity by visiting <a href=\"https://charity.ebay.com/search\
          \ \" target=\"_blank\">Charity Search</a>. Click on the charity's name to\
          \ display its information. The EIN number is included in the charity's information\
          \ block at the top of the page.<br><br>For example, the charity ID for <a\
          \ href=\"https://charity.ebay.com/charity/American-Red-Cross/3843 \" target=\"\
          _blank\">American Red Cross</a>, is <code>530196605</code>.</li></ul>Up\
          \ to 20 comma-separated <code>charity_ids</code> may be specified in each\
          \ query. Additionally, <code>charity_ids</code> may be combined with <code>category_ids</code>\
          \ and/or <code>q</code> keyword values to further filter returned results.<br><br>A\
          \ sample query using <code>charity_ids</code> is:<br><pre>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</pre>"
        required: false
        schema:
          type: "string"
      - name: "compatibility_filter"
        in: "query"
        description: "This field specifies the attributes used to define a specific\
          \ product. The service searches for items matching the keyword, or matching\
          \ the keyword and a product attribute value in the title of the item.<br><br><span\
          \ class=\"tablenote\"><b>Note:</b> The only products supported are cars,\
          \ trucks, and motorcycles.</span><br>For example, if the keyword is <code>brakes</code>\
          \ and <code>compatibility-filter=Year:2018;Make:BMW</code>, the items returned\
          \ are items with <b>brakes</b>, <b>2018</b>, or <b>BMW</b> in the title.<br><br>The\
          \ service uses the product attributes to determine whether the item is compatible.\
          \ The service returns the attributes that are compatible and the <a href=\"\
          /api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.compatibilityMatch\"\
          >CompatibilityMatchEnum</a> value that indicates how well the item matches\
          \ the attributes.<br><br><div class=\"msgbox_tip\"><p class=\"msgbox_tipInDiv\"\
          \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #478415;&quot;\
          \ class=&quot;mcFormatColor&quot;&gt;Tip: &lt;/span&gt;&lt;/b&gt;\"><span\
          \ class=\"autonumber\"><span><b><span style=\"color: #478415;\" class=\"\
          mcFormatColor\">Tip:</span></b></span></span> Refer to the <a href=\"/api-docs/buy/browse/resources/item_summary/methods/search#s0-1-21-6-7-7-6-ReturnItemsthatareCompatiblewiththeKeywordandVehicle-9\"\
          \ target=\"_blank\">Samples</a> section for a detailed example.</p></div><br><b>Best\
          \ Practice:</b> Submit all of the <a href=\"/api-docs/buy/static/api-browse.html#product-attributes\"\
          \ target=\"_blank\">product attributes</a> for the specific product.<br><br>To\
          \ find the attributes and values for a specific marketplace, use the <a\
          \ href=\"/api-docs/commerce/taxonomy/resources/category_tree/methods/getCompatibilityProperties\"\
          \ target=\"_blank\">getCompatibilityProperties</a> method in the <a href=\"\
          /api-docs/commerce/taxonomy/resources/methods\" target=\"_blank\">Taxonomy\
          \ API</a>.<br><br>For more information, refer to <a href=\"/api-docs/buy/static/api-browse.html#Check\"\
          \ target=\"_blank\">Check compatibility</a> in the Buying Integration Guide.<br><br><span\
          \ class=\"tablenote\"><b>Note:</b> Testing in Sandbox is only supported\
          \ using mock data. Refer to <a href=\"/api-docs/buy/static/api-browse.html#sbox-test\"\
          \ target=\"_blank\">Testing search in the Sandbox</a> for details.</span><br><b>Required:</b><ul><li><code>q</code>\
          \ (keyword)</li><li>One parts-compatibility-supported category ID (such\
          \ as <code>33559</code> Brakes)</li><li>At least one <a href=\"/api-docs/buy/static/api-browse.html#product-attributes\"\
          \ target=\"_blank\">vehicle attribute</a> name/value pair</li></ul> For\
          \ implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityFilter"
        required: false
        schema:
          type: "string"
      - name: "epid"
        in: "query"
        description: "The ePID is the eBay product identifier of a product from the\
          \ eBay product catalog. This field limits the results to only items in the\
          \ specified ePID.<br><br>Use the <a href=\"/api-docs/commerce/catalog/resources/product_summary/methods/search\"\
          \ target=\"_blank\">product_summary/search</a> method in the <a href=\"\
          /api-docs/commerce/catalog/overview.html\" target=\"_blank\">Catalog</a>\
          \ API to search for the ePID of the product.<br><br>For example:<pre>/buy/browse/v1/item_summary/search?epid=15032</pre><span\
          \ class=\"tablenote\"><b>Note:</b> When constructing a query, <code>epid</code>\
          \ may be combined with a <code>gtin</code> value. However, <i>do not</i>\
          \ specify keywords using the <code>q</code> parameter — keywords cannot\
          \ be used in conjunction with an <code>epid</code>.</span>"
        required: false
        schema:
          type: "string"
      - name: "fieldgroups"
        in: "query"
        description: "A comma-separated list of values that controls what is returned\
          \ in the response. The default is <code>MATCHING_ITEMS</code>, which returns\
          \ the items that match the keyword or category specified. The other values\
          \ return data that can be used to create histograms or provide additional\
          \ information.<br><br><b>Valid Values:</b><ul><li><code>ASPECT_REFINEMENTS</code><br>This\
          \ field group adds the <a href=\"#response.refinement.aspectDistributions\"\
          >aspectDistributions</a> container to the response.<br><br><span class=\"\
          tablenote\"><b>Note:</b> Information returned by <code>ASPECT_REFINEMENTS</code>\
          \ is category specific.</span></li><li><code>BUYING_OPTION_REFINEMENTS</code><br>This\
          \ field group adds the <a href=\"#response.refinement.buyingOptionDistributions\"\
          >buyingOptionDistributions</a> container to the response.</li><li><code>CATEGORY_REFINEMENTS</code><br>This\
          \ field group adds the <a href=\"#response.refinement.categoryDistributions\"\
          >categoryDistributions</a> container to the response.</li><li><code>CONDITION_REFINEMENTS</code><br>This\
          \ field group adds the <a href=\"#response.refinement.conditionDistributions\"\
          >conditionDistributions</a> containers, such as <code>NEW</code>, <code>USED</code>,\
          \ etc., to the response. Within these groups are multiple states of the\
          \ condition.<br><br>For example, <code>NEW</code> can be <i>New without\
          \ tag</i>, <i>New in box</i>, <i>New without box</i>, etc.</li><li><code>EXTENDED</code><br>This\
          \ field group adds the following fields to the response:<ul><li><a href=\"\
          /api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.shortDescription\"\
          >shortDescription</a></li><li><a href=\"/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.itemLocation.city\"\
          >itemLocation.city</a></li></ul></li><li><code>MATCHING_ITEMS</code> (<b>default\
          \ value</b>)<br>This field group is intended to be used with one or more\
          \ of the refinement values listed above. This is used to return the specified\
          \ refinements and all matching items.</li><li><code>FULL</code><br>This\
          \ field group returns all refinement containers and all matching items.</li></ul><b>Default:</b>\
          \ <code>MATCHING_ITEMS</code>"
        required: false
        schema:
          type: "string"
      - name: "filter"
        in: "query"
        description: "An array of field filters that can be used to limit/customize\
          \ the result set.<br><br>Refer to <a href=\"/api-docs/buy/static/ref-buy-browse-filters.html\"\
          \ target=\"_blank\">Buy API Field Filters</a> for additional information\
          \ and examples of all supported filters.<br><br>For example, to filter shirts\
          \ based on a specific range of prices, include the filter illustrated here:\
          \ <pre>/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50]</pre>Filters\
          \ may also be combined within a single request as illustrated in the sample\
          \ below which further refines results to return only those shirts available\
          \ from specific sellers: <pre>/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50],sellers:{rpseller|bigSal}</pre>\
          \ For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField"
        required: false
        schema:
          type: "string"
      - name: "gtin"
        in: "query"
        description: "This field lets you search for a product by specifying a Global\
          \ Trade Item Number (GTIN) of the product. Supported GTIN types are UPC,\
          \ EAN, and ISBN.<br><br>For example:<br><pre>/buy/browse/v1/item_summary/search?gtin=099482432621</pre><span\
          \ class=\"tablenote\"><b>Note:</b> When constructing a query, <code>gtin</code>\
          \ value may be combined with an <code>epid</code> value, but neither an\
          \ <code>epid</code> or <code>gtin</code> value should be combined with a\
          \ keywords search through the <code>q</code> parameter.</span>"
        required: false
        schema:
          type: "string"
      - name: "limit"
        in: "query"
        description: "The number of items from the result set returned in a single\
          \ page.<br><br><span class=\"tablenote\"><b>Note:</b> If a value is set\
          \ in the <code>limit</code> field, the value of <code>offset</code> must\
          \ be either zero or a multiple of the <code>limit</code> value. An error\
          \ is returned for invalid <code>offset</code> values.</span><br><span class=\"\
          tablenote\"><b>Note:</b> This method can return a maximum of 10,000 items\
          \ in one results set.</span><br><b>Min:</b> 1<br><br><b>Max:</b> 200<br><br><b>Default:</b>\
          \ 50"
        required: false
        schema:
          type: "string"
      - name: "offset"
        in: "query"
        description: "Specifies the number of items to skip in the result set. This\
          \ is used with the <code>limit</code> field to control the pagination of\
          \ the output.<br><br>For example:<ul><li>If <code>offset</code> is 0 and\
          \ <code>limit</code> is 10, the method will retrieve items 1-10 from the\
          \ list of items returned</li><li>If <code>offset</code> is 10 and <code>limit</code>\
          \ is 10, the method will retrieve items 11-20 from the list of items returned.</li></ul><span\
          \ class=\"tablenote\"><b>Note:</b> The value of <code>offset</code> must\
          \ be either zero or a multiple of the value set in the <code>limit</code>\
          \ field. An error is returned for invalid <code>offset</code> values.</span><br><span\
          \ class=\"tablenote\"><b>Note:</b> This method can return a maximum of 10,000\
          \ items in one results set.</span><br><b>Min</b>: 0<br><br><b>Max:</b> 9,999<br><br><b>Default:</b>\
          \ 0"
        required: false
        schema:
          type: "string"
      - name: "q"
        in: "query"
        description: "A string consisting of one or more keywords used to search for\
          \ items on eBay.<br><br><span class=\"tablenote\"><b>Note:</b> The <code>*</code>\
          \ wildcard character is <b>not</b> allowed in this field.</span><br>When\
          \ providing two or more keywords in a single query, the string is processed\
          \ as follows:<ul><li>When successive keywords are separated by a space,\
          \ the list of keywords is processed as an <code>AND</code> request. For\
          \ example, to retrieve items that include <b>both</b> of the keywords <b>iphone</b>\
          \ AND <b>ipad</b>, submit the following query:<br><pre>/buy/browse/v1/item_summary/search?q=iphone\
          \ ipad</pre></li><li>When successive keywords are comma-separated and surrounded\
          \ by a single pair of parentheses, OR if the keywords are each URL-encoded,\
          \ the list of keywords is processed as an <code>OR</code> request. For example,\
          \ to retrieve items that include <b>iphone</b> OR <b>ipad</b>, submit one\
          \ of the following queries:<br><pre>/buy/browse/v1/item_summary/search?q=(iphone,\
          \ ipad)</pre><pre>/buy/browse/v1/item_summary/search?q=%28iphone%2c%20ipad%29</pre></li></ul><br><span\
          \ class=\"tablenote\"><b>Note:</b> When specifying keywords using the <code>q</code>\
          \ parameter:<ul><li> <i>Do not include</i> an <code>epid</code> or <code>gtin</code>\
          \ parameter value as neither can be used in conjunction with a keyword search.</li><li>Strings\
          \ longer than 100-characters are truncated.</li></ul></span><br><br><b>Maximum\
          \ length:</b> 100 characters"
        required: false
        schema:
          type: "string"
      - name: "sort"
        in: "query"
        description: "Specifies the criteria on which returned items are to be sorted.<br><br>Items\
          \ can be sorted in ascending order based on:<ul><li>Price (<code>sort=price</code>)<br>Returned\
          \ items are sorted based on their total cost (i.e., <i>price + shipping\
          \ cost</i>).<br><br>Items with the lowest combined price are shown first.<br><br>When\
          \ sorting by price, it is highly recommended that:<ul><li>The <code>X-EBAY-C-ENDUSERCTX</code>\
          \ request header is used, <b>and</b></li><li>The <code>contextualLocation</code>\
          \ parameter specifies the delivery country and postal code.<br><br>These\
          \ values must be <i>URL-encoded</i>.</li></ul>Refer to the following example:<pre>X-EBAY-C-ENDUSERCTX:\
          \ contextualLocation=country%3DUS%2Czip%3D19406</pre><b>Descending price\
          \ order</b><br>To sort items from <i>highest price</i> to <i>lowest price</i>\
          \ insert a minus sign (-) before <code>price</code> as the search criterion:<pre>sort=-price</pre></li><li>Distance\
          \ (<code>sort=distance</code>)<br>Returned items are sorted based on their\
          \ distance from the buyer's location.<br><br>Items that are closest to the\
          \ buyer are listed first.<br><br><div class=\"msgbox_important\"><p class=\"\
          msgbox_importantInDiv\" data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color:\
          \ #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;\"\
          ><span class=\"autonumber\"><span><b><span style=\"color: #dd1e31;\" class=\"\
          mcFormatColor\">Important!</span></b></span></span> When sorting by distance,\
          \ all required <a href=\"/api-docs/buy/static/ref-buy-browse-filters.html#pickupCountry\"\
          \ target=\"_blank\">pickup filters</a> must be included in the request.</p></div></li><li>Date<br>Items\
          \ can be sorted by date based on:<ul><li>Listing date (<code>sort=newlyListed</code>)<br>Returned\
          \ items are sorted based on their <a href=\"/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.itemOriginDate\"\
          \ target=\"_blank\"> itemOriginDate</a>.<br><br>Newly listed items are shown\
          \ first.</li><li>End date (<code>sort=endingSoonest</code>)<br>Returned\
          \ items are sorted based on the date/time on which their listing is scheduled\
          \ to end.<br><br>Items that are closest to their scheduled ending date/time\
          \ are shown first.</li></ul></ul>If no sort parameter is submitted, the\
          \ result set is sorted by \"Best Match\". Refer to <a href=\"https://www.ebay.com/help/selling/listings/listing-tips/optimising-listings-best-match?id=4166\
          \ \" target=\"_blank\">Optimizing your listings for Best Match</a> for additional\
          \ information. For implementation help, refer to eBay API documentation\
          \ at https://developer.ebay.com/api-docs/buy/browse/types/cos:SortField"
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-ENDUSERCTX"
        in: "header"
        description: "This header is required to support revenue sharing for eBay\
          \ Partner Network and to improve the accuracy of shipping and delivery time\
          \ estimations.<br><br>For additional information, refer to <a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
          \ target=\"_blank \">Use request headers</a> in the <a href=\"/api-docs/buy/static/buying-ig-landing.html\"\
          \ target=\"_blank\">Buying Integration Guide</a>."
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-MARKETPLACE-ID"
        in: "header"
        description: "This header identifies the seller's eBay marketplace. It is\
          \ required for all marketplaces outside of the US.<br><br><span class=\"\
          tablenote\"><b>Note:</b> If the marketplace ID value is invalid or missing,\
          \ the default value of <code>EBAY_US</code> is used.</span><br>See <a href=\"\
          /api-docs/buy/browse/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a>\
          \ for a list of supported marketplaces.<br><br><b>Default:</b> <code>EBAY_US</code>"
        required: false
        schema:
          type: "string"
      - name: "Accept-Language"
        in: "header"
        description: "This header is used to indicate the natural language and locale\
          \ preferred by the user for the response.<br><br>This header is required\
          \ when targeting a specific locale of a marketplace that supports multiple\
          \ locales. For example:<ul><li>When targeting the French locale of the Belgium\
          \ marketplace, it is required to pass in <code>fr-BE</code> to specify this.\
          \ If this locale is not specified, the language will default to Dutch.</li><li>When\
          \ targeting the French locale of the Canadian marketplace, it is required\
          \ to pass in <code>fr-CA</code> to specify this. If this locale is not specified,\
          \ the language will default to English.</li></ul>"
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchPagedCollection"
          x-response-codes:
            errors:
              12002:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The {filterName} value is invalid. For the valid values,\
                  \ refer to the API call documentation."
              12003:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "A seller 'username' provided in the request filters\
                  \ is invalid."
              12519:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The '{fieldName}' value '{filterValue}' is not supported\
                  \ with 'deliveryCountry' '{deliveryCountry}' on marketplace '{marketplaceId}'.\
                  \ The region filter will be ignored and results will follow the\
                  \ site's default location behavior."
              12008:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'sort' value is invalid. For the valid values, refer\
                  \ to the API call documentation."
              12009:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'category_ids' query parameter is invalid."
              12010:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "There are four filters required for local pickup. 'pickupPostalCode','pickupCountry','pickupRadiusUnit','pickupRadius'.\
                  \ One or more is missing or invalid."
              12011:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "'deliveryCountry' is a mandatory filter to provide a\
                  \ delivery location. 'deliveryPostalCode' is optional."
              12012:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "A valid 'price' filter and a valid 'priceCurrency' filter\
                  \ is necessary to filter based on price."
              12014:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "The 'sellerAccountTypes' filter is not supported for\
                  \ the marketplace {marketplaceId}. Valid marketplaces are: {validMarketplaces}"
              12015:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The postal code filter value is invalid for the specified\
                  \ country and this filter was ignored."
              12016:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'fieldgroups' value {fieldgroups} is invalid. For\
                  \ the valid values, refer to the API call reference documentation"
              12017:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'aspect_filter' query parameter must include a categoryId.\
                  \ For information, see the API call reference documentation."
              12018:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The {aspectFilter} aspect_filter value is invalid. For\
                  \ information, see the API call reference documentation."
              12021:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'epid' value {epid} is invalid. For information,\
                  \ see the API call reference documentation."
              12022:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'gtin' value {gtin} is invalid. For information,\
                  \ see the API call reference documentation."
              12502:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The {compatibilityFilter} compatibility_filter is invalid.\
                  \ For information, see the API call reference documentation."
              12024:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'charity_ids' value {charity_id} is invalid. For\
                  \ more information see the API call reference documentation."
              12511:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "Either 'deliveryCountry' or 'deliveryPostalCode' is\
                  \ invalid, hence 'guaranteedDeliveryInDays' filter was ignored."
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              12032:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The number of sellers in the filter has exceeded the\
                  \ limit. Please reduce the number of sellers to 250 or fewer."
              12033:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'qualifiedPrograms' filter for {filterValue} requires\
                  \ valid 'deliveryPostalCode' and 'deliveryCountry' filter values."
              12034:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'buyingOptions' filter value {filterValue} is not\
                  \ supported for the sort by {sortOption}. For the supported values,\
                  \ refer to the API call documentation."
              12503:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "There is no compatibility information found either because\
                  \ there is no compatibility results or the data provided in the\
                  \ compatibility_filter is invalid or insufficient."
              12504:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "You must provide a category ID that supports fitment."
              12505:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The following compatibility attributes in the request\
                  \ are not supported: {attributes}."
              12506:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The category ID submitted does not support fitment."
              12507:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "To filter by 'guaranteedDeliveryInDays', you must include\
                  \ 'deliveryCountry'."
              12508:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "To filter by 'guaranteedDeliveryInDays', you must include\
                  \ 'deliveryPostalCode' for the 'deliveryCountry'."
              12509:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'guaranteedDeliveryInDays' value {guaranteedDeliveryInDays}\
                  \ is invalid for 'deliveryCountry' value {deliveryCountry}.  Valid\
                  \ values for 'guaranteedDeliveryInDays' for {deliveryCountry} must\
                  \ be in the range of {rangeLowerBound} to {rangeUpperBound} inclusive."
              12510:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'guaranteedDeliveryInDays' filter is not supported\
                  \ for the marketplace {marketplaceId}. Valid marketplaces are: {validMarketplaces}"
              12512:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'qualifiedPrograms' filter for {filterValue} is\
                  \ not supported for the marketplace {marketplaceId}. Valid marketplaces\
                  \ are: {validMarketplaces}"
              12001:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The call must have a valid 'q', 'category_ids', 'epid'\
                  \ or 'gtin' query parameter."
              12515:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'offset' value must be either zero or a multiple\
                  \ of the 'limit' value."
              12004:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'offset' value cannot be negative."
              12516:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The ‘q’ value is invalid. It must be longer than one\
                  \ character when using the ‘searchInDescription’ filter."
              12005:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'offset' value must be an integer."
              12517:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "Only one item location filter can be applied at a time.\
                  \ Refer to the API call documentation."
              12006:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'limit' value should be between 1 and 200 (inclusive)."
              12518:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'itemLocationRegion' filter value is not supported\
                  \ for the marketplace {marketplaceId}. Valid values are: {validRegionValues}"
              12007:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'limit' value must be an integer value."
              12023:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "This keyword search results in a response that is too\
                  \ large to return. Either change the keyword or add additional query\
                  \ parameters and/or filters."
              12025:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'charity_ids' field has exceeded the maximum limit\
                  \ of 20."
              12026:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'charity_ids' field is not supported for the marketplace\
                  \ {marketplaceId}. Valid marketplaces are: {validMarketplaces}."
              12027:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'auto_correct' value is invalid. For the valid values,\
                  \ refer to the API call documentation."
              12028:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'auto_correct' is not supported for the marketplace\
                  \ {marketplaceId}. Valid marketplaces are: {validMarketplaces}"
              12029:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The maximum number of listings that can be retrieved\
                  \ is 10,000, so your offset value must be less than 10,000. If 10,000\
                  \ or more listings are matching your search criteria, consider narrowing\
                  \ the scope of your search."
              12030:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The number of categories in the request has exceeded\
                  \ the limit. Please reduce the number of categories to {allowedMaxCategories}\
                  \ or less."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              12000:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "409":
          description: "Conflict"
          x-response-codes:
            errors:
              12513:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "The 'priorityListing' filter for {filterValue} is not\
                  \ supported for the marketplace {marketplaceId}. Valid marketplaces\
                  \ are: {validMarketplaces}"
              12514:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "The 'priorityListing' filter is not supported for the\
                  \ specified sort option. Refer to the API call documentation."
              12019:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "Currently, the {marketplaceId} marketplace is not supported.\
                  \ The supported Marketplaces are: {allowedMarketplaces} ."
              12020:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "The 'fieldgroups' value {fieldgroups} is invalid when\
                  \ multiple 'category_ids' are specified. Either change the call\
                  \ to have only one value in 'category_ids' or remove the 'fieldgroups'."
              12013:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "Top level category browsing is not allowed. Please provide\
                  \ keywords or more filters for the applied top level category."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope"
  /item_summary/search_by_image:
    post:
      tags:
      - "item_summary"
      description: "This method searches for eBay items based on a image and retrieves\
        \ summaries of the items. You pass in a Base64 image in the request payload\
        \ and can refine the search by category, or with other available filters.<br><br>To\
        \ get the Base64 image string, you can use sites such as <a href=\"https://codebeautify.org/image-to-base64-converter\
        \ \" target=\"_blank\">https://codebeautify.org/image-to-base64-converter</a>.<br><br>This\
        \ method also supports the following:<ul> <li>Filtering by the value of one\
        \ or multiple fields, such as listing format, item condition, price range,\
        \ location, and more. For the fields supported by this method, refer to the\
        \ <a href=\"#uri.filter\">filter</a> parameter.</li><li>Filtering by item\
        \ aspects using the <a href=\"#uri.aspect_filter\">aspect_filter</a> parameter.</li></ul>For\
        \ details and examples of these capabilities, refer to <a href=\"/api-docs/buy/static/api-browse.html\"\
        \ target=\"_blank\">Browse API</a> in the Buying Integration Guide.<h3>URL\
        \ Encoding for Parameters</h3>Query parameter values need to be URL encoded.\
        \ For details, refer to <a href=\"/api-docs/static/rest-request-components.html#parameters\"\
        \ target=\"_blank\">URL encoding query parameter values</a>. For readability,\
        \ code examples in this document have not been URL encoded.<h3>Restrictions</h3>This\
        \ method can return a maximum of 10,000 items. For a list of supported sites\
        \ and other restrictions, refer to <a href=\"/api-docs/buy/browse/overview.html#API\"\
        >API Restrictions</a>.<br><br><span class=\"tablenote\"><b>eBay Partner Network:</b>\
        \ In order to receive a commission for your sales, you must use the URL returned\
        \ in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the\
        \ ebay.com site.</span>"
      operationId: "searchByImage"
      parameters:
      - name: "aspect_filter"
        in: "query"
        description: "This field lets you filter by item aspects. The aspect name/value\
          \ pairs and category, which is required, is used to limit the results to\
          \ specific aspects of the item. For example, in a clothing category one\
          \ aspect pair would be Color/Red.<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ The category ID must be specified <i>twice</i>:<ul><li>Once as a URI parameter\
          \ in the <code>category_ids</code> field</li><li>Once as part of the <code>aspect_filter</code>\
          \ field</li></ul>These two values <b>must</b> be the same.</span><br>For\
          \ example, to return items for a woman's red shirt, issue the following\
          \ request:<br><pre>/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}</pre>To\
          \ get a list of the aspect pairs and the category, which is returned in\
          \ the <code>dominantCategoryId</code> field, set <code>fieldgroups</code>\
          \ to <code>ASPECT_REFINEMENTS</code> as illustrated here:<pre>/buy/browse/v1/item_summary/search?q=shirt&amp;fieldgroups=ASPECT_REFINEMENTS</pre><span\
          \ class=\"tablenote\"><b> Note:</b> The pipe symbol is used as a delimiter\
          \ between aspect filter values. If a value contains a pipe symbol (for example,\
          \ the brand name 'Bed|Stü'), you must enter a backslash before the pipe\
          \ character to prevent it from being evaluated as a delimiter.<br><br>The\
          \ following example illustrates the correct format for entering two brand\
          \ names as aspect filter values, one of which contains a pipe symbol:<pre>/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed&bsol;|Stü\
          |Nike}</pre></span> For implementation help, refer to eBay API documentation\
          \ at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter"
        required: false
        schema:
          type: "string"
      - name: "category_ids"
        in: "query"
        description: "</a>The category ID is used to limit the results that are returned.\
          \ This field may pass in one category ID or a comma separated list of IDs\
          \ as illustrated in the following examples:<pre>/buy/browse/v1/item_summary/searchByImage?category_ids=29792</pre><pre>/buy/browse/v1/item_summary/searchByImage?category_ids=267,29792</pre><span\
          \ class=\"tablenote\"><b>Note:</b> Currently, you can pass in only one category\
          \ ID per request.</span><br>To refine the set of information that is returned,\
          \ <code>category_ids</code> may be combined with other available filters.<br><br>Because\
          \ the list of eBay category IDs is not published and category IDs are not\
          \ the same across all eBay marketplaces, category IDs may be determined\
          \ by:<ul><li>Visiting the <a href=\"https://pages.ebay.com/sellerinformation/news/categorychanges.html\
          \ \" target=\"_blank\">Category Changes page</a></li><li>Using the Taxonomy\
          \ API. Refer to <a href=\"/api-docs/buy/buy-categories.html\" target=\"\
          _blank\">Get Categories for Buy APIs</a> for complete information.</li><li>Issuing\
          \ the following call to retrieve the <code>dominantCategoryId</code> for\
          \ an item:<pre>/buy/browse/v1/item_summary/searchByImage?q=<i> keyword</i>&fieldgroups=ASPECT_REFINEMENTS</pre></li></ul>"
        required: false
        schema:
          type: "string"
      - name: "charity_ids"
        in: "query"
        description: "The charity ID filters results to return only those items associated\
          \ with the specified charity.<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ <code>charity_ids</code> is only supported by the US and UK marketplaces.</span><br>Charity\
          \ ID is a charity's unique identification number:<ul><li>In the US, this\
          \ is the <b>Employer Identification Number (EIN)</b>.</li><li>In the UK,\
          \ this is the Charity Registration Number (CRN), commonly called <b>Charity\
          \ Number</b>.</li></ul><br><code>charity_ids</code> may be retrieved/determined\
          \ as follows:<ul><li>Search for a supported charity using the Charity API's\
          \ <a href=\"/api-docs/commerce/charity/resources/charity_org/methods/getCharityOrgs\
          \ \" target=\"_blank\">getCharityOrgs</a> method.<br><br><div class=\"msgbox_important\"\
          ><p class=\"msgbox_importantInDiv\" data-mc-autonum=\"&lt;b&gt;&lt;span\
          \ style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
          \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
          color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
          \ The value to be passed in as <code>charity_ids</code> is that returned\
          \ in the <code>registrationId</code> field.</p></div></li><li>Search for\
          \ a supported charity by visiting <a href=\"https://charity.ebay.com/search\
          \ \" target=\"_blank\">Charity Search</a>. Click on the charity's name to\
          \ display its information. The EIN number is included in the charity's information\
          \ block at the top of the page.<br><br>For example, the charity ID for <a\
          \ href=\"https://charity.ebay.com/charity/American-Red-Cross/3843 \" target=\"\
          _blank\">American Red Cross</a>, is <code>530196605</code>.</li></ul>Up\
          \ to 20 comma-separated <code>charity_ids</code> may be specified in each\
          \ query. Additionally, <code>charity_ids</code> may be combined with <code>category_ids</code>\
          \ and/or <code>q</code> keyword values to further filter returned results.<br><br>A\
          \ sample query using <code>charity_ids</code> is:<br><pre>/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469</pre>"
        required: false
        schema:
          type: "string"
      - name: "fieldgroups"
        in: "query"
        description: "A comma-separated list of values that controls what is returned\
          \ in the response. The default is <code>MATCHING_ITEMS</code>, which returns\
          \ the items that match the keyword or category specified. The other values\
          \ return data that can be used to create histograms or provide additional\
          \ information.<br><br><b>Valid Values:</b><ul><li><code>ASPECT_REFINEMENTS</code><br>This\
          \ field group adds the <a href=\"#response.refinement.aspectDistributions\"\
          >aspectDistributions</a> container to the response.<br><br><span class=\"\
          tablenote\"><b>Note:</b> Information returned by <code>ASPECT_REFINEMENTS</code>\
          \ is category specific.</span></li><li><code>BUYING_OPTION_REFINEMENTS</code><br>This\
          \ field group adds the <a href=\"#response.refinement.buyingOptionDistributions\"\
          >buyingOptionDistributions</a> container to the response.</li><li><code>CATEGORY_REFINEMENTS</code><br>This\
          \ field group adds the <a href=\"#response.refinement.categoryDistributions\"\
          >categoryDistributions</a> container to the response.</li><li><code>CONDITION_REFINEMENTS</code><br>This\
          \ field group adds the <a href=\"#response.refinement.conditionDistributions\"\
          >conditionDistributions</a> containers, such as <code>NEW</code>, <code>USED</code>,\
          \ etc., to the response. Within these groups are multiple states of the\
          \ condition.<br><br>For example, <code>NEW</code> can be <i>New without\
          \ tag</i>, <i>New in box</i>, <i>New without box</i>, etc.</li><li><code>EXTENDED</code><br>This\
          \ field group adds the following fields to the response:<ul><li><a href=\"\
          /api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.shortDescription\"\
          >shortDescription</a></li><li><a href=\"/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.itemLocation.city\"\
          >itemLocation.city</a></li></ul></li><li><code>MATCHING_ITEMS</code> (<b>default\
          \ value</b>)<br>This field group is intended to be used with one or more\
          \ of the refinement values listed above. This is used to return the specified\
          \ refinements and all matching items.</li><li><code>FULL</code><br>This\
          \ field group returns all refinement containers and all matching items.</li></ul><b>Default:</b>\
          \ <code>MATCHING_ITEMS</code>"
        required: false
        schema:
          type: "string"
      - name: "filter"
        in: "query"
        description: "An array of field filters that can be used to limit/customize\
          \ the result set.<br><br>Refer to <a href=\"/api-docs/buy/static/ref-buy-browse-filters.html\"\
          \ target=\"_blank\">Buy API Field Filters</a> for the information about\
          \ available filters.<br><br>For example, to filter shirts based on a specific\
          \ range of prices, include the filter illustrated here: <pre>/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50]</pre>Filters\
          \ may also be combined within a single request as illustrated in the sample\
          \ below which further refines results to return only those shirts available\
          \ from specific sellers: <pre>/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50],sellers:{rpseller|bigSal}</pre><span\
          \ class=\"tablenote\"><b>Note:</b> Refer to <a href=\"/api-docs/buy/static/ref-buy-browse-filters.html\"\
          \ target=\"_blank\">Buy API Field Filters</a> for additional information\
          \ and examples of all supported filters.</span> For implementation help,\
          \ refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField"
        required: false
        schema:
          type: "string"
      - name: "limit"
        in: "query"
        description: "The number of items from the result set returned in a single\
          \ page.<br><br><span class=\"tablenote\"><b>Note:</b> If a value is set\
          \ in the <code>limit</code> field, the value of <code>offset</code> must\
          \ be either zero or a multiple of the <code>limit</code> value. An error\
          \ is returned for invalid <code>offset</code> values.</span><br><span class=\"\
          tablenote\"><b>Note:</b> This method can return a maximum of 10,000 items\
          \ in one results set.</span><br><b>Min:</b> 1<br><br><b>Max:</b> 200<br><br><b>Default:</b>\
          \ 50"
        required: false
        schema:
          type: "string"
      - name: "offset"
        in: "query"
        description: "Specifies the number of items to skip in the result set. This\
          \ is used with the <code>limit</code> field to control the pagination of\
          \ the output.<br><br>For example:<ul><li>If <code>offset</code> is 0 and\
          \ <code>limit</code> is 10, the method will retrieve items 1-10 from the\
          \ list of items returned</li><li>If <code>offset</code> is 10 and <code>limit</code>\
          \ is 10, the method will retrieve items 11-20 from the list of items returned.</li></ul><span\
          \ class=\"tablenote\"><b>Note:</b> The value of <code>offset</code> must\
          \ be either zero or a multiple of the value set in the <code>limit</code>\
          \ field. An error is returned for invalid <code>offset</code> values.</span><br><span\
          \ class=\"tablenote\"><b>Note:</b> This method can return a maximum of 10,000\
          \ items in one results set.</span><br><b>Min</b>: 0<br><br><b>Max:</b> 9,999<br><br><b>Default:</b>\
          \ 0"
        required: false
        schema:
          type: "string"
      - name: "sort"
        in: "query"
        description: "<span class=\"tablenote\"><b>Note:</b> This call currently returns\
          \ results in a best-match order. This query parameter presently has no practical\
          \ use.</span> For implementation help, refer to eBay API documentation at\
          \ https://developer.ebay.com/api-docs/buy/browse/types/cos:SortField"
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-ENDUSERCTX"
        in: "header"
        description: "This header is required to support revenue sharing for eBay\
          \ Partner Network and to improve the accuracy of shipping and delivery time\
          \ estimations.<br><br>For additional information, refer to <a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
          \ target=\"_blank \">Use request headers</a> in the <a href=\"/api-docs/buy/static/buying-ig-landing.html\"\
          \ target=\"_blank\">Buying Integration Guide</a>."
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-MARKETPLACE-ID"
        in: "header"
        description: "This header identifies the seller's eBay marketplace. It is\
          \ required for all marketplaces outside of the US.<br><br><span class=\"\
          tablenote\"><b>Note:</b> If the marketplace ID value is invalid or missing,\
          \ the default value of <code>EBAY_US</code> is used.</span><br>See <a href=\"\
          /api-docs/buy/browse/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a>\
          \ for a list of supported marketplaces.<br><br><b>Default:</b> <code>EBAY_US</code>"
        required: false
        schema:
          type: "string"
      - name: "Content-Type"
        in: "header"
        description: "This header indicates the format of the request body provided\
          \ by the client. Its value should be set to <code>application/json</code>.<br><br>For\
          \ more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
          \ target=\"_blank \">HTTP request headers</a>."
        required: true
        schema:
          type: "string"
      - name: "Accept-Language"
        in: "header"
        description: "This header is used to indicate the natural language and locale\
          \ preferred by the user for the response.<br><br>This header is required\
          \ when targeting a specific locale of a marketplace that supports multiple\
          \ locales. For example:<ul><li>When targeting the French locale of the Belgium\
          \ marketplace, it is required to pass in <code>fr-BE</code> to specify this.\
          \ If this locale is not specified, the language will default to Dutch.</li><li>When\
          \ targeting the French locale of the Canadian marketplace, it is required\
          \ to pass in <code>fr-CA</code> to specify this. If this locale is not specified,\
          \ the language will default to English.</li></ul>"
        required: false
        schema:
          type: "string"
      requestBody:
        description: "The container for the image information fields."
        content:
          application/json:
            schema:
              description: "The container for the image information fields."
              $ref: "#/components/schemas/SearchByImageRequest"
        required: false
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchPagedCollection"
          x-response-codes:
            errors:
              12002:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The {filterName} value is invalid. For the valid values,\
                  \ refer to the API call documentation."
              12003:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "A seller 'username' provided in the request filters\
                  \ is invalid."
              12008:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'sort' value is invalid. For the valid values, refer\
                  \ to the API call documentation."
              12009:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'category_ids' query parameter is invalid."
              12010:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "There are four filters required for local pickup. 'pickupPostalCode','pickupCountry','pickupRadiusUnit','pickupRadius'.\
                  \ One or more is missing or invalid."
              12011:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "'deliveryCountry' is a mandatory filter to provide a\
                  \ delivery location. 'deliveryPostalCode' is optional."
              12012:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "A valid 'price' filter and a valid 'priceCurrency' filter\
                  \ is necessary to filter based on price."
              12014:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "The 'sellerAccountTypes' filter is not supported for\
                  \ the marketplace {marketplaceId}. Valid marketplaces are: {validMarketplaces}"
              12015:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The postal code filter value is invalid for the specified\
                  \ country and this filter was ignored."
              12016:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'fieldgroups' value {fieldgroups} is invalid. For\
                  \ the valid values, refer to the API call reference documentation"
              12017:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'aspect_filter' query parameter must include a categoryId.\
                  \ For information, see the API call reference documentation."
              12018:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The {aspectFilter} aspect_filter value is invalid. For\
                  \ information, see the API call reference documentation."
              12024:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'charity_ids' value {charity_id} is invalid. For\
                  \ more information see the API call reference documentation."
              12031:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The following filter(s) is/are not supported by this\
                  \ operation: {unsupportedFilters}. For more information see the\
                  \ API call reference documentation."
              12511:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "Either 'deliveryCountry' or 'deliveryPostalCode' is\
                  \ invalid, hence 'guaranteedDeliveryInDays' filter was ignored."
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              12032:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The number of sellers in the filter has exceeded the\
                  \ limit. Please reduce the number of sellers to 250 or fewer."
              12512:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'qualifiedPrograms' filter for {filterValue} is\
                  \ not supported for the marketplace {marketplaceId}. Valid marketplaces\
                  \ are: {validMarketplaces}"
              12033:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'qualifiedPrograms' filter for {filterValue} requires\
                  \ valid 'deliveryPostalCode' and 'deliveryCountry' filter values."
              12034:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'buyingOptions' filter value {filterValue} is not\
                  \ supported for the sort by {sortOption}. For the supported values,\
                  \ refer to the API call documentation."
              12515:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'offset' value must be either zero or a multiple\
                  \ of the 'limit' value."
              12004:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'offset' value cannot be negative."
              12005:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'offset' value must be an integer."
              12006:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'limit' value should be between 1 and 200 (inclusive)."
              12007:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'limit' value must be an integer value."
              12500:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "This image search results in a response that is too\
                  \ large to return. Either change the image or add additional query\
                  \ parameters and/or filters."
              12501:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The image data is empty, is not Base64 encoded, or is\
                  \ invalid."
              12025:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'charity_ids' field has exceeded the maximum limit\
                  \ of 20."
              12026:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'charity_ids' field is not supported for the marketplace\
                  \ {marketplaceId}. Valid marketplaces are: {validMarketplaces}."
              12507:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "To filter by 'guaranteedDeliveryInDays', you must include\
                  \ 'deliveryCountry'."
              12508:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "To filter by 'guaranteedDeliveryInDays', you must include\
                  \ 'deliveryPostalCode' for the 'deliveryCountry'."
              12029:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The maximum number of listings that can be retrieved\
                  \ is 10,000, so your offset value must be less than 10,000. If 10,000\
                  \ or more listings are matching your search criteria, consider narrowing\
                  \ the scope of your search."
              12509:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'guaranteedDeliveryInDays' value {guaranteedDeliveryInDays}\
                  \ is invalid for 'deliveryCountry' value {deliveryCountry}.  Valid\
                  \ values for 'guaranteedDeliveryInDays' for {deliveryCountry} must\
                  \ be in the range of {rangeLowerBound} to {rangeUpperBound} inclusive."
              12030:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The number of categories in the request has exceeded\
                  \ the limit. Please reduce the number of categories to {allowedMaxCategories}\
                  \ or less."
              12510:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'guaranteedDeliveryInDays' filter is not supported\
                  \ for the marketplace {marketplaceId}. Valid marketplaces are: {validMarketplaces}"
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              12000:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "409":
          description: "Conflict"
          x-response-codes:
            errors:
              12513:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "The 'priorityListing' filter for {filterValue} is not\
                  \ supported for the marketplace {marketplaceId}. Valid marketplaces\
                  \ are: {validMarketplaces}"
              12514:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "The 'priorityListing' filter is not supported for the\
                  \ specified sort option. Refer to the API call documentation."
              12019:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "Currently, the {marketplaceId} marketplace is not supported.\
                  \ The supported Marketplaces are: {allowedMarketplaces} ."
              12020:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "The 'fieldgroups' value {fieldgroups} is invalid when\
                  \ multiple 'category_ids' are specified. Either change the call\
                  \ to have only one value in 'category_ids' or remove the 'fieldgroups'."
              12013:
                domain: "API_BROWSE"
                category: "BUSINESS"
                description: "Top level category browsing is not allowed. Please provide\
                  \ keywords or more filters for the applied top level category."
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope"
  /item/{item_id}:
    get:
      tags:
      - "item"
      description: "This method retrieves the details of a specific item, such as\
        \ description, price, category, all item aspects, condition, return policies,\
        \ seller feedback and score, shipping options, shipping costs, estimated delivery,\
        \ and other information the buyer needs to make a purchasing decision.<br><br>The\
        \ Buy APIs are designed to let you create an eBay shopping experience in your\
        \ app or website. This means you will need to know when something, such as\
        \ the availability, quantity, etc., has changed in any eBay item you are offering.\
        \ This is easily achieved by setting the <b>fieldgroups</b> URI parameter\
        \ to one of the following values:<ul><li><code>COMPACT</code><br>Reduces the\
        \ response to only those fields necessary in order to determine if any item\
        \ detail has changed. This field group <b>must</b> be used alone.</li><li><code>PRODUCT</code><br>Adds\
        \ fields to the default response that return information about the product/item.\
        \ This field group may also be used in conjunction with <code>ADDITIONAL_SELLER_DETAILS</code>.</li><li><code>ADDITIONAL_SELLER_DETAILS</code><br>Adds\
        \ an additional field to the response that returns the seller's user ID. This\
        \ field group may also be used in conjunction with <code>PRODUCT</code>.</li><li><code>CHARITY_DETAILS</code><br>Adds\
        \ additional fields to the response that return charity information associated\
        \ with the item, if applicable.</li></ul>For additional information, refer\
        \ to <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#uri.fieldgroups\"\
        >fieldgroups</a>.<h3>Restrictions</h3>For a list of supported sites and other\
        \ restrictions, refer to <a href=\"/api-docs/buy/browse/overview.html#API\"\
        >API Restrictions</a>.<br><br><span class=\"tablenote\"><b>eBay Partner Network:</b>\
        \ In order to be commissioned for your sales, you must use the URL returned\
        \ in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the\
        \ ebay.com site.</span>"
      operationId: "getItem"
      parameters:
      - name: "fieldgroups"
        in: "query"
        description: "This parameter controls what is returned in the response. If\
          \ this field is not set, the method returns all the details of the item.<br><br><span\
          \ class=\"tablenote\"><b>Note:</b> Multiple <b>fieldgroups</b> can be set\
          \ and applied simultaneously. However, <b>COMPACT</b> <b>must</b> be used\
          \ alone. Otherwise, an error will occur.</span><br><b>Valid Values:</b><ul><li><b>PRODUCT</b><br>This\
          \ field group adds the <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#response.product\"\
          >product</a> container to the response.</li><li><b>COMPACT</b></br>This\
          \ field group returns only the following fields which let you quickly check\
          \ if the availability or price of the item has changed, if the item has\
          \ been revised by the seller, or if an item's top-rated plus status has\
          \ changed for items you have stored.<ul><li><b>itemId</b></li><li><b>bidCount</b></li><li><b>currentBidPrice</b></li><li><b>eligibleForInlineCheckout</b></li><li><b>estimatedAvailabilities</b></li><li><b>gtin</b></li><li><b>immediatePay</b></li><li><b>itemAffiliateWebURL</b></li><li><b>itemCreationDate</b></li><li><b>itemWebUrl</b></li><li><b>legacyItemId</b></li><li><b>minimumPriceToBid</b></li><li><b>price</b></li><li><b>priorityListing</b></li><li><b>reservePriceMet</b></li><li><b>sellerItemRevision</b></li><li><b>shippingOptions</b></li><li><b>taxes</b></li><li><b>topRatedBuyingExperience</b></li><li><b>uniqueBidderCount</b></li></ul>For\
          \ Example:<br>To determine if a stored item's information is current, perform\
          \ the following:<ol><li>Pass in the item ID and set <code>fieldgroups</code>\
          \ to <code>COMPACT</code>.<pre>item/v1|4**********8|0?fieldgroups=COMPACT</pre></li><li>Do\
          \ one of the following:<ul><li>If <b>sellerItemRevision</b> is returned\
          \ and a revision number for this item <i>has not</i> been stored, record\
          \ the number and pass in the item ID in the <b>getItem</b> method to retrieve\
          \ the most recent information.</li><li>If the revision number is different\
          \ from the value you have stored, update the value and pass in the item\
          \ ID in the <b>getItem</b> method to retrieve the most recent information.</li><li>If\
          \ <code>sellerItemRevision</code> is <i>not</i> returned or has not changed,\
          \ where needed, update the item information with the information returned\
          \ in the response.</li></ul></li></ol></li><li><b>ADDITIONAL_SELLER_DETAILS</b><br>This\
          \ adds the <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#response.seller.userId\"\
          >userId</a> field to the response.</li><li><b>CHARITY_DETAILS</b><br>This\
          \ adds the the <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#response.charityTerms\"\
          >charityTerms</a> container to the response, if applicable.</li></ul>"
        required: false
        schema:
          type: "string"
      - name: "item_id"
        in: "path"
        description: "This path parameter specifies the unique RESTful identifier\
          \ of the item being retrieved. <br><br><b>RESTful Item ID Format: </b><code>v1</code>|<code><i>#</i></code>|<code><i>#</i></code><br><br>For\
          \ a single SKU listing, pass in the item ID: <pre>v1|2**********2|0</pre>For\
          \ a multi-SKU listing, pass in the identifier of the variation:<pre>v1|1**********2|4**********2</pre><br>For\
          \ more information about item IDs for RESTful APIs, refer to <a href=\"\
          /api-docs/buy/static/api-browse.html#Legacy\" target=\"_blank\">Item ID\
          \ legacy API compatibility overview</a> in the <a href=\"/api-docs/buy/static/buying-ig-landing.html\"\
          \ target=\"_blank\">Buying Integration Guide</a>."
        required: true
        schema:
          type: "string"
      - name: "X-EBAY-C-ENDUSERCTX"
        in: "header"
        description: "This header is can be used in following two situations:<br><ul><li>To\
          \ retrieve the <b>itemAffiliateWebUrl</b> field in the response, the ePN\
          \ affiliate can pass in their affiliate credentials using this header. For\
          \ more information, see <a href=\"/api-docs/buy/static/api-browse.html#affiliate-header\"\
          \ target=\"_blank \">Header for affiliate information.</a></li><li>If the\
          \ listing is using calculated or flat-rate shipping with shipping rate tables,\
          \ the user can use this header to provide country and postal code in order\
          \ for the <b>shippingOption</b> container, which includes shipping costs\
          \ and delivery estimates, to be returned. For more information, see <a href=\"\
          /api-docs/buy/static/api-browse.html#X-EBAY-C-ENDUSERCTX-context\" target=\"\
          _blank \">Header for shipping information accuracy.</a></li></ul>"
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-MARKETPLACE-ID"
        in: "header"
        description: "This header identifies the seller's eBay marketplace. It is\
          \ required for all marketplaces outside of the US.<br><br><span class=\"\
          tablenote\"><b>Note:</b> If the marketplace ID value is invalid or missing,\
          \ the default value of <code>EBAY_US</code> is used.</span><br>See <a href=\"\
          /api-docs/buy/browse/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a>\
          \ for a list of supported marketplaces.<br><br><b>Default:</b> <code>EBAY_US</code>"
        required: false
        schema:
          type: "string"
      - name: "Accept-Language"
        in: "header"
        description: "This header is used to indicate the natural language and locale\
          \ preferred by the user for the response.<br><br>This header is required\
          \ when targeting a specific locale of a marketplace that supports multiple\
          \ locales. For example:<ul><li>When targeting the French locale of the Belgium\
          \ marketplace, it is required to pass in <code>fr-BE</code> to specify this.\
          \ If this locale is not specified, the language will default to Dutch.</li><li>When\
          \ targeting the French locale of the Canadian marketplace, it is required\
          \ to pass in <code>fr-CA</code> to specify this. If this locale is not specified,\
          \ the language will default to English.</li></ul>"
        required: false
        schema:
          type: "string"
      - name: "quantity_for_shipping_estimate"
        in: "query"
        description: "This query parameter sets the item quantity to be used when\
          \ calculating the shipping estimate information returned in the <a href=\"\
          /api-docs/buy/browse/resources/item/methods/getItem#response.shippingOptions\"\
          >shippingOptions</a> container of the response.<br><br>This value must be\
          \ a positive integer value and should not exceed the quantity available\
          \ in the listing. This field is not recommended for auction listings, as\
          \ they will always have a quantity of 1."
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Item"
          x-response-codes:
            errors:
              11508:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "This seller is currently away. If you make a purchase,\
                  \ please allow additional time for your order to be processed."
              11509:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "This seller is currently away until {sellerReturnDate}.\
                  \ If you make a purchase, please allow additional time for your\
                  \ order to be processed."
              11510:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem calculating the shipping cost. Please\
                  \ try again."
              11502:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem extracting product information for\
                  \ this Item. Please try again."
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              11008:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item group is not available. This can be for many\
                  \ reasons, such as when the listing is being updated by the seller.\
                  \ Wait a few minutes and try the call again."
              11011:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The marketplace value {marketplaceId} is not supported.\
                  \ The supported values are: {allowedMarketplaces}"
              11012:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified item IDs are invalid, or the format of\
                  \ the specified values are invalid."
              11013:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified group IDs are invalid, or the format of\
                  \ the specified values are invalid."
              11014:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "An item_ids and an item_group_ids list cannot be used\
                  \ at same time. Please use only one of these lists."
              11015:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The maximum number of item ids has been exceeded. Please\
                  \ reduce the number of item ids to {maxAllowedItemIds} or less."
              11016:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The maximum number of item group IDs has been exceeded.\
                  \ Please reduce the number of item group ids to {maxAllowedItemGroupIds}\
                  \ or less."
              11018:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified fieldgroups are invalid. The COMPACT fieldgroup\
                  \ cannot be combined with another fieldgroup."
              11019:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The quantity_for_shipping_estimate value {quantityForShippingEstimate}\
                  \ is invalid. Please enter a positive value."
              11501:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'fieldgroups' value(s) are invalid: {fieldgroups}.\
                  \ The supported fieldgroups are: {supportedFieldgroups}"
              11001:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified item ID was not found."
              11002:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified item group was not found."
              11004:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item is not available for purchase. This can be\
                  \ for many reasons, such as when the listing is being updated by\
                  \ the seller. Wait a few minutes and try the call again."
              11005:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item group ID is invalid. Use {itemHref} to get\
                  \ the item details."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              11000:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not Found"
        "409":
          description: "Conflict"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope"
  /item/get_item_by_legacy_id:
    get:
      tags:
      - "item"
      description: "This method is a bridge between the eBay legacy APIs, such as\
        \ <b>Shopping</b> and <b>Finding</b>, and the eBay Buy APIs. There are differences\
        \ between how legacy APIs and RESTful APIs return the identifier of an \"\
        item\" and what the item ID represents. This method lets you use the legacy\
        \ item ids retrieve the details of a specific item, such as description, price,\
        \ and other information the buyer needs to make a purchasing decision. It\
        \ also returns the RESTful <b>item_id</b>, which you can use with all the\
        \ Buy API  methods.<br><br>For additional information about how to use legacy\
        \ ids with the Buy APIs, refer to <a href=\"/api-docs/buy/static/api-browse.html#Legacy\"\
        \ target=\"_blank\">Item ID legacy API compatibility overview</a> in the Buying\
        \ Integration guide.</br><br>This method returns the item details and requires\
        \ you to pass in either the <b>item_id</b> of a non-variation item or the\
        \ <b>item_id</b> values for both the parent and child of an item group.<br><br><span\
        \ class=\"tablenote\"><b>Note:</b> An item group is an item that has various\
        \ aspect differences, such as color, size, storage capacity, etc.</span></br>When\
        \ an item group is created, one of the item variations, such as the red shirt\
        \ size L, is chosen as the \"parent\". All other items in the group are the\
        \ children, such as the blue shirt size L, red shirt size M, etc.<br><br>The\
        \ <b>fieldgroups</b> URI parameter lets you control what is returned in the\
        \ response:<ul><li>Setting <b>fieldgroups</b> to <code>PRODUCT</code> adds\
        \ additional fields to the default response that return information about\
        \ the product of the item.</li><li>Setting the <b>fieldgroups</b> to <code>ADDITIONAL_SELLER_DETAILS</code>\
        \ adds an additional field to the response that returns the seller's user\
        \ ID.</li><li>Setting the <b>fieldgroups</b> to <code>CHARITY_DETAILS</code>\
        \ adds additional fields to the response that return charity information associated\
        \ with the item, if applicable.</li></ul>These <b>fieldgroups</b> can be used\
        \ independently or at the same time. For additional information, refer to\
        \ <a href=\"/api-docs/buy/browse/resources/item/methods/getItemByLegacyId#uri.fieldgroups\"\
        >fieldgroups</a>.<h3>Restrictions</h3>For a list of supported sites and other\
        \ restrictions, refer to <a href=\"/api-docs/buy/browse/overview.html#API\"\
        >API Restrictions</a>.<br><br><span class=\"tablenote\"><b>eBay Partner Network:</b>\
        \ In order to be commissioned for your sales, you must use the URL returned\
        \ in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the\
        \ ebay.com site.</span>"
      operationId: "getItemByLegacyId"
      parameters:
      - name: "fieldgroups"
        in: "query"
        description: "This field controls what is returned in the response. If this\
          \ field is not set, the method returns all details about the item. Multiple\
          \ <code>fieldgroups</code> can be set.<br><br><b>Valid Values:</b><ul><li>\
          \ <b>PRODUCT</b><br>This field group adds the <a href=\"/api-docs/buy/browse/resources/item/methods/getItemByLegacyId#response.product\"\
          >product</a> container to the response. </li><li><b>ADDITIONAL_SELLER_DETAILS</b><br>This\
          \ field group adds the <a href=\"/api-docs/buy/browse/resources/item/methods/getItemByLegacyId#response.seller.userId\"\
          >userId</a> field to the response.</li><li><b>CHARITY_DETAILS</b><br>This\
          \ field group adds the the <a href=\"/api-docs/buy/browse/resources/item/methods/getItemByLegacyId#response.charityTerms\"\
          >charityTerms</a> container to the response, if applicable.</li></ul>"
        required: false
        schema:
          type: "string"
      - name: "legacy_item_id"
        in: "query"
        description: "This query parameter is the unique identifier that specifies\
          \ the item being retrieved.<br><br><span class=\"tablenote\"><b> Note:</b>\
          \ When passing in the ID for a multi-variation listing, you must also use\
          \ the <code>legacy_variation_id</code> field and pass in the ID of the specific\
          \ item variation. If not, all variation within the multi-SKU listing will\
          \ be retrieved.</span></li></ul><br>The following is an example of using\
          \ the value of the <b>ItemID</b> field for a specific item to get the RESTful\
          \ <code>itemId</code> value.<pre><code>browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9</code></pre>"
        required: true
        schema:
          type: "string"
      - name: "legacy_variation_id"
        in: "query"
        description: "This query parameter specifies the legacy item ID of a specific\
          \ item in a multi-variation listing, such as that for the <i>red shirt size\
          \ L</i> item.<br><br><div class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\"\
          \ data-mc-autonum=\"&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot;\
          \ class=&quot;mcFormatColor&quot;&gt;Important! &lt;/span&gt;&lt;/b&gt;\"\
          ><span class=\"autonumber\"><span><b><span style=\"color: #dd1e31;\" class=\"\
          mcFormatColor\">Important!</span></b></span></span> A <code>legacy_item_id</code>\
          \ value must always be passed in when specifying a <code>legacy_variation_id</code>\
          \ value.</p></div>"
        required: false
        schema:
          type: "string"
      - name: "legacy_variation_sku"
        in: "query"
        description: "This query parameter specifies the legacy SKU of an item. SKUs\
          \ are the unique identifiers of an item created by the seller.<br><br>The\
          \ following is an example of using the value of the <code>ItemID</code>\
          \ and <code>SKU</code> fields to get the RESTful <code>itemId</code> value.<pre><code>browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9&amp;legacy_variation_sku=V**********M</code></pre><div\
          \ class=\"msgbox_important\"><p class=\"msgbox_importantInDiv\" data-mc-autonum=\"\
          &lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot; class=&quot;mcFormatColor&quot;&gt;Important!\
          \ &lt;/span&gt;&lt;/b&gt;\"><span class=\"autonumber\"><span><b><span style=\"\
          color: #dd1e31;\" class=\"mcFormatColor\">Important!</span></b></span></span>\
          \ A <code>legacy_item_id</code> value must always be passed in when specifying\
          \ a <code>legacy_variation_sku</code> value.</p></div>"
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-ENDUSERCTX"
        in: "header"
        description: "This header is can be used in following two situations:<br><ul><li>To\
          \ retrieve the <b>itemAffiliateWebUrl</b> field in the response, the ePN\
          \ affiliate can pass in their affiliate credentials using this header. For\
          \ more information, see <a href=\"/api-docs/buy/static/api-browse.html#affiliate-header\"\
          \ target=\"_blank \">Header for affiliate information.</a></li><li>If the\
          \ listing is using calculated or flat-rate shipping with shipping rate tables,\
          \ the user can use this header to provide country and postal code in order\
          \ for the <b>shippingOption</b> container, which includes shipping costs\
          \ and delivery estimates, to be returned. For more information, see <a href=\"\
          /api-docs/buy/static/api-browse.html#X-EBAY-C-ENDUSERCTX-context\" target=\"\
          _blank \">Header for shipping information accuracy.</a></li></ul>"
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-MARKETPLACE-ID"
        in: "header"
        description: "This header identifies the seller's eBay marketplace. It is\
          \ required for all marketplaces outside of the US.<br><br><span class=\"\
          tablenote\"><b>Note:</b> If the marketplace ID value is invalid or missing,\
          \ the default value of <code>EBAY_US</code> is used.</span><br>See <a href=\"\
          /api-docs/buy/browse/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a>\
          \ for a list of supported marketplaces.<br><br><b>Default:</b> <code>EBAY_US</code>"
        required: false
        schema:
          type: "string"
      - name: "Accept-Language"
        in: "header"
        description: "This header is used to indicate the natural language and locale\
          \ preferred by the user for the response.<br><br>This header is required\
          \ when targeting a specific locale of a marketplace that supports multiple\
          \ locales. For example:<ul><li>When targeting the French locale of the Belgium\
          \ marketplace, it is required to pass in <code>fr-BE</code> to specify this.\
          \ If this locale is not specified, the language will default to Dutch.</li><li>When\
          \ targeting the French locale of the Canadian marketplace, it is required\
          \ to pass in <code>fr-CA</code> to specify this. If this locale is not specified,\
          \ the language will default to English.</li></ul>"
        required: false
        schema:
          type: "string"
      - name: "quantity_for_shipping_estimate"
        in: "query"
        description: "This query parameter sets the item quantity to be used when\
          \ calculating the shipping estimate information returned in the <a href=\"\
          /api-docs/buy/browse/resources/item/methods/getItemByLegacyId#response.shippingOptions\"\
          >shippingOptions</a> container of the response.<br><br>This value must be\
          \ a positive integer value and should not exceed the quantity available\
          \ in the listing. This field is not recommended for auction listings, as\
          \ they will always have a quantity of 1."
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Item"
          x-response-codes:
            errors:
              11508:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "This seller is currently away. If you make a purchase,\
                  \ please allow additional time for your order to be processed."
              11509:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "This seller is currently away until {sellerReturnDate}.\
                  \ If you make a purchase, please allow additional time for your\
                  \ order to be processed."
              11510:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem calculating the shipping cost. Please\
                  \ try again."
              11502:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem extracting product information for\
                  \ this Item. Please try again."
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              11009:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The legacy variation sku is invalid."
              11010:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "You cannot submit legacy_variation_sku and legacy_variation_id\
                  \ in the same request. For help, see the documentation."
              11011:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The marketplace value {marketplaceId} is not supported.\
                  \ The supported values are: {allowedMarketplaces}"
              11003:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified legacy item ID was not found."
              11019:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The quantity_for_shipping_estimate value {quantityForShippingEstimate}\
                  \ is invalid. Please enter a positive value."
              11004:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item is not available for purchase. This can be\
                  \ for many reasons, such as when the listing is being updated by\
                  \ the seller. Wait a few minutes and try the call again."
              11501:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'fieldgroups' value(s) are invalid: {fieldgroups}.\
                  \ The supported fieldgroups are: {supportedFieldgroups}"
              11006:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The legacy ID is invalid. Use {itemGroupHref} to get\
                  \ the item group details."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              11000:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not Found"
        "409":
          description: "Conflict"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope"
  /item/:
    get:
      tags:
      - "item"
      description: "This method retrieves the details about specific items that buyers\
        \ need to make a purchasing decision.<br><br><span class=\"tablenote\"><b>Note:</b>\
        \ This is a <a href=\"/api-docs/static/versioning.html#limited \" target=\"\
        _blank\"><img src=\"/cms/img/docs/partners-api.svg\" class=\"legend-icon partners-icon\"\
        \ title=\"Limited Release\"  alt=\"Limited Release\" />(Limited Release)</a>\
        \ available only to select Partners.<br><br>For this method, only the following\
        \ fields are returned: <code>bidCount</code>, <code>currentBidPrice</code>,\
        \ <code>eligibleForInlineCheckout</code>, <code>enabledForGuestCheckout</code>,\
        \ <code>estimatedAvailabilities</code>, <code>gtin</code>, <code>immediatePay</code>,\
        \ <code>itemAffiliateWebUrl</code>, <code>itemCreationDate</code>, <code>itemEndDate</code>,\
        \ <code>itemId</code>, <code>itemWebUrl</code>, <code>legacyItemId</code>,\
        \ <code>minimumPriceToBid</code>, <code>price</code>, <code>priorityListing</code>,\
        \ <code>reservePriceMet</code>, <code>sellerItemRevision</code>, <code>taxes</code>,\
        \ <code>topRatedBuyingExperience</code>, and <code>uniqueBidderCount</code>.<br><br>The\
        \ array <code>shippingOptions</code>, which comprises multiple fields, is\
        \ also returned if the <b>X-EBAY-C-ENDUSERCTX</b> header is supplied.</span><h3>Restrictions</h3>For\
        \ a list of supported sites and other restrictions, refer to <a href=\"/api-docs/buy/browse/overview.html#API\"\
        >API Restrictions</a>.<br><br><span class=\"tablenote\"><b>eBay Partner Network:</b>\
        \ In order to be commissioned for your sales, you must use the URL returned\
        \ in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site."
      operationId: "getItems"
      parameters:
      - name: "item_ids"
        in: "query"
        description: "A comma separated list of the unique identifiers of the items\
          \ to retrieve (maximum 20).<br><br><span class=\"tablenote\"><b>Note:</b>\
          \ In any given request, either <code>item_ids</code> <b>or</b> <code>item_group_ids</code>\
          \ can be retrieved. Attempting to retrieve both will result in an error.</span><br><b>RESTful\
          \ Item ID Format: </b><code>v1</code>|<code><i>#</i></code>|<code><i>#</i></code><br><br>For\
          \ a single SKU listing, pass in the item ID: <pre>v1|2**********2|0</pre>For\
          \ a multi-SKU listing, pass in the identifier of the variation:<pre>v1|1**********2|4**********2</pre><br>For\
          \ more information about item IDs for RESTful APIs, refer to <a href=\"\
          /api-docs/buy/static/api-browse.html#Legacy\" target=\"_blank\">Item ID\
          \ legacy API compatibility overview</a> in the <a href=\"/api-docs/buy/static/buying-ig-landing.html\"\
          \ target=\"_blank\">Buying Integration Guide</a>."
        required: false
        schema:
          type: "string"
      - name: "item_group_ids"
        in: "query"
        description: "A comma separated list of the unique identifiers of the item\
          \ groups being retrieved (maximum 10).<br><br><span class=\"tablenote\"\
          ><b>Note:</b> In any given request, either <code>item_ids</code> <b>or</b>\
          \ <code>item_group_ids</code> can be retrieved. Attempting to retrieve both\
          \ will result in an error.</span><br><b>RESTful Group Item ID Format:</b>\
          \ <code>############</code><br><br>For example:<pre>3**********9</pre>"
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-ENDUSERCTX"
        in: "header"
        description: "This header is can be used in following two situations:<br><ul><li>To\
          \ retrieve the <b>itemAffiliateWebUrl</b> field in the response, the ePN\
          \ affiliate can pass in their affiliate credentials using this header. For\
          \ more information, see <a href=\"/api-docs/buy/static/api-browse.html#affiliate-header\"\
          \ target=\"_blank \">Header for affiliate information.</a></li><li>If the\
          \ listing is using calculated or flat-rate shipping with shipping rate tables,\
          \ the user can use this header to provide country and postal code in order\
          \ for the <b>shippingOption</b> container, which includes shipping costs\
          \ and delivery estimates, to be returned. For more information, see <a href=\"\
          /api-docs/buy/static/api-browse.html#X-EBAY-C-ENDUSERCTX-context\" target=\"\
          _blank \">Header for shipping information accuracy.</a></li></ul>"
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-MARKETPLACE-ID"
        in: "header"
        description: "This header identifies the seller's eBay marketplace. It is\
          \ required for all marketplaces outside of the US.<br><br><span class=\"\
          tablenote\"><b>Note:</b> If the marketplace ID value is invalid or missing,\
          \ the default value of <code>EBAY_US</code> is used.</span><br>See <a href=\"\
          /api-docs/buy/browse/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a>\
          \ for a list of supported marketplaces.<br><br><b>Default:</b> <code>EBAY_US</code>"
        required: false
        schema:
          type: "string"
      - name: "Accept-Language"
        in: "header"
        description: "This header is used to indicate the natural language and locale\
          \ preferred by the user for the response.<br><br>This header is required\
          \ when targeting a specific locale of a marketplace that supports multiple\
          \ locales. For example:<ul><li>When targeting the French locale of the Belgium\
          \ marketplace, it is required to pass in <code>fr-BE</code> to specify this.\
          \ If this locale is not specified, the language will default to Dutch.</li><li>When\
          \ targeting the French locale of the Canadian marketplace, it is required\
          \ to pass in <code>fr-CA</code> to specify this. If this locale is not specified,\
          \ the language will default to English.</li></ul>"
        required: false
        schema:
          type: "string"
      - name: "quantity_for_shipping_estimate"
        in: "query"
        description: "This query parameter sets the item quantity to be used when\
          \ calculating the shipping estimate information returned in the <a href=\"\
          /api-docs/buy/browse/resources/item/methods/getItems#response.items.shippingOptions\"\
          >shippingOptions</a> container of the response.<br><br>This value must be\
          \ a positive integer value and should not exceed the quantity available\
          \ in the listing. This field is not recommended for auction listings, as\
          \ they will always have a quantity of 1."
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Items"
          x-response-codes:
            errors:
              11508:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "This seller is currently away. If you make a purchase,\
                  \ please allow additional time for your order to be processed."
              11509:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "This seller is currently away until {sellerReturnDate}.\
                  \ If you make a purchase, please allow additional time for your\
                  \ order to be processed."
              11510:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem calculating the shipping cost. Please\
                  \ try again."
              11502:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem extracting product information for\
                  \ this item. Please try again."
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              11008:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item group is not available. This can be for many\
                  \ reasons, such as when the listing is being updated by the seller.\
                  \ Wait a few minutes and try the call again."
              11011:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The marketplace value {marketplaceId} is not supported.\
                  \ The supported values are: {allowedMarketplaces}"
              11012:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified item IDs are invalid, or the format of\
                  \ the specified values are invalid."
              11013:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified group IDs are invalid, or the format of\
                  \ the specified values are invalid."
              11014:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "An item_ids and an item_group_ids list cannot be used\
                  \ at same time. Please use only one of these lists."
              11015:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The maximum number of item IDs has been exceeded. Please\
                  \ reduce the number of item IDs to {maxAllowedItemIds} or less."
              11016:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The maximum number of item group IDs has been exceeded.\
                  \ Please reduce the number of item group ids to {maxAllowedItemGroupIds}\
                  \ or less."
              11017:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "An item_ids or an item_group_ids list is required. Please\
                  \ use one of these lists."
              11019:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The quantity_for_shipping_estimate value {quantityForShippingEstimate}\
                  \ is invalid. Please enter a positive value."
              11001:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified item ID was not found."
              11002:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified item group was not found."
              11004:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item group is not available. This can be for many\
                  \ reasons, such as when the listing is being updated by the seller.\
                  \ Wait a few minutes and try the call again."
              11005:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item group ID is invalid. Use {itemHref} to get\
                  \ the item details."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              11000:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not Found"
        "409":
          description: "Conflict"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope/buy.item.bulk"
  /item/get_items_by_item_group:
    get:
      tags:
      - "item"
      description: "This method retrieves details about individual items in an item\
        \ group. An item group is an item that has various aspect differences, such\
        \ as color, size, storage capacity, etc.<br><br>You pass in the <b>item_group_id</b>\
        \ as a URI parameter.<br><br>This method returns two main containers:<ul><li><b>items</b><br>This\
        \ container has an array of containers with the details about each item in\
        \ the group.</li><li><b>commonDescriptions</b><br>This container has an array\
        \ of containers for a description and the <code>item_ids</code> for all items\
        \ that have this exact description. Because items within an item group often\
        \ have the same description, this decreases the size of the response.</li></ul>Setting\
        \ the <b>fieldgroup</b> to <code>ADDITIONAL_SELLER_DETAILS</code> adds an\
        \ additional field to the response that returns the seller's user ID. Setting\
        \ the <b>fieldgroup</b> to <code>CHARITY_DETAILS</code> adds additional fields\
        \ to the response that returns charity information associated with the item,\
        \ if applicable. For more information, refer to <a href=\"/api-docs/buy/browse/resources/item/methods/getItemsByItemGroup#uri.fieldgroups\"\
        >fieldgroups</a>.<h3>Restrictions</h3>For a list of supported sites and other\
        \ restrictions, refer to <a href=\"/api-docs/buy/browse/overview.html#API\"\
        >API Restrictions</a>.<br><br><span class=\"tablenote\"><b>eBay Partner Network:\
        \ </b> In order to be commissioned for your sales, you must use the URL returned\
        \ in the <code>itemAffiliateWebUrl</code> field to forward your buyer to the\
        \ ebay.com site.</span>"
      operationId: "getItemsByItemGroup"
      parameters:
      - name: "fieldgroups"
        in: "query"
        description: "This field controls what is returned in the response. If this\
          \ field is not set, the method returns all details about the item.<br><br><b>Valid\
          \ Values:</b><br><br><b>ADDITIONAL_SELLER_DETAILS</b> - This field group\
          \ adds the <a href=\"/api-docs/buy/browse/resources/item/methods/getItemsByItemGroup#response.items.seller.userId\"\
          >userId</a> field to the response.<br><br><b>CHARITY_DETAILS</b> - This\
          \ field group adds the the <a href=\"/api-docs/buy/browse/resources/item/methods/getItemsByItemGroup#response.items.charityTerms\"\
          >charityTerms</a> container to the response, if applicable.</li></ul>"
        required: false
        schema:
          type: "string"
      - name: "item_group_id"
        in: "query"
        description: "This query parameter specifies the unique identifier of an item\
          \ group for which information is to be returned. An item group is an item\
          \ that has various aspect differences, such as color, size, storage capacity,\
          \ etc.<br><br>This ID is returned in the <b>itemGroupHref</b> field of the\
          \ <a href=\"/api-docs/buy/browse/resources/item_summary/methods/search\"\
          >search</a> and <a href=\"/api-docs/buy/browse/resources/item/methods/getItem\"\
          >getItem</a> methods.<br><br><b>For Example:</b><pre>https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?item_group_id=3**********6</pre>"
        required: true
        schema:
          type: "string"
      - name: "X-EBAY-C-ENDUSERCTX"
        in: "header"
        description: "This header is can be used in following two situations:<br><ul><li>To\
          \ retrieve the <b>itemAffiliateWebUrl</b> field in the response, the ePN\
          \ affiliate can pass in their affiliate credentials using this header. For\
          \ more information, see <a href=\"/api-docs/buy/static/api-browse.html#affiliate-header\"\
          \ target=\"_blank \">Header for affiliate information.</a></li><li>If the\
          \ listing is using calculated or flat-rate shipping with shipping rate tables,\
          \ the user can use this header to provide country and postal code in order\
          \ for the <b>shippingOption</b> container, which includes shipping costs\
          \ and delivery estimates, to be returned. For more information, see <a href=\"\
          /api-docs/buy/static/api-browse.html#X-EBAY-C-ENDUSERCTX-context\" target=\"\
          _blank \">Header for shipping information accuracy.</a></li></ul>"
        required: false
        schema:
          type: "string"
      - name: "X-EBAY-C-MARKETPLACE-ID"
        in: "header"
        description: "This header identifies the seller's eBay marketplace. It is\
          \ required for all marketplaces outside of the US.<br><br><span class=\"\
          tablenote\"><b>Note:</b> If the marketplace ID value is invalid or missing,\
          \ the default value of <code>EBAY_US</code> is used.</span><br>See <a href=\"\
          /api-docs/buy/browse/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a>\
          \ for a list of supported marketplaces.<br><br><b>Default:</b> <code>EBAY_US</code>"
        required: false
        schema:
          type: "string"
      - name: "Accept-Language"
        in: "header"
        description: "This header is used to indicate the natural language and locale\
          \ preferred by the user for the response.<br><br>This header is required\
          \ when targeting a specific locale of a marketplace that supports multiple\
          \ locales. For example:<ul><li>When targeting the French locale of the Belgium\
          \ marketplace, it is required to pass in <code>fr-BE</code> to specify this.\
          \ If this locale is not specified, the language will default to Dutch.</li><li>When\
          \ targeting the French locale of the Canadian marketplace, it is required\
          \ to pass in <code>fr-CA</code> to specify this. If this locale is not specified,\
          \ the language will default to English.</li></ul>"
        required: false
        schema:
          type: "string"
      - name: "quantity_for_shipping_estimate"
        in: "query"
        description: "This query parameter sets the item quantity to be used when\
          \ calculating the shipping estimate information returned in the <a href=\"\
          /api-docs/buy/browse/resources/item/methods/getItemsByItemGroup#response.items.shippingOptions\"\
          >shippingOptions</a> container of the response.<br><br>This value must be\
          \ a positive integer value and should not exceed the quantity available\
          \ in the listing. This field is not recommended for auction listings, as\
          \ they will always have a quantity of 1."
        required: false
        schema:
          type: "string"
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ItemGroup"
          x-response-codes:
            errors:
              11508:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "This seller is currently away. If you make a purchase,\
                  \ please allow additional time for your order to be processed."
              11509:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "This seller is currently away until {sellerReturnDate}.\
                  \ If you make a purchase, please allow additional time for your\
                  \ order to be processed."
              11510:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem calculating the shipping cost. Please\
                  \ try again."
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              11008:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item group is not available. This can be for many\
                  \ reasons, such as when the listing is being updated by the seller.\
                  \ Wait a few minutes and try the call again."
              11011:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The marketplace value {marketplaceId} is not supported.\
                  \ The supported values are: {allowedMarketplaces}"
              11002:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified item group was not found."
              11019:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The quantity_for_shipping_estimate value {quantityForShippingEstimate}\
                  \ is invalid. Please enter a positive value."
              11005:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "Item Group Id is invalid. Use {itemHref} to get the\
                  \ item details."
              11501:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'fieldgroups' value(s) are invalid: {fieldgroups}.\
                  \ The supported fieldgroups are: {supportedFieldgroups}"
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              11000:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not Found"
        "409":
          description: "Conflict"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope"
  /item/{item_id}/check_compatibility:
    post:
      tags:
      - "item"
      description: "This method checks if a product is compatible with the specified\
        \ item. You can use this method to check the compatibility of cars, trucks,\
        \ and motorcycles with a specific part listed on eBay.<br><br>For example,\
        \ to check the compatibility of a part, you pass in the <b>item_id</b> of\
        \ the part as a URI parameter and specify all the attributes used to define\
        \ a specific car within the <b>compatibilityProperties</b> container. If the\
        \ call is successful, the response will be <code>COMPATIBLE</code>, <code>NOT_COMPATIBLE</code>,\
        \ or <code>UNDETERMINED</code>. Refer to <a href=\"/api-docs/buy/browse/resources/item/methods/checkCompatibility#response.compatibilityStatus\"\
        >compatibilityStatus</a> for details.   <br><br><span class=\"tablenote\"\
        ><b>Note:</b> The only products supported are cars, trucks, and motorcycles.</span><br>To\
        \ find the attributes and values for a specific marketplace, you can use the\
        \ compatibility methods in the <a href=\"/api-docs/commerce/taxonomy/resources/methods\"\
        \ target=\"_blank\">Taxonomy API</a>. You can use this data to create menus\
        \ to help buyers specify the product, such as their car.<br><br>For more information\
        \ and a list of required attributes for the US marketplace that describe motor\
        \ vehicles, refer to <a href=\"/api-docs/buy/static/api-browse.html#Check\"\
        \ target=\"_blank\">Check compatibility</a> in the <i>Buying Integration Guide</i>.<br><br>For\
        \ an example, refer to the <a href=\"/api-docs/buy/browse/resources/item/methods/checkCompatibility#h2-samples\"\
        >Samples</a> section.<br><br><span class=\"tablenote\"><b>Note:</b> This method\
        \ is supported in Sandbox but <i>only</i> when passing in the specified <code>item_id</code>\
        \ and compatibility name-value pairs listed in <a href=\"/api-docs/buy/browse/resources/item/methods/checkCompatibility#s0-1-22-6-7-7-6-SandboxSample-1\"\
        >Sample 2: Sandbox Sample</a>.</span><h3>Restrictions</h3>For a list of supported\
        \ sites and other restrictions, refer to <a href=\"/api-docs/buy/browse/overview.html#API\"\
        >API Restrictions</a>."
      operationId: "checkCompatibility"
      parameters:
      - name: "item_id"
        in: "path"
        description: "This path parameter specifies the unique RESTful identifier\
          \ of an item (such as the park you want to check).<br><br><b>RESTful Item\
          \ ID Format: </b><code>v1</code>|<code><i>#</i></code>|<code><i>#</i></code><br><br>For\
          \ a single SKU listing, pass in the item ID: <pre>v1|2**********2|0</pre>For\
          \ a multi-SKU listing, pass in the identifier of the variation:<pre>v1|1**********2|4**********2</pre><br>For\
          \ more information about item IDs for RESTful APIs, refer to <a href=\"\
          /api-docs/buy/static/api-browse.html#Legacy\" target=\"_blank\">Item ID\
          \ legacy API compatibility overview</a> in the <a href=\"/api-docs/buy/static/buying-ig-landing.html\"\
          \ target=\"_blank\">Buying Integration Guide</a>."
        required: true
        schema:
          type: "string"
      - name: "X-EBAY-C-MARKETPLACE-ID"
        in: "header"
        description: "This header identifies the seller's eBay marketplace. It is\
          \ required for all marketplaces outside of the US.<br><br><span class=\"\
          tablenote\"><b>Note:</b> If the marketplace ID value is invalid or missing,\
          \ the default value of <code>EBAY_US</code> is used.</span><br>See <a href=\"\
          /api-docs/buy/browse/types/ba:MarketplaceIdEnum\" target=\"_blank\">MarketplaceIdEnum</a>\
          \ for a list of supported marketplaces.<br><br><b>Default:</b> <code>EBAY_US</code>"
        required: false
        schema:
          type: "string"
      - name: "Content-Type"
        in: "header"
        description: "This header indicates the format of the request body provided\
          \ by the client.<br><br>Its value should be set to <code>application/json</code>.<br><br>For\
          \ more information, refer to <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
          \ target=\"_blank \">HTTP request headers</a> in the <a href=\"/api-docs/static/ebay-rest-landing.html\"\
          \ target=\"_blank\">Using eBay RESTful APIs</a> guide."
        required: true
        schema:
          type: "string"
      - name: "Accept-Language"
        in: "header"
        description: "This header is used to indicate the natural language and locale\
          \ preferred by the user for the response.<br><br>This header is required\
          \ when targeting a specific locale of a marketplace that supports multiple\
          \ locales. For example:<ul><li>When targeting the French locale of the Belgium\
          \ marketplace, it is required to pass in <code>fr-BE</code> to specify this.\
          \ If this locale is not specified, the language will default to Dutch.</li><li>When\
          \ targeting the French locale of the Canadian marketplace, it is required\
          \ to pass in <code>fr-CA</code> to specify this. If this locale is not specified,\
          \ the language will default to English.</li></ul>"
        required: false
        schema:
          type: "string"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CompatibilityPayload"
        required: false
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CompatibilityResponse"
          x-response-codes:
            errors:
              11504:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The following compatibilityProperties (attributes name/value\
                  \ pairs) are missing: {attributes}"
        "400":
          description: "Bad Request"
          x-response-codes:
            errors:
              11505:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The item is not valid for compatibility validation."
              11506:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The 'name' {compatibilityNames} appears more than once\
                  \ in the request."
              11011:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The marketplace value {marketplaceId} is not supported.\
                  \ The supported values are: {allowedMarketplaces}"
              11507:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The following name(s) in the request are not supported\
                  \ {attributes}."
              11001:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The specified item ID was not found."
              11503:
                domain: "API_BROWSE"
                category: "REQUEST"
                description: "The request is either empty or incomplete. For help,\
                  \ see the documentation for this call."
        "500":
          description: "Internal Server Error"
          x-response-codes:
            errors:
              11000:
                domain: "API_BROWSE"
                category: "APPLICATION"
                description: "There was a problem with an eBay internal system or\
                  \ process. Contact eBay developer support for assistance."
        "404":
          description: "Not Found"
        "409":
          description: "Conflict"
      security:
      - api_auth:
        - "https://api.ebay.com/oauth/api_scope"
components:
  schemas:
    AdditionalProductIdentity:
      type: "object"
      properties:
        productIdentity:
          type: "array"
          description: "An array of product identifier/value pairs for the product\
            \ associated with the item. This is returned if the seller has associated\
            \ the eBay Product Identifier (ePID) with the item and the request has\
            \ <code>fieldgroups</code> set to <code>PRODUCT</code>.<br><br>The following\
            \ table shows what is returned, based on the item information provided\
            \ by the seller, when <code>fieldgroups</code> is set to <code>PRODUCT</code>.<br><br><div\
            \ style=\"overflow-x:auto;\"><table border=1><tr><th>ePID Provided</th><th>Product\
            \ ID(s) Provided</th><th>Response</th></tr><tr><td>No</td><td>No</td><td>The\
            \ <code>AdditionalProductIdentity</code> container is <i>not</i> returned.</td></tr><tr><td>No</td><td>Yes</td><td>The\
            \ <code>AdditionalProductIdentity</code> container is <i>not</i> returned\
            \ but the product identifiers specified by the seller are returned in\
            \ the <code>localizedAspects</code> container.</td></tr><tr><td>Yes</td><td>No</td><td>The\
            \ <code>AdditionalProductIdentity</code> container is returned listing\
            \ the product identifiers of the product.</td></tr><tr><td>Yes</td><td>Yes</td><td>The\
            \ <code>AdditionalProductIdentity</code> container is returned listing\
            \ all the product identifiers of the product and the product identifiers\
            \ specified by the seller are returned in the <code>localizedAspects</code>\
            \ container.</td></tr></table></div>"
          items:
            $ref: "#/components/schemas/ProductIdentity"
      description: "The type that defines the array of product identifiers associated\
        \ with the item. This container is returned if the seller has associated the\
        \ eBay Product Identifier (ePID) with the item, and in the request <code>fieldgroups</code>\
        \ is set to <code>PRODUCT</code>."
    AddonService:
      type: "object"
      properties:
        selection:
          type: "string"
          description: "This field indicates whether the add-on service must be selected\
            \ for the item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:AddonServiceSelectionEnum'>eBay\
            \ API documentation</a>"
        serviceFee:
          description: "The amount charged for the add-on service."
          $ref: "#/components/schemas/ConvertedAmount"
        serviceId:
          type: "string"
          description: "The ID number of the add-on service."
        serviceType:
          type: "string"
          description: "The type of add-on service, such as <code>AUTHENTICITY_GUARANTEE</code>.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:AddonServiceTypeEnum'>eBay\
            \ API documentation</a>"
      description: "This container describes an add-on service that may be selected\
        \ for an item or that may apply automatically. A charge may be associated\
        \ with the add-on service."
    Address:
      type: "object"
      properties:
        addressLine1:
          type: "string"
          description: "The first line of the street address.<br><br><span class=\"\
            tablenote\"><b>Note:</b> This is conditionally returned in the <code>itemLocation</code>\
            \ field.</span>"
        addressLine2:
          type: "string"
          description: "The second line of the street address. This field is not always\
            \ used, but can be used for \"Suite Number\" or \"Apt Number\"."
        city:
          type: "string"
          description: "The city of the address."
        country:
          type: "string"
          description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
            \ \" target=\"_blank\">ISO 3166</a> standard code for the country of the\
            \ address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay\
            \ API documentation</a>"
        county:
          type: "string"
          description: "The county of the address."
        postalCode:
          type: "string"
          description: "The postal code (or zip code in US) code of the address. Sellers\
            \ set a postal code (or zip code in US) for items when they are listed.\
            \ The postal code is used for calculating proximity searches. It is anonymized\
            \ when returned in <code>itemLocation.postalCode</code> via the API."
        stateOrProvince:
          type: "string"
          description: "The state or province of the address.<br><br><span class=\"\
            tablenote\"><b>Note:</b> This is conditionally returned in the <code>itemLocation</code>\
            \ field.</span>"
      description: "The type that defines the fields for an address."
    Amount:
      type: "object"
      properties:
        currency:
          type: "string"
          description: "The list of valid currencies. Each <a href=\"https://www.iso.org/iso-4217-currency-codes.html\
            \ \" target=\"_blank\">ISO 4217</a> currency code includes the currency\
            \ name followed by the numeric value.<br><br>For example, the Canadian\
            \ Dollar code (CAD) would take the following form: <code>Canadian Dollar,\
            \ 124</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay\
            \ API documentation</a>"
        value:
          type: "string"
          description: "The value of the discounted amount."
    Aspect:
      type: "object"
      properties:
        localizedName:
          type: "string"
          description: "The text representing the name of the aspect for the name/value\
            \ pair, such as Brand."
        localizedValues:
          type: "array"
          description: "The text representing the value of the aspect for the name/value\
            \ pair, such as Apple."
          items:
            type: "string"
      description: "The type that defines the fields for the name/value pairs for\
        \ the aspects of the product. For example: BRAND/Apple"
    AspectDistribution:
      type: "object"
      properties:
        aspectValueDistributions:
          type: "array"
          description: "An array of containers for the various values of the aspect\
            \ and the match count, and a HATEOAS reference (<code>refinementHref</code>)\
            \ for this aspect."
          items:
            $ref: "#/components/schemas/AspectValueDistribution"
        localizedAspectName:
          type: "string"
          description: "The name of an aspect, such as <i>Brand</i>, <i>Color</i>,\
            \ etc."
      description: "The type that define the fields for the aspect information. Aspects\
        \ are the variations of an item, such as color, size, etc."
    AspectGroup:
      type: "object"
      properties:
        aspects:
          type: "array"
          description: "An array of the name/value pairs for the aspects of the product.\
            \ For example: BRAND/Apple"
          items:
            $ref: "#/components/schemas/Aspect"
        localizedGroupName:
          type: "string"
          description: "The name of a group of aspects.<br><br>In the following example,\
            \ <b>Product Identifiers</b> and <b>Process</b> are product aspect group\
            \ names. Under the group name are the product aspect name/value pairs.<br><br><b>Product\
            \ Identifiers</b><br>&nbsp;&nbsp;&nbsp;Brand/Apple<br>&nbsp;&nbsp;&nbsp;Product\
            \ Family/iMac<br><br><b>Processor</b><br>&nbsp;&nbsp;&nbsp;Processor Type/Intel<br>&nbsp;&nbsp;&nbsp;Processor\
            \ Speed/3.10"
    AspectValueDistribution:
      type: "object"
      properties:
        localizedAspectValue:
          type: "string"
          description: "The value of an aspect. For example, Red is a value for the\
            \ aspect Color."
        matchCount:
          type: "integer"
          description: "The number of items with this aspect."
          format: "int32"
        refinementHref:
          type: "string"
          description: "A HATEOAS reference for this aspect."
      description: "The container that defines the fields for the conditions refinements.\
        \ This container is returned when <code>fieldgroups</code> is set to <code>ASPECT_REFINEMENTS</code>\
        \ or <code>FULL</code> in the request."
    AttributeNameValue:
      type: "object"
      properties:
        name:
          type: "string"
          description: "The name of the product attribute, such as <i>Make</i>, <i>Model</i>,\
            \ <i>Year</i>, etc."
        value:
          type: "string"
          description: "The value for the <code>name</code> attribute, such as <i>BMW</i>,\
            \ <i>R1200GS</i>, <i>2011</i>, etc."
      description: "The type the defines attribute name/value pair fields that specify\
        \ a product. The type of data depends on the context. For example, if you\
        \ were using this to specify a specific vehicle, the attribute names would\
        \ be <i>Make</i>, <i>Model</i>, <i>Year</i>, etc."
    AuthenticityGuaranteeProgram:
      type: "object"
      properties:
        description:
          type: "string"
          description: "An indication that the item is qualified for the Authenticity\
            \ Guarantee program."
        termsWebUrl:
          type: "string"
          description: "The URL to the Authenticity Guarantee program terms of use."
      description: "A type that identifies whether the item is qualified for the Authenticity\
        \ Guarantee program."
    AuthenticityVerificationProgram:
      type: "object"
      properties:
        description:
          type: "string"
          description: "An indication that the item is from a verified seller."
        termsWebUrl:
          type: "string"
          description: "The URL to the Authenticity Verification program terms of\
            \ use."
      description: "A type that identifies whether the item is from a verified seller."
    AutoCorrections:
      type: "object"
      properties:
        q:
          type: "string"
          description: "The automatically spell-corrected keyword from the request."
    AvailableCoupon:
      type: "object"
      properties:
        constraint:
          description: "The limitations or restrictions of the coupon."
          $ref: "#/components/schemas/CouponConstraint"
        discountAmount:
          description: "The discount amount after the coupon is applied."
          $ref: "#/components/schemas/Amount"
        discountType:
          type: "string"
          description: "The type of discount that the coupon applies. For implementation\
            \ help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:CouponDiscountType'>eBay\
            \ API documentation</a>"
        message:
          type: "string"
          description: "A description of the coupon.<br><br><span class=\"tablenote\"\
            ><b>Note:</b> The value returned in the <code>termsWebUrl</code> field\
            \ should appear for all experiences when displaying coupons. The value\
            \ in the <code>availableCoupons.message</code> field must also be included\
            \ if returned in the API response.</span>"
        redemptionCode:
          type: "string"
          description: "The coupon code."
        termsWebUrl:
          type: "string"
          description: "The URL to the coupon terms of use.<br><br><span class=\"\
            tablenote\"><b>Note:</b> The value returned in the <code>termsWebUrl</code>\
            \ field should appear for all experiences when displaying coupons. The\
            \ value in the <code>availableCoupons.message</code> field must also be\
            \ included if returned in the API response.</span>"
    BuyingOptionDistribution:
      type: "object"
      properties:
        buyingOption:
          type: "string"
          description: "The container that returns the buying option type. This will\
            \ be AUCTION, FIXED_PRICE, CLASSIFIED_AD, or a combination of these options.\
            \ For details, see <a href=\"/api-docs/buy/browse/resources/item_summary/methods/search#response.itemSummaries.buyingOptions\"\
            >buyingOptions</a>."
        matchCount:
          type: "integer"
          description: "The number of items having this buying option."
          format: "int32"
        refinementHref:
          type: "string"
          description: "The HATEOAS reference for this buying option."
      description: "The container that defines the fields for the buying options refinements.\
        \ This container is returned when <code>fieldgroups</code> is set to <code>BUYING_OPTION_REFINEMENTS</code>\
        \ or <code>FULL</code> in the request."
    Category:
      type: "object"
      properties:
        categoryId:
          type: "string"
          description: "The unique identifier of the category."
        categoryName:
          type: "string"
          description: "The name of the category."
      description: "This type is used by the <code>categories</code> container in\
        \ the response of the <b>search</b>  method, and contains the name and ID\
        \ of the item category."
    CategoryDistribution:
      type: "object"
      properties:
        categoryId:
          type: "string"
          description: "The unique identifier of the category."
        categoryName:
          type: "string"
          description: "The name of the category, such as <b>Baby &amp; Toddler Clothing</b>."
        matchCount:
          type: "integer"
          description: "The number of items in this category."
          format: "int32"
        refinementHref:
          type: "string"
          description: "The HATEOAS reference of this category."
      description: "The container that defines the fields for the category refinements.\
        \ This container is returned when <code>fieldgroups</code> is set to <code>CATEGORY_REFINEMENTS</code>\
        \ or <code>FULL</code> in the request."
    CommonDescriptions:
      type: "object"
      properties:
        description:
          type: "string"
          description: "The item description that is used by more than one of the\
            \ item variations."
        itemIds:
          type: "array"
          description: "A list of item ids that have this description."
          items:
            type: "string"
      description: "The type that defines the fields for the <code>item_id</code>\
        \ values that all use a common description. Often the item variations within\
        \ an item group all have the same description. Instead of repeating this description\
        \ in the item details of each item, a description that is shared by at least\
        \ one other item is returned in this container. If the description is unique,\
        \ it is returned in the <code>items.description</code> field."
    CompanyAddress:
      type: "object"
      properties:
        addressLine1:
          type: "string"
          description: "The first line of the product manufacturer's street address."
        addressLine2:
          type: "string"
          description: "The second line of the product manufacturer's street address.\
            \ This field is not always used, but can be used for secondary address\
            \ information such as 'Suite Number' or 'Apt Number'."
        city:
          type: "string"
          description: "The city of the product manufacturer's street address."
        companyName:
          type: "string"
          description: "The company name of the product manufacturer."
        contactUrl:
          type: "string"
          description: "The contact URL of the product manufacturer."
        country:
          type: "string"
          description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
            \ \" target=\"_blank\">ISO 3166</a> standard code for the country of the\
            \ address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay\
            \ API documentation</a>"
        countryName:
          type: "string"
          description: "The country name of the product manufacturer's street address."
        county:
          type: "string"
          description: "The county of the product manufacturer's street address."
        email:
          type: "string"
          description: "The product manufacturer's business email address."
        phone:
          type: "string"
          description: "The product manufacturer's business phone number."
        postalCode:
          type: "string"
          description: "The postal code of the product manufacturer's street address."
        stateOrProvince:
          type: "string"
          description: "The state or province of the product manufacturer's street\
            \ address."
      description: "This type is used to provide contact information for the manufacturer\
        \ of the product."
    CompatibilityPayload:
      type: "object"
      properties:
        compatibilityProperties:
          type: "array"
          description: "An array of attribute name/value pairs used to define a specific\
            \ product. For example: If you wanted to specify a specific car, one of\
            \ the name/value pairs would be<br><br><code>\"name\" : \"Year\", <br>\"\
            value\" : \"2019\"</code><br><br>For a list of the attributes required\
            \ for cars and trucks and motorcycles see <a href=\"/api-docs/buy/static/api-browse.html#Check\"\
            >Check compatibility</a> in the Buy Integration Guide."
          items:
            $ref: "#/components/schemas/AttributeNameValue"
      description: "An array of attribute name/value pairs used to define a specific\
        \ product. For example: If you wanted to specify a specific car, one of the\
        \ name/value pairs would be:<br><br><code>\"name\" : \"Year\",<br>\"value\"\
        \ : \"2019\"</code><br><br>For a list of the attributes required for cars\
        \ and trucks and motorcycles refer to <a href=\"/api-docs/buy/static/api-browse.html#Check\"\
        \ target=\"_blank\">Check compatibility</a> in the <a href=\"/api-docs/buy/static/buying-ig-landing.html\"\
        \ target=\"_blank\">Buying Integration Guide</a>."
    CompatibilityProperty:
      type: "object"
      properties:
        localizedName:
          type: "string"
          description: "The name of the product attribute that as been translated\
            \ to the language of the site."
        name:
          type: "string"
          description: "The name of the product attribute, such as Make, Model, Year,\
            \ etc."
        value:
          type: "string"
          description: "The value for the <code>name</code> attribute, such as <b>BMW</b>,\
            \ <b>R1200GS</b>, <b>2011</b>, etc."
      description: "This container returns the product attribute name/value pairs\
        \ that are compatible with the keyword. These attributes are submitted in\
        \ the <code>compatibility_filter</code> request field."
    CompatibilityResponse:
      type: "object"
      properties:
        compatibilityStatus:
          type: "string"
          description: "An enumeration value that tells you if the item is compatible\
            \ with the product. <br><br>The values are: <ul>   <li>   <b> COMPATIBLE</b>\
            \ - Indicates the item is compatible with the product specified in the\
            \ request.</li>   <li>   <b> NOT_COMPATIBLE</b> - Indicates the item is\
            \ not compatible with the product specified in the request. Be sure to\
            \ check all the <b> value</b> fields to ensure they are correct as errors\
            \ in the value can also cause this response.</li>   <li> <b> UNDETERMINED</b>\
            \ - Indicates one or more attributes for the specified product are missing\
            \ so compatibility cannot be determined.  The response returns the attributes\
            \ that are missing.</li>  </ul>  Code so that your app gracefully handles\
            \ any future changes to this list. For implementation help, refer to <a\
            \ href='https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityStatus'>eBay\
            \ API documentation</a>"
        warnings:
          type: "array"
          description: "An array of warning messages. These types of errors do not\
            \ prevent the method from executing but should be checked."
          items:
            $ref: "#/components/schemas/Error"
      description: "The type that defines the response fields for <b> checkCompatibility</b>.\
        \  "
    ConditionDescriptor:
      type: "object"
      properties:
        name:
          type: "string"
          description: "The name of a condition descriptor. The value(s) for this\
            \ condition descriptor is returned in the associated <b>values</b> array."
        values:
          type: "array"
          description: "This array displays the value(s) for a condition descriptor\
            \ (denoted by the associated <b>name</b> field), as well as any other\
            \ additional information about the condition of the item."
          items:
            $ref: "#/components/schemas/ConditionDescriptorValue"
      description: "This type displays additional information about the condition\
        \ of an item in a structured format."
    ConditionDescriptorValue:
      type: "object"
      properties:
        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 <b>content</b> field and provides additional details\
            \ about the condition of an item."
          items:
            type: "string"
        content:
          type: "string"
          description: "The value for the condition descriptor indicated in the associated\
            \ <b>name</b> field."
      description: "This type displays the value(s) associated with the specified\
        \ condition descriptor name, as well as any additional information about a\
        \ condition descriptor. "
    ConditionDistribution:
      type: "object"
      properties:
        condition:
          type: "string"
          description: "The text describing the condition of the item, such as <i>New</i>\
            \ or <i>Used</i>. For a list of condition names, refer to <a href=\"/api-docs/sell/static/metadata/condition-id-values.html\
            \ \" target=\"_blank\">Item Condition IDs and Names</a>."
        conditionId:
          type: "string"
          description: "The identifier of the condition. For example, <code>1000</code>\
            \ is the identifier for <code>NEW</code>."
        matchCount:
          type: "integer"
          description: "The number of items having the condition."
          format: "int32"
        refinementHref:
          type: "string"
          description: "The HATEOAS reference of this condition."
      description: "The container that defines the fields for the conditions refinements.\
        \ This container is returned when <code>fieldgroups</code> is set to <code>CONDITION_REFINEMENTS</code>\
        \ or <code>FULL</code> in the request."
    ConvertedAmount:
      type: "object"
      properties:
        convertedFromCurrency:
          type: "string"
          description: "The three-letter <a href=\"https://www.iso.org/iso-4217-currency-codes.html\
            \ \" target=\"_blank\">ISO 4217</a> code representing the currency of\
            \ the amount in the <code>convertedFromValue</code> field. This value\
            \ is required or returned only if currency conversion/localization is\
            \ required, and represents the pre-conversion currency. For implementation\
            \ help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay\
            \ API documentation</a>"
        convertedFromValue:
          type: "string"
          description: "The monetary amount before any conversion is performed, in\
            \ the currency specified by the <code>convertedFromCurrency</code> field.\
            \ This value is required or returned only if currency conversion/localization\
            \ is required. The <code>value</code> field contains the converted amount\
            \ of this value, in the currency specified by the <code>currency</code>\
            \ field."
        currency:
          type: "string"
          description: "The three-letter <a href=\"https://www.iso.org/iso-4217-currency-codes.html\
            \ \" target=\"_blank\">ISO 4217</a> code representing the currency of\
            \ the amount in the <code>value</code> field. If currency conversion/localization\
            \ is required, this is the post-conversion currency of the amount in the\
            \ <code>value</code> field.<br><br><b>Default:</b> The currency of the\
            \ authenticated user's country. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CurrencyCodeEnum'>eBay\
            \ API documentation</a>"
        value:
          type: "string"
          description: "The monetary amount in the currency specified by the <code>currency</code>\
            \ field. If currency conversion/localization is required, this value is\
            \ the converted amount, and the <code>convertedFromValue</code> field\
            \ contains the amount in the original currency."
      description: "This type defines the monetary value of an amount. It can provide\
        \ the amount in both the currency used on the eBay site where an item is being\
        \ offered and the conversion of that value into another currency, if applicable."
    CoreItem:
      type: "object"
      properties:
        additionalImages:
          type: "array"
          description: "An array of containers with the URLs for the images that are\
            \ in addition to the primary image.  The primary image is returned in\
            \ the <b> image.imageUrl</b> field."
          items:
            $ref: "#/components/schemas/Image"
        adultOnly:
          type: "boolean"
          description: "This indicates if the item is for  adults only. For more information\
            \ about adult-only items on eBay, see <a href=\"https://pages.ebay.com/help/policies/adult-only.html\
            \ \" target=\"_blank\">Adult items policy</a> for sellers and <a href=\"\
            https://www.ebay.com/help/terms-conditions/default/searching-adult-items?id=4661\
            \ \" target=\"_blank\">Adult-Only items on eBay</a> for buyers."
        ageGroup:
          type: "string"
          description: "(Primary Item Aspect) The age group for which the product\
            \ is recommended. For example, newborn, infant, toddler, kids, adult,\
            \ etc. All the item aspects, including this aspect, are returned in the\
            \ <b> localizedAspects</b> container."
        authenticityGuarantee:
          description: "A container for information about whether an item is qualified\
            \ for the Authenticity Guarantee program.<br><br>Under the Authenticity\
            \ Guarantee program, the seller ships a purchased item to a a third-party\
            \ authenticator who inspects the item and provides an authentication card\
            \ for it before the item is shipped to the buyer. If the buyer returns\
            \ the item, the authenticator first verifies that it is the same item\
            \ in the same condition before returning it to the seller.<br><br><span\
            \ class=\"tablenote\"><b> Note: </b>Refer to the <a href=\"https://pages.ebay.com/authenticity-guarantee/\
            \ \" target=\"_blank\">Authenticity Guarantee</a> page for more information.</span>"
          $ref: "#/components/schemas/AuthenticityGuaranteeProgram"
        authenticityVerification:
          description: "A container for information about whether an item is from\
            \ a verified seller.</span>"
          $ref: "#/components/schemas/AuthenticityVerificationProgram"
        availableCoupons:
          type: "array"
          description: "A list of available coupons for the item."
          items:
            $ref: "#/components/schemas/AvailableCoupon"
        bidCount:
          type: "integer"
          description: "This integer value indicates the total number of bids that\
            \ have been placed against an auction item. This field is returned only\
            \ for auction items."
          format: "int32"
        brand:
          type: "string"
          description: "(Primary Item Aspect) The name brand of the item, such as\
            \ Nike, Apple, etc.  All the item aspects, including this aspect, are\
            \ returned in the <b> localizedAspects</b> container."
        buyingOptions:
          type: "array"
          description: "A comma separated list of all the purchase options available\
            \ for the item. The values returned are:<ul><li><code>FIXED_PRICE</code>\
            \ - Indicates the buyer can purchase the item for a set price using the\
            \ Buy It Now button.</li><li><code>AUCTION</code> - Indicates the buyer\
            \ can place a bid for the item. After the first bid is placed, this becomes\
            \ a live auction item and is the only buying option for this item.</li><li><code>BEST_OFFER</code>\
            \ - Indicates the buyer can send the seller a price they're willing to\
            \ pay for the item. The seller can accept, reject, or send a counter offer.\
            \ For more information on how this works, see <a href=\"https://www.ebay.com/help/buying/buy-now/making-best-offer?id=4019\
            \ \">Making a Best Offer</a>.</li><li><code>CLASSIFIED_AD</code> - Indicates\
            \ that the final sales transaction is to be completed outside of the eBay\
            \ environment.</li></ul>Code so that your app gracefully handles any future\
            \ changes to this list."
          items:
            type: "string"
        categoryId:
          type: "string"
          description: "The ID of the leaf category for this item. A leaf category\
            \ is the lowest level in that category and has no children."
        categoryPath:
          type: "string"
          description: "Text that shows the category hierarchy of the item. For example:\
            \ Computers/Tablets &amp; Networking, Laptops &amp; Netbooks, PC Laptops\
            \ &amp; Netbooks"
        color:
          type: "string"
          description: "(Primary Item Aspect) Text describing the color of the item.\
            \  All the item aspects, including this aspect, are returned in the <b>\
            \ localizedAspects</b> container."
        charityTerms:
          description: "This container returns any applicable charity information\
            \ associated with the specified item.<br><br>This container is only returned\
            \ if the <b>fieldgroups</b> query parameter is set to <code>CHARITY_DETAILS</code>."
          $ref: "#/components/schemas/ItemCharityTerms"
        condition:
          type: "string"
          description: "A short text description for the condition of the item, such\
            \ as New or Used. For a list of condition names, see <a href=\"/api-docs/sell/static/metadata/condition-id-values.html\
            \ \" target=\"_blank\">Item Condition IDs and Names</a>.  <br><br>Code\
            \ so that your app gracefully handles any future changes to this list."
        conditionDescription:
          type: "string"
          description: "A full text description for the condition of the item. This\
            \ field elaborates on the value specified in the <b>condition</b> field\
            \ and provides full details for the condition of the item."
        conditionId:
          type: "string"
          description: "The identifier of the condition of the item. For example,\
            \ 1000 is the identifier for NEW. For a list of condition names and IDs,\
            \ see <a href=\"/api-docs/sell/static/metadata/condition-id-values.html\
            \ \" target=\"_blank\">Item Condition IDs and Names</a>. <br><br>Code\
            \ so that your app gracefully handles any future changes to this list.</span>"
        currentBidPrice:
          description: "The container that returns the current highest bid for an\
            \ auction item. The value (string) field shows the dollar value of the\
            \ current highest bid, and the currency (3-digit ISO code) field denotes\
            \ the currency associated with that bid value. This container will only\
            \ be returned for auction items."
          $ref: "#/components/schemas/ConvertedAmount"
        description:
          type: "string"
          description: "The full description of the item that was created by the seller.\
            \ This can be plain text or rich content and can be very large."
        eligibleForInlineCheckout:
          type: "boolean"
          description: "This field indicates if the item can be purchased using the\
            \ Buy <a href=\"/api-docs/buy/order/resources/methods\">Order API</a>.\
            \ <ul> <li>If the value of this field is <code>true</code>, this indicates\
            \ that the item can be purchased using the <b> Order API</b>. </li>  <li>If\
            \ the value of this field is <code>false</code>, this indicates that the\
            \ item cannot be purchased using the <b> Order API</b> and must be purchased\
            \ on the eBay site.</li> </ul>"
        enabledForGuestCheckout:
          type: "boolean"
          description: "This indicates if the item can be purchased using Guest Checkout\
            \ in the <a href=\"/api-docs/buy/order/resources/methods\">Order API</a>.\
            \ You can use this flag to exclude items from your inventory that are\
            \ not eligible for Guest Checkout, such as gift cards."
        energyEfficiencyClass:
          type: "string"
          description: "This indicates the <a href=\"https://en.wikipedia.org/wiki/European_Union_energy_label\
            \ \">European energy efficiency</a> rating (EEK) of the item. This field\
            \ is returned only if the seller specified the energy efficiency rating.\
            \ <br><br>The rating is a set of energy efficiency classes from A to G,\
            \ where 'A' is the most energy efficient and 'G' is the least efficient.\
            \ This rating helps buyers choose between various models. <br><br>When\
            \ the manufacturer's specifications for this item are available, the link\
            \ to this information is returned in the <b>productFicheWebUrl</b> field."
        epid:
          type: "string"
          description: "An EPID is the eBay product identifier of a product from the\
            \ eBay product catalog.  This indicates the product in which the item\
            \ belongs."
        estimatedAvailabilities:
          type: "array"
          description: "The estimated number of this item that are available for purchase.\
            \ Because the quantity of an item can change several times within a second,\
            \ it is impossible to return the exact quantity. So instead of returning\
            \ quantity, the estimated availability of the item is returned."
          items:
            $ref: "#/components/schemas/EstimatedAvailability"
        gender:
          type: "string"
          description: "(Primary Item Aspect) The gender for the item. This is used\
            \ for items that could vary by gender, such as clothing. For example:\
            \ male, female, or unisex. All the item aspects, including this aspect,\
            \ are returned in the <b> localizedAspects</b> container."
        gtin:
          type: "string"
          description: "The unique Global Trade Item number of the item as defined\
            \ by <a href=\"https://www.gtin.info \" target=\"_blank\">https://www.gtin.info</a>.\
            \ This can be a UPC (Universal Product Code), EAN (European Article Number),\
            \ or an ISBN (International Standard Book Number) value."
        image:
          description: "The URL of the primary image of the item. The other images\
            \ of the item are returned in the <b> additionalImages</b> container."
          $ref: "#/components/schemas/Image"
        immediatePay:
          type: "boolean"
          description: "A value of <code>true</code> indicates that the seller requires\
            \ immediate payment from the buyer when purchasing an item.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> It is possible for this field to be\
            \ set to <code>true</code>, but not apply in some scenarios. For example,\
            \ immediate payment is not applicable for auction listings that have a\
            \ winning bidder, for buyers' purchases that involve the Best Offer feature,\
            \ or for offline transactions.</span>"
        inferredEpid:
          type: "string"
          description: "The ePID (eBay Product ID of a product from the eBay product\
            \ catalog) for the item, which has been programmatically determined by\
            \ eBay using the item's title, aspects, and other data. <br><br>If the\
            \ seller provided an ePID for the item, the seller's value is returned\
            \ in the <b> epid</b> field. <br><br><span class=\"tablenote\"><b> Note:\
            \ </b> This field is returned only for authorized Partners.</span>"
        itemAffiliateWebUrl:
          type: "string"
          description: "The URL to the View Item page of the item which includes the\
            \ affiliate tracking ID.<br><br><span class=\"tablenote\"><b>Note:</b>\
            \ In order to receive commissions on sales, eBay Partner Network affiliates\
            \ must use this URL to forward buyers to the listing on the eBay marketplace.</span><br>The\
            \ <b>itemAffiliateWebUrl</b> is only returned if:<ul><li>The marketplace\
            \ through which the item is being viewed is part of the eBay Partner Network.\
            \ Currently Singapore (<code>EBAY_SG</code>) is <b>not</b> supported.<br><br>For\
            \ additional information, refer to <a href=\"https://partnerhelp.ebay.com/helpcenter/s/article/countries-available-as-a-program-in-EPN?language=en_US\
            \ \" target=\"_blank\">eBay Partner Network</a>.</li><li>The seller enables\
            \ affiliate tracking for the item by including the <code><a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
            >X-EBAY-C-ENDUSERCTX</a></code> request header in the method.</li></ul>"
        itemCreationDate:
          type: "string"
          description: "A timestamp that indicates the date and time an item listing\
            \ was created.<br><br>This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ),\
            \ which can be converted into the local time of the buyer."
        itemEndDate:
          type: "string"
          description: "A timestamp that indicates the date and time an auction listing\
            \ will end.<br><br>If a fixed-price listing has ended, this field indicates\
            \ the date and time the listing ended.<br><br>This value is returned in\
            \ UTC format (<code>yyyy-MM-ddThh:mm:ss.sssZ</code>), which can be converted\
            \ into the local time of the buyer."
        itemId:
          type: "string"
          description: "The unique RESTful identifier of the item."
        itemLocation:
          description: "The physical location of the item."
          $ref: "#/components/schemas/Address"
        itemWebUrl:
          type: "string"
          description: "The URL of the View Item page of the item. This enables you\
            \ to include a \"Report Item on eBay\" link that takes the buyer to the\
            \ View Item page on eBay. From there they can report any issues regarding\
            \ this item to eBay."
        legacyItemId:
          type: "string"
          description: "The unique identifier of the eBay listing that contains the\
            \ item. This is the traditional/legacy ID that is often seen in the URL\
            \ of the listing View Item page."
        localizedAspects:
          type: "array"
          description: "An array of containers that show the complete list of the\
            \ aspect name/value pairs that describe the variation of the item."
          items:
            $ref: "#/components/schemas/TypedNameValue"
        lotSize:
          type: "integer"
          description: "The number of items in a lot. In other words, a lot size is\
            \ the number of items that are being sold together.  <br><br>A lot is\
            \ a set of two or more items included in a single listing that must be\
            \ purchased together in a single order line item. All the items in the\
            \ lot are the same but there can be multiple items in a single lot,  such\
            \ as the package of batteries shown in the example below.   <br><br><table\
            \ border=\"1\"> <tr> <tr>  <th>Item</th>  <th>Lot Definition</th> <th>Lot\
            \ Size</th></tr>  <tr>  <td>A package of 24 AA batteries</td>  <td>A box\
            \ of 10 packages</td>  <td>10  </td> </tr>  <tr>  <td>A P235/75-15 Goodyear\
            \ tire </td>  <td>4 tires  </td>  <td>4  </td> </tr> <tr> <td>Fashion\
            \ Jewelry Rings  </td> <td>Package of 100 assorted rings  </td> <td>100\
            \ </td> </tr></table>  <br><br><span class=\"tablenote\"><b>Note: </b>\
            \  Lots are not supported in all categories.  </span>"
          format: "int32"
        marketingPrice:
          description: "The original price and the discount amount and percentage."
          $ref: "#/components/schemas/MarketingPrice"
        material:
          type: "string"
          description: "(Primary Item Aspect) Text describing what the item is made\
            \ of. For example, silk. All the item aspects, including this aspect,\
            \ are returned in the <b> localizedAspects</b> container."
        minimumPriceToBid:
          description: "The minimum price of the next bid, which means to place a\
            \ bid it must be equal to or greater than this amount. If the auction\
            \ hasn't received any bids, the minimum bid price is the same as the starting\
            \ bid. Otherwise, the minimum bid price is equal to the current bid plus\
            \ the bid increment.  For details about bid increments, see <a href=\"\
            https://www.ebay.com/help/buying/bidding/automatic-bidding?id=4014 \"\
            >Automatic bidding</a>."
          $ref: "#/components/schemas/ConvertedAmount"
        mpn:
          type: "string"
          description: "The manufacturer's part number, which is a unique number that\
            \ identifies a specific product. To identify the product, this is always\
            \ used along with brand."
        pattern:
          type: "string"
          description: "(Primary Item Aspect) Text describing the pattern used on\
            \ the item. For example, paisley. All the item aspects, including this\
            \ aspect, are returned in the <b> localizedAspects</b> container."
        paymentMethods:
          type: "array"
          description: "The payment methods for the item, including the payment method\
            \ types, brands, and instructions for the buyer."
          items:
            $ref: "#/components/schemas/PaymentMethod"
        price:
          description: "The cost of just the item. This amount does not include any\
            \ adjustments such as discounts or shipping costs.<br><br><span class=\"\
            tablenote\"><b> Note: </b>The price does include the value-added tax (VAT)\
            \ for applicable jurisdictions when requested from supported marketplaces.\
            \ In this case, users must pass the <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
            ><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the\
            \ supported marketplace (such as <code>EBAY_GB</code>) to see the VAT-inclusive\
            \ pricing. For more information on VAT, refer to <a href=\"https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT\"\
            >VAT Obligations in the EU</a>.</span>"
          $ref: "#/components/schemas/ConvertedAmount"
        priceDisplayCondition:
          type: "string"
          description: "Indicates when in the buying flow the item's price can appear\
            \ for minimum advertised price (MAP) items, which is the lowest price\
            \ a retailer can advertise/show for this item. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PriceDisplayConditionEnum'>eBay\
            \ API documentation</a>"
        primaryItemGroup:
          description: "The container that returns details of a primary item group\
            \ (parent ID of an item group). An item group is an item that has various\
            \ aspect differences, such as color, size, storage capacity, etc. <br><br>When\
            \ an item group is created, one of the item variations, such as the red\
            \ shirt size L, is chosen as the \"parent\". All the other items in the\
            \ group are the children, such as the blue shirt size L, red shirt size\
            \ M, etc.<br><br><span class=\"tablenote\"><b> Note: </b> This container\
            \ is returned if the <b> item_id</b> in the request is for an item group\
            \ (items with variations, such as color and size). This container is also\
            \ returned on a request for <b> item_group_ids</b>.</span>"
          $ref: "#/components/schemas/ItemGroupSummary"
        primaryProductReviewRating:
          description: "The container that returns the product rating details, such\
            \ as review count, rating histogram, and average rating."
          $ref: "#/components/schemas/ReviewRating"
        priorityListing:
          type: "boolean"
          description: "This field is returned as <code>true</code> if the listing\
            \ is part of a Promoted Listing campaign. Promoted Listings are available\
            \ to Above Standard and Top Rated sellers with recent sales activity.<br><br>For\
            \ more information, see <a href=\"https://pages.ebay.com/seller-center/listing-and-marketing/promoted-listings.html\
            \ \" target=\"_blank\">Promoted Listings</a>."
        product:
          description: "The container that returns the product information of the\
            \ item."
          $ref: "#/components/schemas/Product"
        productFicheWebUrl:
          type: "string"
          description: "The URL of a page containing the manufacturer's specification\
            \ of this item, which helps buyers make a purchasing decision. This information\
            \ is available only for items that include the European energy efficiency\
            \ rating (EEK) but is not available for <em> all</em> items with an EEK\
            \ rating and is returned only if this information is available. The EEK\
            \ rating of the item is returned in the <b> energyEfficiencyClass</b>\
            \ field."
        qualifiedPrograms:
          type: "array"
          description: "An array of the qualified programs available for the item,\
            \ such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.<br><br>eBay\
            \ Plus is a premium account option for buyers, which provides benefits\
            \ such as fast free domestic shipping and free returns on selected items.\
            \ Top-Rated eBay sellers must opt in to eBay Plus to be able to offer\
            \ the program on qualifying listings. Sellers must commit to next-day\
            \ delivery of those items.<br><br><span class=\"tablenote\"><b>Note: </b>\
            \ eBay Plus is available only to buyers in Germany, Austria, and Australia\
            \ marketplaces.</span><br><br>The eBay <a href=\"https://pages.ebay.com/authenticity-guarantee/\
            \ \" target=\"_blank\">Authenticity Guarantee</a> program enables third-party\
            \ authenticators to perform authentication verification inspections on\
            \ items such as watches and sneakers."
          items:
            type: "string"
        quantityLimitPerBuyer:
          type: "integer"
          description: "The maximum number for a specific item that one buyer can\
            \ purchase."
          format: "int32"
        reservePriceMet:
          type: "boolean"
          description: "This indicates if the reserve price of the item has been met.\
            \ A reserve price is set by the seller and is the minimum amount the seller\
            \ is willing to sell the item for. <p>If the highest bid is not equal\
            \ to or higher than the reserve price when the auction ends, the listing\
            \ ends and the item is not sold.</p> <p><b> Note: </b>This is returned\
            \ only for auctions that have a reserve price.</p>"
        returnTerms:
          description: "The container that returns an overview of the seller's return\
            \ policy."
          $ref: "#/components/schemas/ItemReturnTerms"
        seller:
          description: "The container that returns basic and detailed about the seller\
            \ of the item, such as name, feedback score, and contact information."
          $ref: "#/components/schemas/SellerDetail"
        sellerItemRevision:
          type: "string"
          description: "An identifier generated/incremented when a seller revises\
            \ the item. There are two types of item revisions: <ul><li>Seller changes,\
            \ such as changing the title</li>  <li>eBay system changes, such as changing\
            \ the quantity when an item is purchased</li></ul> This ID is changed\
            \ <em> only</em> when the seller makes a change to the item. This means\
            \ you cannot use this value to determine if the quantity has changed."
        shippingOptions:
          type: "array"
          description: "An array of shipping options containers that have the details\
            \ about cost, carrier, etc. of one shipping option.<br><br><span class=\"\
            tablenote\"><b>Note:</b> For items with calculated shipping, this array\
            \ is only returned if the <b>X-EBAY-C-ENDUSERCTX</b> header is supplied.</span> "
          items:
            $ref: "#/components/schemas/ShippingOption"
        shipToLocations:
          description: "The container that returns the geographic regions to be included\
            \ and excluded that define where the item can be shipped."
          $ref: "#/components/schemas/ShipToLocations"
        shortDescription:
          type: "string"
          description: "This text string is derived from the item condition and the\
            \ item aspects (such as size, color, capacity, model, brand, etc.)."
        size:
          type: "string"
          description: "(Primary Item Aspect) The size of the item. For example, '7'\
            \ for a size 7 shoe. All the item aspects, including this aspect, are\
            \ returned in the <b> localizedAspects</b> container."
        sizeSystem:
          type: "string"
          description: "(Primary Item Aspect) The sizing system of the country.  All\
            \ the item aspects, including this aspect, are returned in the <b> localizedAspects</b>\
            \ container. <br><br><b> Valid Values: </b> <br>AU (Australia),  <br>BR\
            \ (Brazil), <br>CN (China),  <br>DE (Germany),  <br>EU (European Union),\
            \  <br> FR (France), <br> IT (Italy),  <br>JP (Japan), <br>MX (Mexico),\
            \  <br>US (USA), <br> UK (United Kingdom) <br><br>Code so that your app\
            \ gracefully handles any future changes to this list. "
        sizeType:
          type: "string"
          description: "(Primary Item Aspect) Text describing a size group in which\
            \ the item would be included, such as regular, petite, plus, big-and-tall\
            \ or maternity. All the item aspects, including this aspect, are returned\
            \ in the <b> localizedAspects</b> container."
        subtitle:
          type: "string"
          description: "A subtitle is optional and allows the seller to provide more\
            \ information about the product, possibly including keywords that may\
            \ assist with search results."
        taxes:
          type: "array"
          description: "The container for the tax information for the item."
          items:
            $ref: "#/components/schemas/Taxes"
        title:
          type: "string"
          description: "The seller-created title of the item. <br><br><b> Maximum\
            \ Length: </b> 80 characters"
        topRatedBuyingExperience:
          type: "boolean"
          description: "This indicates if the item a top-rated plus item. There are\
            \ three benefits of a top-rated plus item: a  minimum 30-day money-back\
            \ return policy, shipping the items in 1 business day with tracking provided,\
            \ and the added comfort of knowing this item is from experienced sellers\
            \ with the highest buyer ratings. See the <a href=\"https://pages.ebay.com/topratedplus/index.html\
            \ \" target=\"_blank\">Top Rated Plus Items </a> and <a href=\"https://pages.ebay.com/help/sell/top-rated.html\
            \ \" target=\"_blank\">Becoming a Top Rated Seller and qualifying for\
            \ Top Rated Plus</a> help topics for more information."
        tyreLabelImageUrl:
          type: "string"
          description: "The URL to the image that shows the information on the tyre\
            \ label."
        uniqueBidderCount:
          type: "integer"
          description: "This integer value indicates the number of different eBay\
            \ users who have placed one or more bids on an auction item. This field\
            \ is only applicable to auction items."
          format: "int32"
        unitPrice:
          description: "This is the price per unit for the item. Some European countries\
            \ require listings for certain types of products to include the price\
            \ per unit so buyers can accurately compare prices.   <br><br>For example:\
            \ <br><br><code>\"unitPricingMeasure\": \"100g\",<br> \"unitPrice\": {<br>&nbsp;&nbsp;\"\
            value\": \"7.99\",<br>&nbsp;&nbsp;\"currency\": \"GBP\"</code>"
          $ref: "#/components/schemas/ConvertedAmount"
        unitPricingMeasure:
          type: "string"
          description: "The designation, such as size, weight, volume, count, etc.,\
            \ that was used to specify the quantity of the item.  This helps buyers\
            \ compare prices. <br><br>For example, the following tells the buyer that\
            \ the item is 7.99 per 100 grams. <br><br><code>\"unitPricingMeasure\"\
            : \"100g\",<br> \"unitPrice\": {<br>&nbsp;&nbsp;\"value\": \"7.99\",<br>&nbsp;&nbsp;\"\
            currency\": \"GBP\"</code>"
      description: "An array of containers with the details for all of the items returned."
    CouponConstraint:
      type: "object"
      properties:
        expirationDate:
          type: "string"
          description: "This timestamp provides the expiration date of the coded coupon."
      description: "This type is used to provide the expiration date of a coded coupon."
    EconomicOperator:
      type: "object"
      properties:
        companyName:
          type: "string"
          description: "The company name of the registered Economic Operator."
        addressLine1:
          type: "string"
          description: "The first line of the registered Economic Operator's street\
            \ address."
        addressLine2:
          type: "string"
          description: "The second line, if any, of the registered Economic Operator's\
            \ street address. This field is not always used, but can be used for 'Suite\
            \ Number' or 'Apt Number'."
        city:
          type: "string"
          description: "The city of the registered Economic Operator's street address."
        stateOrProvince:
          type: "string"
          description: "The state or province of the registered Economic Operator's\
            \ street address."
        postalCode:
          type: "string"
          description: "The postal code of the registered Economic Operator's street\
            \ address."
        country:
          type: "string"
          description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
            \ \" target=\"_blank\">ISO 3166</a> standard abbreviation of the country\
            \ of the registered Economic Operator's address."
        phone:
          type: "string"
          description: "The registered Economic Operator's business phone number."
        email:
          type: "string"
          description: "The registered Economic Operator's business email address."
      description: "The type that provides required Economic Operator information\
        \ about the manufacturer and/or supplier of the item."
    Error:
      type: "object"
      properties:
        category:
          type: "string"
          description: "This string value indicates the error category. There are\
            \ three categories of errors: <i>request errors</i>, <i>application errors</i>,\
            \ and <i>system errors</i>."
        domain:
          type: "string"
          description: "The name of the primary system where the error occurred. This\
            \ is relevant for application errors."
        errorId:
          type: "integer"
          description: "A unique code that identifies the particular error or warning\
            \ that occurred. Your application can use error codes as identifiers in\
            \ your customized error-handling algorithms."
          format: "int32"
        inputRefIds:
          type: "array"
          description: "An array of reference IDs that identify the specific request\
            \ elements most closely associated to the error or warning, if any."
          items:
            type: "string"
        longMessage:
          type: "string"
          description: "A detailed description of the condition that caused the error\
            \ or warning, and information on what to do to correct the problem."
        message:
          type: "string"
          description: "A description of the condition that caused the error or warning."
        outputRefIds:
          type: "array"
          description: "An array of reference IDs that identify the specific response\
            \ elements most closely associated to the error or warning, if any."
          items:
            type: "string"
        parameters:
          type: "array"
          description: "An array of warning and error messages that return one or\
            \ more variables contextual information about the error or warning. This\
            \ is often the field or value that triggered the error or warning."
          items:
            $ref: "#/components/schemas/ErrorParameter"
        subdomain:
          type: "string"
          description: "The name of the subdomain in which the error or warning occurred."
      description: "The type that defines the fields that can be returned in an error."
    ErrorParameter:
      type: "object"
      properties:
        name:
          type: "string"
          description: "This is the name of input field that caused an issue with\
            \ the call request."
        value:
          type: "string"
          description: "This is the actual value that was passed in for the element\
            \ specified in the <code>name</code> field."
      description: "An array of name/value pairs that provide details regarding the\
        \ error."
    EstimatedAvailability:
      type: "object"
      properties:
        availabilityThreshold:
          type: "integer"
          description: "This field is return only when the seller sets their '<a href=\"\
            #display-item-quantity\">display item quantity</a>' preference to <b>\
            \ Display \"More than 10 available\" in your listing (if applicable)</b>.\
            \ The value of this field will be \"10\", which is the threshold value.\
            \ <br><br>Code so that your app gracefully handles any future changes\
            \ to this value."
          format: "int32"
        availabilityThresholdType:
          type: "string"
          description: "<a name=\"display-item-quantity\"></a> This field is return\
            \ only when the seller sets their <b> Display Item Quantity</b> preference\
            \ to <b> Display \"More than 10 available\" in your listing (if applicable)</b>.\
            \ The value of this field will be <code> MORE_THAN</code>. This indicates\
            \ that the seller has more than the 'quantity display preference', which\
            \ is 10, in stock for this item.    <br><br> The following are the display\
            \ item quantity preferences the seller can set. <br><ul><li> <b> Display\
            \ \"More than 10 available\" in your listing (if applicable) </b><ul>\
            \ <li>If the seller enables this preference, this field is returned as\
            \ long as there are more than 10 of this item in inventory.</li>  <li>\
            \ If the quantity is equal to 10 or drops below 10, this field is not\
            \ returned and the estimated quantity of the item is returned in the <b>\
            \ estimatedAvailableQuantity</b> field.</li></ul> </li> <li> <b> Display\
            \ the exact quantity in your items</b> <br>If the seller enables this\
            \ preference, the <b> availabilityThresholdType</b> and <b> availabilityThreshold</b>\
            \ fields are not returned and the estimated quantity of the item is returned\
            \ in the <b> estimatedAvailableQuantity</b> field.<br><br><b> Note: </b>\
            \ Because the quantity of an item can change several times within a second,\
            \ it is impossible to return the exact quantity. </li></ul>   <br>Code\
            \ so that your app gracefully handles any future changes to these preferences.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:AvailabilityThresholdEnum'>eBay\
            \ API documentation</a>"
        deliveryOptions:
          type: "array"
          description: "An array of available delivery options. <br><br><b> Valid\
            \ Values: </b> SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP,\
            \ PICKUP_DROP_OFF, or DIGITAL_DELIVERY <br><br>Code so that your app gracefully\
            \ handles any future changes to this list. "
          items:
            type: "string"
            description: " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:DeliveryOptionsEnum'>eBay\
              \ API documentation</a>"
        estimatedAvailabilityStatus:
          type: "string"
          description: "An enumeration value representing the inventory status of\
            \ this item.<br><br><span class=\"tablenote\"><b> Note: </b>Be sure to\
            \ review the <b>itemEndDate</b> field to determine whether the item is\
            \ available for purchase.</span><br><br><b> Valid Values: </b> IN_STOCK,\
            \ LIMITED_STOCK, or OUT_OF_STOCK <br><br>Code so that your app gracefully\
            \ handles any future changes to this list. For implementation help, refer\
            \ to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:AvailabilityStatusEnum'>eBay\
            \ API documentation</a>"
        estimatedAvailableQuantity:
          type: "integer"
          description: "The estimated number of this item that are available for purchase.\
            \ Because the quantity of an item can change several times within a second,\
            \ it is impossible to return the exact quantity. So instead of returning\
            \ quantity, the estimated availability of the item is returned.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> To see if a listing is available for\
            \ purchase, review the <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#response.itemEndDate\"\
            >itemEndDate</a> and <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#response.estimatedAvailabilities.estimatedAvailabilityStatus\"\
            >estimatedAvailablityStatus</a> fields. If the item has an <b>EndDate</b>\
            \ in the past, or the <b>estimatedAvailabilityStatus</b> is <code>OUT_OF_STOCK</code>,\
            \ the item is unavailable for purchase.</span>"
          format: "int32"
        estimatedRemainingQuantity:
          type: "integer"
          description: "The estimated number of this item that are available for purchase.\
            \ Because the quantity of an item can change several times within a second,\
            \ it is impossible to return the exact quantity. So instead of returning\
            \ quantity, the estimated availability of the item is returned.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> To see if a listing is available for\
            \ purchase, review the <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#response.itemEndDate\"\
            >itemEndDate</a> and <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#response.estimatedAvailabilities.estimatedAvailabilityStatus\"\
            >estimatedAvailablityStatus</a> fields. If the item has an <b>EndDate</b>\
            \ in the past, or the <b>estimatedAvailabilityStatus</b> is <code>OUT_OF_STOCK</code>,\
            \ the item is unavailable for purchase.</span>"
          format: "int32"
        estimatedSoldQuantity:
          type: "integer"
          description: "The estimated number of this item that have been sold."
          format: "int32"
      description: "The type that defines the fields for the estimated item availability\
        \ information."
    HazardPictogram:
      type: "object"
      properties:
        pictogramDescription:
          type: "string"
          description: "The description of the hazard pictogram, such as Flammable."
        pictogramId:
          type: "string"
          description: "The ID of the hazard pictogram."
        pictogramUrl:
          type: "string"
          description: "The URL of the hazard pictogram."
      description: "A type that defines the pictogram for the type of hazard that\
        \ a hazardous material represents."
    HazardStatement:
      type: "object"
      properties:
        statementDescription:
          type: "string"
          description: "A description of the nature of the hazard, such as whether\
            \ the material is toxic if swallowed."
        statementId:
          type: "string"
          description: "The ID of the hazard statement."
      description: "A type that defines the hazard statement for a hazardous material."
    HazardousMaterialsLabels:
      type: "object"
      properties:
        additionalInformation:
          type: "string"
          description: "Additional information about the hazardous materials labels."
        pictograms:
          type: "array"
          description: "An array of hazard pictograms that apply to the item."
          items:
            $ref: "#/components/schemas/HazardPictogram"
        signalWord:
          type: "string"
          description: "The signal word for the hazardous materials label (such as\
            \ Danger or Warning)."
        signalWordId:
          type: "string"
          description: "The ID of the signal word for the hazardous materials label."
        statements:
          type: "array"
          description: "An array of hazard statements for the item."
          items:
            $ref: "#/components/schemas/HazardStatement"
      description: "A type that defines the hazardous materials labels for an item."
    Image:
      type: "object"
      properties:
        height:
          type: "integer"
          description: "Reserved for future use."
          format: "int32"
        imageUrl:
          type: "string"
          description: "The URL of the image."
        width:
          type: "integer"
          description: "Reserved for future use."
          format: "int32"
      description: "Type that defines the details of an image, such as size and image\
        \ URL. Currently, only <code>imageUrl</code> is populated. The <code>height</code>\
        \ and <code>width</code> are reserved for future use."
    Item:
      type: "object"
      properties:
        additionalImages:
          type: "array"
          description: "An array of containers with the URLs for the images that are\
            \ in addition to the primary image.  The primary image is returned in\
            \ the <b> image.imageUrl</b> field."
          items:
            $ref: "#/components/schemas/Image"
        addonServices:
          type: "array"
          description: "A list of add-on services that may be selected for the item\
            \ or that may apply automatically."
          items:
            $ref: "#/components/schemas/AddonService"
        adultOnly:
          type: "boolean"
          description: "This indicates if the item is for  adults only. For more information\
            \ about adult-only items on eBay, see <a href=\"https://pages.ebay.com/help/policies/adult-only.html\
            \ \" target=\"_blank\">Adult items policy</a> for sellers and <a href=\"\
            https://www.ebay.com/help/terms-conditions/default/searching-adult-items?id=4661\"\
            \ target=\"_blank\">Adult-Only items on eBay</a> for buyers."
        ageGroup:
          type: "string"
          description: "(Primary Item Aspect) The age group for which the product\
            \ is recommended. For example, newborn, infant, toddler, kids, adult,\
            \ etc. All the item aspects, including this aspect, are returned in the\
            \ <b> localizedAspects</b> container."
        authenticityGuarantee:
          description: "A container for information about whether an item, or the\
            \ item group when returned for the <b>getItemsByItemGroup</b> method,\
            \ is qualified for the Authenticity Guarantee program.<br><br><span class=\"\
            tablenote\"><b>Note: </b>The <code>AUTHENTICITY_GUARANTEE</code> value\
            \ being returned by the <b>getItemsByItemGroup</b> method indicates that\
            \ at least one item in the item group supports this program, but doesn't\
            \ guarantee that the program is available to all items in the item group.\
            \ To verify if the Authenticity Program is indeed available for the item\
            \ that you are interested in, grab the <b>items.itemId</b> value for that\
            \ item and use the <b>getItem</b> method. This method will return specific\
            \ details on that particular item, including whether or not the Authenticity\
            \ Guarantee Program is available for the item. Look for the <b>qualifiedPrograms</b>\
            \ array and <b>authenticityGuarantee</b> container in the <b>getItem</b>\
            \ response for this information.</span><br><br>Under the Authenticity\
            \ Guarantee program, the seller ships a purchased item to a a third-party\
            \ authenticator who inspects the item and provides an authentication card\
            \ for it before the item is shipped to the buyer. If the buyer returns\
            \ the item, the authenticator first verifies that it is the same item\
            \ in the same condition before returning it to the seller.<br><br><span\
            \ class=\"tablenote\"><b> Note: </b>Refer to the <a href=\"https://pages.ebay.com/authenticity-guarantee/\
            \ \" target=\"_blank\">Authenticity Guarantee</a> page for more information.</span>"
          $ref: "#/components/schemas/AuthenticityGuaranteeProgram"
        authenticityVerification:
          description: "A container for information about whether an item is from\
            \ a verified seller.</span>"
          $ref: "#/components/schemas/AuthenticityVerificationProgram"
        availableCoupons:
          type: "array"
          description: "A list of available coupons for the item.<br><br><span class=\"\
            tablenote\"><b>Note:</b> The Browse API only acknowledges item-level coupons.\
            \ This array will only return coupons linked with an item. Store-level\
            \ coupons offered by sellers across their entire store will not be returned.</span>"
          items:
            $ref: "#/components/schemas/AvailableCoupon"
        bidCount:
          type: "integer"
          description: "This integer value indicates the total number of bids that\
            \ have been placed against an auction item. This field is returned only\
            \ for auction items."
          format: "int32"
        brand:
          type: "string"
          description: "(Primary Item Aspect) The name brand of the item, such as\
            \ Nike, Apple, etc.  All the item aspects, including this aspect, are\
            \ returned in the <b> localizedAspects</b> container."
        buyingOptions:
          type: "array"
          description: "A comma separated list of all the purchase options available\
            \ for the item. The values returned are:<ul><li><code>FIXED_PRICE</code>\
            \ - Indicates the buyer can purchase the item for a set price using the\
            \ Buy It Now button.</li><li><code>AUCTION</code> - Indicates the buyer\
            \ can place a bid for the item. After the first bid is placed, this becomes\
            \ a live auction item and is the only buying option for this item.</li><li><code>BEST_OFFER</code>\
            \ - Indicates the buyer can send the seller a price they're willing to\
            \ pay for the item. The seller can accept, reject, or send a counter offer.\
            \ For more information on how this works, see <a href=\"https://www.ebay.com/help/buying/buy-now/making-best-offer?id=4019\
            \ \">Making a Best Offer</a>.</li><li><code>CLASSIFIED_AD</code> - Indicates\
            \ that the final sales transaction is to be completed outside of the eBay\
            \ environment.</li></ul>Code so that your app gracefully handles any future\
            \ changes to this list."
          items:
            type: "string"
        categoryId:
          type: "string"
          description: "The ID of the leaf category for this item. A leaf category\
            \ is the lowest level in that category and has no children."
        categoryIdPath:
          type: "string"
          description: "The IDs of every category in the item path, separated by pipe\
            \ characters, starting with the top level parent category.<br><br>For\
            \ example, if an item belongs to the top level category Home and Garden\
            \ (category ID 11700), followed by Home Improvement (159907), Heating,\
            \ Cooling and Air (69197), and Thermostats (115947), the field would return\
            \ the value: <code>11700|159907|69197|115947</code>."
        categoryPath:
          type: "string"
          description: "Text that shows the category hierarchy of the item. For example:\
            \ Computers/Tablets &amp; Networking, Laptops &amp; Netbooks, PC Laptops\
            \ &amp; Netbooks"
        charityTerms:
          description: "This container returns any applicable charity information\
            \ associated with the specified item.<br><br>This container is only returned\
            \ if the <b>fieldgroups</b> query parameter is set to <code>CHARITY_DETAILS</code>."
          $ref: "#/components/schemas/ItemCharityTerms"
        color:
          type: "string"
          description: "(Primary Item Aspect) Text describing the color of the item.\
            \  All the item aspects, including this aspect, are returned in the <b>\
            \ localizedAspects</b> container."
        condition:
          type: "string"
          description: "A short text description for the condition of the item, such\
            \ as New or Used. For a list of condition names, see <a href=\"/api-docs/sell/static/metadata/condition-id-values.html\
            \ \" target=\"_blank\">Item Condition IDs and Names</a>.  <br><br>Code\
            \ so that your app gracefully handles any future changes to this list."
        conditionDescription:
          type: "string"
          description: "A full text description for the condition of the item. This\
            \ field elaborates on the value specified in the <b>condition</b> field\
            \ and provides full details for the condition of the item."
        conditionDescriptors:
          type: "array"
          description: "This array is used by the seller to provide additional information\
            \ about the condition of an item in a structured format. Condition descriptors\
            \ are name-value attributes that indicate details about a particular condition\
            \ of an item.<br><br><span class=\"tablenote\"><b>Note:</b> Condition\
            \ descriptors are currently only available for the following trading card\
            \ categories:<ul><li>Non-Sport Trading Card Singles</li><li>CCG Individual\
            \ Cards</li><li>Sports Trading Card Singles</li></ul></span>"
          items:
            $ref: "#/components/schemas/ConditionDescriptor"
        conditionId:
          type: "string"
          description: "The identifier of the condition of the item. For example,\
            \ 1000 is the identifier for NEW. For a list of condition names and IDs,\
            \ see <a href=\"/api-docs/sell/static/metadata/condition-id-values.html\
            \ \" target=\"_blank\">Item Condition IDs and Names</a>. <br><br>Code\
            \ so that your app gracefully handles any future changes to this list."
        currentBidPrice:
          description: "The container that returns the current highest bid for an\
            \ auction item. The value (string) field shows the dollar value of the\
            \ current highest bid, and the currency (3-digit ISO code) field denotes\
            \ the currency associated with that bid value. This container will only\
            \ be returned for auction items."
          $ref: "#/components/schemas/ConvertedAmount"
        description:
          type: "string"
          description: "The full description of the item that was created by the seller.\
            \ This can be plain text or rich content and can be very large."
        ecoParticipationFee:
          description: "The Eco Participation fee, a fee paid by the buyer that is\
            \ applied to the cost of the eventual disposal of the purchased item.\
            \ The fee is remitted in full to the eco organization.<br><br>Currently,\
            \ this value is required for electronic devices and furniture."
          $ref: "#/components/schemas/ConvertedAmount"
        eligibleForInlineCheckout:
          type: "boolean"
          description: "This field indicates if the item can be purchased using the\
            \ Buy <a href=\"/api-docs/buy/order/resources/methods\">Order API</a>.\
            \ <ul> <li>If the value of this field is <code>true</code>, this indicates\
            \ that the item can be purchased using the <b> Order API</b>. </li>  <li>If\
            \ the value of this field is <code>false</code>, this indicates that the\
            \ item cannot be purchased using the <b> Order API</b> and must be purchased\
            \ on the eBay site.</li> </ul>"
        enabledForGuestCheckout:
          type: "boolean"
          description: "This indicates if the item can be purchased using Guest Checkout\
            \ in the <a href=\"/api-docs/buy/order/resources/methods\">Order API</a>.\
            \ You can use this flag to exclude items from your inventory that are\
            \ not eligible for Guest Checkout, such as gift cards."
        energyEfficiencyClass:
          type: "string"
          description: "This indicates the <a href=\"https://en.wikipedia.org/wiki/European_Union_energy_label\
            \ \">European energy efficiency</a> rating (EEK) of the item. This field\
            \ is returned only if the seller specified the energy efficiency rating.\
            \ <br><br>The rating is a set of energy efficiency classes from A to G,\
            \ where 'A' is the most energy efficient and 'G' is the least efficient.\
            \ This rating helps buyers choose between various models. <br><br>When\
            \ the manufacturer's specifications for this item are available, the link\
            \ to this information is returned in the <b> productFicheWebUrl</b> field."
        epid:
          type: "string"
          description: "An EPID is the eBay product identifier of a product from the\
            \ eBay product catalog.  This indicates the product in which the item\
            \ belongs."
        estimatedAvailabilities:
          type: "array"
          description: "The estimated number of this item that are available for purchase.\
            \ Because the quantity of an item can change several times within a second,\
            \ it is impossible to return the exact quantity. So instead of returning\
            \ quantity, the estimated availability of the item is returned."
          items:
            $ref: "#/components/schemas/EstimatedAvailability"
        gender:
          type: "string"
          description: "(Primary Item Aspect) The gender for the item. This is used\
            \ for items that could vary by gender, such as clothing. For example:\
            \ male, female, or unisex. All the item aspects, including this aspect,\
            \ are returned in the <b> localizedAspects</b> container."
        gtin:
          type: "string"
          description: "The unique Global Trade Item number of the item as defined\
            \ by <a href=\"https://www.gtin.info \" target=\"_blank\">https://www.gtin.info</a>.\
            \ This can be a UPC (Universal Product Code), EAN (European Article Number),\
            \ or an ISBN (International Standard Book Number) value."
        hazardousMaterialsLabels:
          description: "Hazardous materials labels for the item."
          $ref: "#/components/schemas/HazardousMaterialsLabels"
        image:
          description: "The URL of the primary image of the item. The other images\
            \ of the item are returned in the <b> additionalImages</b> container."
          $ref: "#/components/schemas/Image"
        immediatePay:
          type: "boolean"
          description: "A value of <code>true</code> indicates that the seller requires\
            \ immediate payment from the buyer when purchasing an item.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> It is possible for this field to be\
            \ set to <code>true</code>, but not apply in some scenarios. For example,\
            \ immediate payment is not applicable for auction listings that have a\
            \ winning bidder, for buyers purchases that involve the Best Offer feature,\
            \ or for offline transactions.</span>"
        inferredEpid:
          type: "string"
          description: "The ePID (eBay Product ID of a product from the eBay product\
            \ catalog) for the item, which has been programmatically determined by\
            \ eBay using the item's title, aspects, and other data. <br><br>If the\
            \ seller provided an ePID for the item, the seller's value is returned\
            \ in the <b> epid</b> field. <br><br><span class=\"tablenote\"><b> Note:\
            \ </b> This field is returned only for authorized Partners.</span>"
        itemAffiliateWebUrl:
          type: "string"
          description: "The URL to the View Item page of the item which includes the\
            \ affiliate tracking ID.<br><br><span class=\"tablenote\"><b>Note:</b>\
            \ In order to receive commissions on sales, eBay Partner Network affiliates\
            \ must use this URL to forward buyers to the listing on the eBay marketplace.</span><br>The\
            \ <b>itemAffiliateWebUrl</b> is only returned if:<ul><li>The marketplace\
            \ through which the item is being viewed is part of the eBay Partner Network.\
            \ Currently Singapore (<code>EBAY_SG</code>) is <b>not</b> supported.<br><br>For\
            \ additional information, refer to <a href=\"https://partnerhelp.ebay.com/helpcenter/s/article/countries-available-as-a-program-in-EPN?language=en_US\
            \ \" target=\"_blank\">eBay Partner Network</a>.</li><li>The seller enables\
            \ affiliate tracking for the item by including the <code><a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
            >X-EBAY-C-ENDUSERCTX</a></code> request header in the method.</li></ul>"
        itemCreationDate:
          type: "string"
          description: "A timestamp that indicates the date and time an item listing\
            \ was created.<br><br>This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ),\
            \ which can be converted into the local time of the buyer."
        itemEndDate:
          type: "string"
          description: "A timestamp that indicates the date and time an auction listing\
            \ will end.<br><br>If a fixed-price listing has ended, this field indicates\
            \ the date and time the listing ended.<br><br>This value is returned in\
            \ UTC format (<code>yyyy-MM-ddThh:mm:ss.sssZ</code>), which can be converted\
            \ into the local time of the buyer."
        itemId:
          type: "string"
          description: "The unique RESTful identifier of the item."
        itemLocation:
          description: "The physical location of the item."
          $ref: "#/components/schemas/Address"
        itemWebUrl:
          type: "string"
          description: "The URL of the View Item page of the item. This enables you\
            \ to include a \"Report Item on eBay\" link that takes the buyer to the\
            \ View Item page on eBay. From there they can report any issues regarding\
            \ this item to eBay."
        legacyItemId:
          type: "string"
          description: "The unique identifier of the eBay listing that contains the\
            \ item. This is the traditional/legacy ID that is often seen in the URL\
            \ of the listing View Item page."
        listingMarketplaceId:
          type: "string"
          description: "The ID of the eBay marketplace where the item is listed. For\
            \ implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:MarketplaceIdEnum'>eBay\
            \ API documentation</a>"
        localizedAspects:
          type: "array"
          description: "An array of containers that show the complete list of the\
            \ aspect name/value pairs that describe the variation of the item."
          items:
            $ref: "#/components/schemas/TypedNameValue"
        lotSize:
          type: "integer"
          description: "The number of items in a lot. In other words, a lot size is\
            \ the number of items that are being sold together.  <br><br>A lot is\
            \ a set of two or more items included in a single listing that must be\
            \ purchased together in a single order line item. All the items in the\
            \ lot are the same but there can be multiple items in a single lot,  such\
            \ as the package of batteries shown in the example below.   <br><br><table\
            \ border=\"1\"> <tr> <tr>  <th>Item</th>  <th>Lot Definition</th> <th>Lot\
            \ Size</th></tr>  <tr>  <td>A package of 24 AA batteries</td>  <td>A box\
            \ of 10 packages</td>  <td>10  </td> </tr>  <tr>  <td>A P235/75-15 Goodyear\
            \ tire </td>  <td>4 tires  </td>  <td>4  </td> </tr> <tr> <td>Fashion\
            \ Jewelry Rings  </td> <td>Package of 100 assorted rings  </td> <td>100\
            \ </td> </tr></table>  <br><br><span class=\"tablenote\"><b>Note: </b>\
            \  Lots are not supported in all categories.  </span>"
          format: "int32"
        manufacturer:
          description: "Contact information for the manufacturer of the product."
          $ref: "#/components/schemas/CompanyAddress"
        marketingPrice:
          description: "The original price and the discount amount and percentage."
          $ref: "#/components/schemas/MarketingPrice"
        material:
          type: "string"
          description: "(Primary Item Aspect) Text describing what the item is made\
            \ of. For example, silk. All the item aspects, including this aspect,\
            \ are returned in the <b> localizedAspects</b> container."
        minimumPriceToBid:
          description: "The minimum price of the next bid, which means to place a\
            \ bid it must be equal to or greater than this amount. If the auction\
            \ hasn't received any bids, the minimum bid price is the same as the starting\
            \ bid. Otherwise, the minimum bid price is equal to the current bid plus\
            \ the bid increment.  For details about bid increments, see <a href=\"\
            https://www.ebay.com/help/buying/bidding/automatic-bidding?id=4014 \"\
            >Automatic bidding</a>."
          $ref: "#/components/schemas/ConvertedAmount"
        mpn:
          type: "string"
          description: "The manufacturer's part number, which is a unique number that\
            \ identifies a specific product. To identify the product, this is always\
            \ used along with brand."
        pattern:
          type: "string"
          description: "(Primary Item Aspect) Text describing the pattern used on\
            \ the item. For example, paisley. All the item aspects, including this\
            \ aspect, are returned in the <b> localizedAspects</b> container."
        paymentMethods:
          type: "array"
          description: "The payment methods for the item, including the payment method\
            \ types, brands, and instructions for the buyer."
          items:
            $ref: "#/components/schemas/PaymentMethod"
        price:
          description: "The cost of just the item. This amount does not include any\
            \ adjustments such as discounts or shipping costs.<br><br><span class=\"\
            tablenote\"><b> Note: </b>The price does include the value-added tax (VAT)\
            \ for applicable jurisdictions when requested from supported marketplaces.\
            \ In this case, users must pass the <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
            ><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the\
            \ supported marketplace (such as <code>EBAY_GB</code>) to see the VAT-inclusive\
            \ pricing. For more information on VAT, refer to <a href=\"https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT\"\
            >VAT Obligations in the EU</a>.</span>"
          $ref: "#/components/schemas/ConvertedAmount"
        priceDisplayCondition:
          type: "string"
          description: "Indicates when in the buying flow the item's price can appear\
            \ for minimum advertised price (MAP) items, which is the lowest price\
            \ a retailer can advertise/show for this item. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PriceDisplayConditionEnum'>eBay\
            \ API documentation</a>"
        primaryItemGroup:
          description: "The container that returns details of a primary item group\
            \ (parent ID of an item group). An item group is an item that has various\
            \ aspect differences, such as color, size, storage capacity, etc. <br><br>When\
            \ an item group is created, one of the item variations, such as the red\
            \ shirt size L, is chosen as the \"parent\". All the other items in the\
            \ group are the children, such as the blue shirt size L, red shirt size\
            \ M, etc.<br><br><span class=\"tablenote\"><b> Note: </b> This container\
            \ is returned only if the <b> item_id</b> in the request is for an item\
            \ group (items with variations, such as color and size).</span>"
          $ref: "#/components/schemas/ItemGroupSummary"
        primaryProductReviewRating:
          description: "The container that returns the product rating details, such\
            \ as review count, rating histogram, and average rating."
          $ref: "#/components/schemas/ReviewRating"
        priorityListing:
          type: "boolean"
          description: "This field is returned as <code>true</code> if the listing\
            \ is part of a Promoted Listing campaign. Promoted Listings are available\
            \ to Above Standard and Top Rated sellers with recent sales activity.<br><br>For\
            \ more information, see <a href=\"https://pages.ebay.com/seller-center/listing-and-marketing/promoted-listings.html\
            \ \" target=\"_blank\">Promoted Listings</a>."
        product:
          description: "The container that returns the product information of the\
            \ item."
          $ref: "#/components/schemas/Product"
        productFicheWebUrl:
          type: "string"
          description: "The URL of a page containing the manufacturer's specification\
            \ of this item, which helps buyers make a purchasing decision. This information\
            \ is available only for items that include the European energy efficiency\
            \ rating (EEK) but is not available for <em> all</em> items with an EEK\
            \ rating and is returned only if this information is available. The EEK\
            \ rating of the item is returned in the <b> energyEfficiencyClass</b>\
            \ field."
        productSafetyLabels:
          description: "This container provides product safety labels which were provided\
            \ by the seller, for the listing.<br><br>The <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getProductSafetyLabels\"\
            \ target=\"_blank\">getProductSafetyLabels</a> method of the <a href=\"\
            /api-docs/sell/metadata/static/overview.html\" target=\"_blank\">Sell\
            \ Metadata API</a> can be used to retrieve the full set of available Product\
            \ Safety pictogram labels and safety statements."
          $ref: "#/components/schemas/ProductSafetyLabels"
        qualifiedPrograms:
          type: "array"
          description: "An array of the qualified programs available for the item,\
            \ or for the item group when returned for the <b>getItemsByItemGroup</b>\
            \ method, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.<br><br><span\
            \ class=\"tablenote\"><b>Note: </b>The <code>AUTHENTICITY_GUARANTEE</code>\
            \ value being returned by the <b>getItemsByItemGroup</b> method indicates\
            \ that at least one item in the item group supports this program, but\
            \ doesn't guarantee that the program is available to all items in the\
            \ item group. To verify if the Authenticity Program is indeed available\
            \ for the item that you are interested in, grab the <b>items.itemId</b>\
            \ value for that item and use the <b>getItem</b> method. This method will\
            \ return specific details on that particular item, including whether or\
            \ not the Authenticity Guarantee Program is available for the item. Look\
            \ for the <b>qualifiedPrograms</b> array and <b>authenticityGuarantee</b>\
            \ container in the <b>getItem</b> response for this information.</span><br><br>eBay\
            \ Plus is a premium account option for buyers, which provides benefits\
            \ such as fast free domestic shipping and free returns on selected items.\
            \ Top-Rated eBay sellers must opt in to eBay Plus to be able to offer\
            \ the program on qualifying listings. Sellers must commit to next-day\
            \ delivery of those items.<br><br><span class=\"tablenote\"><b>Note: </b>\
            \ eBay Plus is available only to buyers in Germany, Austria, and Australia\
            \ marketplaces.</span><br><br>The eBay <a href=\"https://pages.ebay.com/authenticity-guarantee/\
            \ \" target=\"_blank\">Authenticity Guarantee</a> program enables third-party\
            \ authenticators to perform authentication verification inspections on\
            \ items such as watches and sneakers."
          items:
            type: "string"
        quantityLimitPerBuyer:
          type: "integer"
          description: "The maximum number for a specific item that one buyer can\
            \ purchase."
          format: "int32"
        repairScore:
          type: "string"
          description: "A score that describes how easy it is to repair the product.\
            \ Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always\
            \ including a single decimal place."
        reservePriceMet:
          type: "boolean"
          description: "This indicates if the reserve price of the item has been met.\
            \ A reserve price is set by the seller and is the minimum amount the seller\
            \ is willing to sell the item for. <p>If the highest bid is not equal\
            \ to or higher than the reserve price when the auction ends, the listing\
            \ ends and the item is not sold.</p> <p><b> Note: </b>This is returned\
            \ only for auctions that have a reserve price.</p>"
        responsiblePersons:
          type: "array"
          description: "This array provides information about one or more EU-based\
            \ Responsible Persons or entities associated with the listing."
          items:
            $ref: "#/components/schemas/ResponsiblePerson"
        returnTerms:
          description: "The container that returns an overview of the seller's return\
            \ policy."
          $ref: "#/components/schemas/ItemReturnTerms"
        seller:
          description: "The container that returns basic and detailed about the seller\
            \ of the item, such as name, feedback score, and contact information."
          $ref: "#/components/schemas/SellerDetail"
        sellerCustomPolicies:
          type: "array"
          description: "A list of the custom policies that are applied to a listing."
          items:
            $ref: "#/components/schemas/SellerCustomPolicy"
        sellerItemRevision:
          type: "string"
          description: "An identifier generated/incremented when a seller revises\
            \ the item. There are two types of item revisions: <ul><li>Seller changes,\
            \ such as changing the title</li>  <li>eBay system changes, such as changing\
            \ the quantity when an item is purchased</li></ul> This ID is changed\
            \ <em> only</em> when the seller makes a change to the item. This means\
            \ you cannot use this value to determine if the quantity has changed."
        shippingOptions:
          type: "array"
          description: "An array of shipping options containers that have the details\
            \ about cost, carrier, etc. of one shipping option.<br><br><span class=\"\
            tablenote\"><b>Note:</b> For items with calculated shipping, this array\
            \ is only returned if the <b>X-EBAY-C-ENDUSERCTX</b> header is supplied.</span> "
          items:
            $ref: "#/components/schemas/ShippingOption"
        shipToLocations:
          description: "The container that returns the geographic regions to be included\
            \ and excluded that define where the item can be shipped."
          $ref: "#/components/schemas/ShipToLocations"
        shortDescription:
          type: "string"
          description: "This text string is derived from the item condition and the\
            \ item aspects (such as size, color, capacity, model, brand, etc.)."
        size:
          type: "string"
          description: "(Primary Item Aspect) The size of the item. For example, '7'\
            \ for a size 7 shoe. All the item aspects, including this aspect, are\
            \ returned in the <b> localizedAspects</b> container."
        sizeSystem:
          type: "string"
          description: "(Primary Item Aspect) The sizing system of the country.  All\
            \ the item aspects, including this aspect, are returned in the <b> localizedAspects</b>\
            \ container. <br><br><b> Valid Values: </b> <br>AU (Australia),  <br>BR\
            \ (Brazil), <br>CN (China),  <br>DE (Germany),  <br>EU (European Union),\
            \  <br> FR (France), <br> IT (Italy),  <br>JP (Japan), <br>MX (Mexico),\
            \  <br>US (USA), <br> UK (United Kingdom) <br><br>Code so that your app\
            \ gracefully handles any future changes to this list. "
        sizeType:
          type: "string"
          description: "(Primary Item Aspect) Text describing a size group in which\
            \ the item would be included, such as regular, petite, plus, big-and-tall\
            \ or maternity. All the item aspects, including this aspect, are returned\
            \ in the <b> localizedAspects</b> container."
        subtitle:
          type: "string"
          description: "A subtitle is optional and allows the seller to provide more\
            \ information about the product, possibly including keywords that may\
            \ assist with search results."
        taxes:
          type: "array"
          description: "The container for the tax information for the item."
          items:
            $ref: "#/components/schemas/Taxes"
        title:
          type: "string"
          description: "The seller-created title of the item. <br><br><b> Maximum\
            \ Length: </b> 80 characters"
        topRatedBuyingExperience:
          type: "boolean"
          description: "This indicates if the item a top-rated plus item. There are\
            \ three benefits of a top-rated plus item: a  minimum 30-day money-back\
            \ return policy, shipping the items in 1 business day with tracking provided,\
            \ and the added comfort of knowing this item is from experienced sellers\
            \ with the highest buyer ratings. See the <a href=\"https://pages.ebay.com/topratedplus/index.html\
            \ \" target=\"_blank\">Top Rated Plus Items </a> and <a href=\"https://pages.ebay.com/help/sell/top-rated.html\
            \ \" target=\"_blank\">Becoming a Top Rated Seller and qualifying for\
            \ Top Rated Plus</a> help topics for more information."
        tyreLabelImageUrl:
          type: "string"
          description: "The URL to the image that shows the information on the tyre\
            \ label."
        uniqueBidderCount:
          type: "integer"
          description: "This integer value indicates the number of different eBay\
            \ users who have placed one or more bids on an auction item. This field\
            \ is only applicable to auction items."
          format: "int32"
        unitPrice:
          description: "This is the price per unit for the item. Some European countries\
            \ require listings for certain types of products to include the price\
            \ per unit so buyers can accurately compare prices.   <br><br>For example:\
            \ <br><br><code>\"unitPricingMeasure\": \"100g\",<br> \"unitPrice\": {<br>&nbsp;&nbsp;\"\
            value\": \"7.99\",<br>&nbsp;&nbsp;\"currency\": \"GBP\"</code>"
          $ref: "#/components/schemas/ConvertedAmount"
        unitPricingMeasure:
          type: "string"
          description: "The designation, such as size, weight, volume, count, etc.,\
            \ that was used to specify the quantity of the item.  This helps buyers\
            \ compare prices. <br><br>For example, the following tells the buyer that\
            \ the item is 7.99 per 100 grams. <br><br><code>\"unitPricingMeasure\"\
            : \"100g\",<br> \"unitPrice\": {<br>&nbsp;&nbsp;\"value\": \"7.99\",<br>&nbsp;&nbsp;\"\
            currency\": \"GBP\"</code>"
        warnings:
          type: "array"
          description: "An array of warning messages. These types of errors do not\
            \ prevent the method from executing but should be checked."
          items:
            $ref: "#/components/schemas/Error"
        watchCount:
          type: "integer"
          description: "The number of users that have added the item to their watch\
            \ list.<br><br><span class=\"tablenote\"> <strong>Note:</strong> This\
            \ field is restricted to applications that have been granted permission\
            \ to access this feature. You must submit an <a href=\"https://developer.ebay.com/my/support/tickets?tab=app-check\
            \ \">App Check ticket</a> to request this access. In the App Check form,\
            \ add a note to the <b>Application Title/Summary</b> and/or <b>Application\
            \ Details</b> fields that you want access to Watch Count data in the Browse\
            \ API.</span>"
          format: "int32"
      description: "The details of an item that can be purchased."
    ItemCharityTerms:
      type: "object"
      properties:
        charityOrgId:
          type: "string"
          description: "The eBay-assigned unique identifier of the charitable organization\
            \ that will receive a percentage of the sales proceeds from the item."
        donationPercentage:
          type: "number"
          description: "The percentage of the purchase price of the item that the\
            \ charitable organization (identified in the <b>charityOrgId</b> field)\
            \ will receive for each sale."
        LogoImage:
          description: "The details of the charity's logo image, such as the size\
            \ and URL.<br><br><span class=\"tablenote\"> <b> Note: </b> Currently,\
            \ only the <b>imageUrl</b> is populated.</span>"
          $ref: "#/components/schemas/Image"
        name:
          type: "string"
          description: "The name of the charity organization."
        website:
          type: "string"
          description: "The URL to the charity's eBay page."
      description: "This type defines the fields for any applicable charity information\
        \ associated with an item."
    ItemGroup:
      type: "object"
      properties:
        commonDescriptions:
          type: "array"
          description: "An array of containers for a description and the item IDs\
            \ of all the items that have this exact description. Often the item variations\
            \ within an item group all have the same description. Instead of repeating\
            \ this description in the item details of each item, a description that\
            \ is shared by at least one other item is returned in this container.\
            \ If the description is unique, it is returned in the <b> items.description</b>\
            \ field."
          items:
            $ref: "#/components/schemas/CommonDescriptions"
        items:
          type: "array"
          description: "An array of containers for all the item variation details,\
            \ excluding the description."
          items:
            $ref: "#/components/schemas/Item"
        warnings:
          type: "array"
          description: "An array of warning messages. These types of errors do not\
            \ prevent the method from executing but should be checked."
          items:
            $ref: "#/components/schemas/Error"
      description: "The type that defines the fields for the item details."
    ItemGroupSummary:
      type: "object"
      properties:
        itemGroupAdditionalImages:
          type: "array"
          description: "An array of containers with the URLs for images that are in\
            \ addition to the primary image of the item group.  The primary image\
            \ is returned in the <b> itemGroupImage</b> field."
          items:
            $ref: "#/components/schemas/Image"
        itemGroupHref:
          type: "string"
          description: "The HATEOAS reference of the parent page of the item group.\
            \ An item group is an item that has various aspect differences, such as\
            \ color, size, storage capacity, etc. "
        itemGroupId:
          type: "string"
          description: "The unique identifier for the item group. An item group is\
            \ an item that has various aspect differences, such as color, size, storage\
            \ capacity, etc. "
        itemGroupImage:
          description: "The URL of the primary image of the item group. An item group\
            \ is an item that has various aspect differences, such as color, size,\
            \ storage capacity, etc. "
          $ref: "#/components/schemas/Image"
        itemGroupTitle:
          type: "string"
          description: "The title of the item that appears on the item group page.\
            \ An item group is an item that has various aspect differences, such as\
            \ color, size, storage capacity, etc. "
        itemGroupType:
          type: "string"
          description: "An enumeration value that indicates the type of the item group.\
            \ An item group is an item that has various aspect differences, such as\
            \ color, size, storage capacity, etc. For implementation help, refer to\
            \ <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ItemGroupTypeEnum'>eBay\
            \ API documentation</a>"
      description: "The type that defines the fields for the details of each item\
        \ in an item group. An item group is  an item that has various aspect differences,\
        \ such as color, size, storage capacity, etc. When an item group is created,\
        \ one of the item variations, such as the red shirt size L, is chosen as the\
        \ \"parent\". All the other items in the group are the children, such as the\
        \ blue shirt size L, red shirt size M, etc. <br><br><span class=\"tablenote\"\
        ><b> Note: </b> This container is returned only if the <b> item_id</b> in\
        \ the request is an item group (parent ID of an item with variations).</span>"
    ItemLocationImpl:
      type: "object"
      properties:
        addressLine1:
          type: "string"
          description: "The first line of the street address."
        addressLine2:
          type: "string"
          description: "The second line of the street address. This field may contain\
            \ such values as an apartment or suite number."
        city:
          type: "string"
          description: "The city in which the item is located.<br><br><b>Restriction:</b>\
            \ This field is populated in the <code>search</code> method response <i>only</i>\
            \ when <code>fieldgroups</code> = <code>EXTENDED</code>."
        country:
          type: "string"
          description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
            \ \" target=\"_blank\">ISO 3166</a> standard code that indicates the country\
            \ in which the item is located. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay\
            \ API documentation</a>"
        county:
          type: "string"
          description: "The county in which the item is located."
        postalCode:
          type: "string"
          description: "The postal code (or zip code in US) where the item is located.\
            \ Sellers set a postal code for items when they are listed. The postal\
            \ code is used for calculating proximity searches. It is anonymized when\
            \ returned in <code>itemLocation.postalCode</code> via the API."
        stateOrProvince:
          type: "string"
          description: "The state or province in which the item is located."
      description: "The type that defines the fields for the location of an item,\
        \ such as information typically used for an address, including postal code,\
        \ county, state/province, street address, city, and country (2-digit ISO code)."
    ItemReturnTerms:
      type: "object"
      properties:
        extendedHolidayReturnsOffered:
          type: "boolean"
          description: "This indicates if the seller has enabled the Extended Holiday\
            \ Returns feature on the item. Extended Holiday Returns are only applicable\
            \ during the US holiday season, and gives buyers extra time to return\
            \ an item. This 'extra time' will typically extend beyond what is set\
            \ through the <b> returnPeriod</b> value."
        refundMethod:
          type: "string"
          description: "An enumeration value that indicates how a buyer is refunded\
            \ when an item is returned. <br><br><b> Valid Values: </b> MONEY_BACK\
            \ or MERCHANDISE_CREDIT  <br><br>Code so that your app gracefully handles\
            \ any future changes to this list. For implementation help, refer to <a\
            \ href='https://developer.ebay.com/api-docs/buy/browse/types/gct:RefundMethodEnum'>eBay\
            \ API documentation</a>"
        restockingFeePercentage:
          type: "string"
          description: "This string field indicates the restocking fee percentage\
            \ that the seller has set on the item. Sellers have the option of setting\
            \ no restocking fee for an item, or they can set the percentage to 10,\
            \ 15, or 20 percent. So, if the cost of the item was $100, and the restocking\
            \ percentage was 20 percent, the buyer would be charged $20 to return\
            \ that item, so instead of receiving a $100 refund, they would receive\
            \ $80 due to the restocking fee."
        returnInstructions:
          type: "string"
          description: "Text written by the seller describing what the buyer needs\
            \ to do in order to return the item."
        returnMethod:
          type: "string"
          description: "An enumeration value that indicates the alternative methods\
            \ for a full refund when an item is returned. This field is returned if\
            \ the seller offers the buyer an item replacement or exchange instead\
            \ of a monetary refund. <br><br><b> Valid Values: </b>  <ul><li><b> REPLACEMENT</b>\
            \ -  Indicates that the buyer has the option of receiving money back for\
            \ the returned item, or they can choose to have the seller replace the\
            \ item with an identical item.</li>  <li><b> EXCHANGE</b> - Indicates\
            \ that the buyer has the option of receiving money back for the returned\
            \ item, or they can exchange the item for another similar item.</li></ul>\
            \  Code so that your app gracefully handles any future changes to this\
            \ list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ReturnMethodEnum'>eBay\
            \ API documentation</a>"
        returnPeriod:
          description: "The amount of time the buyer has to return the item after\
            \ the purchase date."
          $ref: "#/components/schemas/TimeDuration"
        returnsAccepted:
          type: "boolean"
          description: "Indicates whether the seller accepts returns for the item."
        returnShippingCostPayer:
          type: "string"
          description: "This enumeration value indicates whether the buyer or seller\
            \ is responsible for return shipping costs when an item is returned. <br><br><b>\
            \ Valid Values: </b> <ul><li><b> SELLER</b> - Indicates the seller will\
            \ pay for the shipping costs to return the item.</li>  <li><b> BUYER</b>\
            \ - Indicates the buyer will pay for the shipping costs to return the\
            \ item.</li>  </ul>  Code so that your app gracefully handles any future\
            \ changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ReturnShippingCostPayerEnum'>eBay\
            \ API documentation</a>"
      description: "The type that defines the fields for the seller's return policy."
    ItemSummary:
      type: "object"
      properties:
        additionalImages:
          type: "array"
          description: "An array of containers with the URLs for the images that are\
            \ in addition to the primary image. The primary image is returned in the\
            \ <code>image.imageUrl</code> field."
          items:
            $ref: "#/components/schemas/Image"
        adultOnly:
          type: "boolean"
          description: "This indicates if the item is for adults only. For more information\
            \ about adult-only items on eBay, refer to the <a href=\"https://www.ebay.com/help/policies/prohibited-restricted-items/adult-items-policy?id=4278\
            \ \" target=\"_blank\">Adult items policy</a>."
        availableCoupons:
          type: "boolean"
          description: "This boolean attribute indicates if coupons are available\
            \ for the item.<br><br><span class=\"tablenote\"><b>Note:</b> The Browse\
            \ API only acknowledges item-level coupons. This field will only be returned\
            \ as true if a coupon is linked with an item. It does not recognize store-level\
            \ coupons offered by sellers across their entire store.</span>"
        bidCount:
          type: "integer"
          description: "This integer value indicates the total number of bids that\
            \ have been placed for an auction item. This field is only returned for\
            \ auction items."
          format: "int32"
        buyingOptions:
          type: "array"
          description: "A comma separated list of all the purchase options available\
            \ for the item.<br><br><b>Values Returned:</b><ul><li><code>FIXED_PRICE</code><br>Indicates\
            \ the buyer can purchase the item for a set price using the <i>Buy It\
            \ Now</i> button.</li><li><code>AUCTION</code><br>Indicates the buyer\
            \ can place a bid for the item. After the first bid is placed, this becomes\
            \ a live auction item and is the only buying option for this item.</li><li><code>BEST_OFFER</code><br>Items\
            \ where the buyer can send the seller a price they are willing to pay\
            \ for the item. The seller can accept, reject, or send a counter offer.\
            \ For additional information about Best Offer, refer to <a href=\"https://www.ebay.com/help/selling/listings/selling-buy-now/adding-best-offer-listing?id=4144\
            \ \" target=\"_blank\">Adding Best Offer to your listing and sending offers\
            \ to buyers</a>.</li><li><code>CLASSIFIED_AD</code><br>Indicates that\
            \ the final sales transaction is to be completed outside of the eBay environment.</li></ul>"
          items:
            type: "string"
        categories:
          type: "array"
          description: "This array returns the name and ID of each category associated\
            \ with the item, including top level, branch, and leaf categories."
          items:
            $ref: "#/components/schemas/Category"
        compatibilityMatch:
          type: "string"
          description: "This indicates how well an item matches the <code>compatibility_filter</code>\
            \ product attributes.<br><br><b>Valid Values:</b><ul><li><code>EXACT</code></li><li><code>POSSIBLE</code></li></ul>\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityMatchEnum'>eBay\
            \ API documentation</a>"
        compatibilityProperties:
          type: "array"
          description: "This container returns only the product attributes that are\
            \ compatible with the item. These attributes were specified in the <code>compatibility_filter</code>\
            \ in the request. This means that if you passed in 5 attributes and only\
            \ 4 are compatible, only those 4 are returned. If none of the attributes\
            \ are compatible, this container is not returned."
          items:
            $ref: "#/components/schemas/CompatibilityProperty"
        condition:
          type: "string"
          description: "The text describing the condition of the item, such as <b>New</b>\
            \ or <b>Used</b>. For a list of condition names, refer to <a href=\"/api-docs/sell/static/metadata/condition-id-values.html\
            \ \" target=\"_blank\">Item Condition IDs and Names</a>."
        conditionId:
          type: "string"
          description: "The identifier of the condition of the item. For example,\
            \ <code>1000</code> is the identifier for <code>NEW</code>. For a list\
            \ of condition names and IDs, refer to <a href=\"/api-docs/sell/static/metadata/condition-id-values.html\
            \ \" target=\"_blank\">Item Condition IDs and Names</a>."
        currentBidPrice:
          description: "This container returns the current highest bid for an auction\
            \ item. The <code>value</code> field shows the dollar value of the current\
            \ highest bid, and the <code>currency</code> field (3-digit ISO code)\
            \ denotes the currency associated with that bid value. This field is only\
            \ returned for auction items."
          $ref: "#/components/schemas/ConvertedAmount"
        distanceFromPickupLocation:
          description: "This container returns the distance away that the item is\
            \ from the <code>pickupPostalCode</code> value that was supplied in the\
            \ method request. This container is only returned if the \"local pickup\"\
            \ filter fields are used in the request."
          $ref: "#/components/schemas/TargetLocation"
        energyEfficiencyClass:
          type: "string"
          description: "This indicates the <a href=\"https://en.wikipedia.org/wiki/European_Union_energy_label\
            \ \" target=\"_blank\">European energy efficiency</a> rating (EEK) of\
            \ the item. Energy efficiency ratings apply to products listed by commercial\
            \ vendors in electronics categories only. <br><br>Currently, this field\
            \ is only applicable for the Germany site, and is returned only if the\
            \ seller specifies the energy efficiency rating through item specifics\
            \ at listing time. Rating values include <code>A+++</code>, <code>A++</code>,\
            \ <code>A+</code>, <code>A</code>, <code>B</code>, <code>C</code>, <code>D</code>,\
            \ <code>E</code>, <code>F</code>, and <code>G</code>."
        epid:
          type: "string"
          description: "An ePID is the eBay product identifier of a product from the\
            \ eBay product catalog.  This indicates the product in which the item\
            \ belongs."
        image:
          description: "The URL to the primary image of the item."
          $ref: "#/components/schemas/Image"
        itemAffiliateWebUrl:
          type: "string"
          description: "The URL to the View Item page of the item which includes the\
            \ affiliate tracking ID.<br><br><span class=\"tablenote\"><b>Note:</b>\
            \ In order to receive commissions on sales, eBay Partner Network affiliates\
            \ must use this URL to forward buyers to the listing on the eBay marketplace.</span><br>The\
            \ <code>itemAffiliateWebUrl</code> is returned only if:<ul><li>The marketplace\
            \ through which the item is being viewed is part of the eBay Partner Network.\
            \ Currently Singapore (<code>EBAY_SG</code>) is <b>not</b> supported.<br><br>For\
            \ additional information, refer to <a href=\"https://partnerhelp.ebay.com/helpcenter/s/article/countries-available-as-a-program-in-EPN?language=en_US\
            \ \" target=\"_blank\">eBay Partner Network</a>.</li><li>The seller enables\
            \ affiliate tracking for the item by including the <code><a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
            >X-EBAY-C-ENDUSERCTX</a></code> request header in the method.</li></ul>"
        itemCreationDate:
          type: "string"
          description: "The date and time when the item listing was created. This\
            \ value is returned in UTC format (<code>yyyy-MM-ddThh:mm:ss.sssZ</code>),\
            \ which you can convert into the local time of the buyer.<br><br>This\
            \ field is always returned with <b>itemSummaries</b>."
        itemEndDate:
          type: "string"
          description: "A timestamp that indicates the date and time a listing is\
            \ scheduled to end.<br><br>This value is returned in UTC format (<code>yyyy-MM-ddThh:mm:ss.sssZ</code>),\
            \ which can be converted into the local time of the buyer."
        itemGroupHref:
          type: "string"
          description: "The HATEOAS reference of the parent page of the item group.\
            \ An item group is an item that has various aspect differences, such as\
            \ color, size, storage capacity, etc.<br><br><span class=\"tablenote\"\
            ><b>Note:</b> This field is returned only for item groups.</span>"
        itemGroupType:
          type: "string"
          description: "The indicates the item group type. An item group is an item\
            \ that has various aspect differences, such as color, size, storage capacity,\
            \ etc. <br><br>Currently only the <code>SELLER_DEFINED_VARIATIONS</code>\
            \ is supported and indicates this is an item group created by the seller.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> This field is returned only for item\
            \ groups.</span>"
        itemHref:
          type: "string"
          description: "The URI for the Browse API <a href=\"/api-docs/buy/browse/resources/item/methods/getItem\"\
            \ target=\"_blank\">getItem</a> method, which can be used to retrieve\
            \ more details about items in the search results."
        itemId:
          type: "string"
          description: "The unique RESTful identifier of the item."
        itemLocation:
          description: "This container returns the location of the item. This container\
            \ consists of fields you typically see for an address, including postal\
            \ code, county, state/province, street address, city, and country (2-digit\
            \ ISO code)."
          $ref: "#/components/schemas/ItemLocationImpl"
        itemOriginDate:
          type: "string"
          description: "The date and time when the listing was first made available.\
            \ This date will be retained if an item is relisted. This value is returned\
            \ in UTC format (<code>yyyy-MM-ddThh:mm:ss.sssZ</code>), which you can\
            \ convert into the local time of the buyer.<br><br>This timestamp is used\
            \ to sort the response when the <code>sort=newlyListed</code> parameter\
            \ is used.<br><br>This field is always returned with <b>itemSummaries</b>."
        itemWebUrl:
          type: "string"
          description: "The URL to the View Item page of the item. This enables you\
            \ to include a \"Report Item on eBay\" hyperlink that takes the buyer\
            \ to the View Item page on eBay. From there they can report any issues\
            \ regarding this item to eBay."
        leafCategoryIds:
          type: "array"
          description: "The leaf category IDs of the item. When the item belongs to\
            \ two leaf categories, the ID values are returned in the order primary,\
            \ secondary."
          items:
            type: "string"
        legacyItemId:
          type: "string"
          description: "The unique identifier of the eBay listing that contains the\
            \ item. This is the traditional/legacy ID that is often seen in the URL\
            \ of the listing View Item page."
        listingMarketplaceId:
          type: "string"
          description: "The ID of the eBay marketplace on which the seller listed\
            \ the item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:MarketplaceIdEnum'>eBay\
            \ API documentation</a>"
        marketingPrice:
          description: "This container is returned if the item is eligible for a seller\
            \ discount and contains the item's original price, and the seller discount\
            \ amount and percentage."
          $ref: "#/components/schemas/MarketingPrice"
        pickupOptions:
          type: "array"
          description: "This container returns the local pickup options available\
            \ to the buyer. This container is returned only if the user is searching\
            \ for local pickup items and set the local pickup filters in the method\
            \ request."
          items:
            $ref: "#/components/schemas/PickupOptionSummary"
        price:
          description: "The price of the item after it has been converted into another\
            \ currency.<br><br>The price includes the value-added tax (VAT) for applicable\
            \ jurisdictions when requested from supported marketplaces. In this case,\
            \ users must do one or more of the following to view VAT-inclusive pricing:<ul><li>Pass\
            \ the <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"\
            _blank\"><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying\
            \ the supported marketplace (such as <code>EBAY_GB</code>)</li><li>Pass\
            \ the <code>contextualLocation</code> values for the supported marketplace\
            \ in the <a href=\"/api-docs/buy/static/api-browse.html#Headers\" target=\"\
            _blank\"><code>X-EBAY-C-ENDUSERCTX</code></a> request header</li><li>Specify\
            \ the supported marketplace using the <a href=\"/api-docs/buy/static/ref-buy-browse-filters.html#deliveryCountry\"\
            \ target=\"_blank\"><code>deliveryCountry</code></a> <code>filter</code>\
            \ URI parameter (such as <code>filter=deliveryCountry:GB</code>)</li></ul><span\
            \ class=\"tablenote\"><b>Note:</b> For more information on VAT, refer\
            \ to <a href=\"https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650\
            \ \" target=\"_blank\">Your VAT Obligations in the UK &amp; EU</a>.</span>"
          $ref: "#/components/schemas/ConvertedAmount"
        priceDisplayCondition:
          type: "string"
          description: "Indicates when in the buying flow the item's price can appear\
            \ for minimum advertised price (MAP) items, which is the lowest price\
            \ a retailer can advertise/show for this item. For implementation help,\
            \ refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PriceDisplayConditionEnum'>eBay\
            \ API documentation</a>"
        priorityListing:
          type: "boolean"
          description: "This field is returned as <code>true</code> if the listing\
            \ is part of a Promoted Listing campaign. Promoted Listings are available\
            \ to <b>Above Standard</b> and <b>Top Rated</b> sellers with recent sales\
            \ activity.<br><br><span class=\"tablenote\"><b>Note:</b> Priority Listing\
            \ is returned only with a Best Match sort and will not be returned for\
            \ other sort options.</span>"
        qualifiedPrograms:
          type: "array"
          description: "An array of the qualified programs available for the item,\
            \ such as <code>EBAY_PLUS</code>, <code>AUTHENTICITY_GUARANTEE</code>,\
            \ and <code>AUTHENTICITY_VERIFICATION</code>.<br><br>eBay Plus is a premium\
            \ account option for buyers, which provides benefits such as fast, free\
            \ domestic shipping and free returns on selected items. Top-Rated eBay\
            \ sellers must opt in to eBay Plus to be able to offer the program on\
            \ qualifying listings. Sellers must commit to next-day delivery of those\
            \ items.<br><br><span class=\"tablenote\"><b>Note: </b> eBay Plus is available\
            \ only to buyers in the Germany, Austria, and Australia marketplaces.</span><br><br>The\
            \ eBay <a href=\"https://pages.ebay.com/authenticity-guarantee/ \" target=\"\
            _blank\">Authenticity Guarantee</a> program enables third-party authenticators\
            \ to perform authentication verification inspections on items such as\
            \ watches and sneakers."
          items:
            type: "string"
        seller:
          description: "This container returns basic information about the seller\
            \ of the item, such as name, feedback score, etc."
          $ref: "#/components/schemas/Seller"
        shippingOptions:
          type: "array"
          description: "This container returns the shipping options available to ship\
            \ the item."
          items:
            $ref: "#/components/schemas/ShippingOptionSummary"
        shortDescription:
          type: "string"
          description: "This text string is derived from the item condition and the\
            \ item aspects (such as size, color, capacity, model, brand, etc.) Sometimes\
            \ the title does not provide enough information but the description is\
            \ too big. Surfacing the <code>shortDescription</code> can often provide\
            \ buyers with the additional information that could help them make a buying\
            \ decision.<br><br>For example:<pre>\"<b>title</b>\": \"Petrel U42W FPV\
            \ Drone RC Quadcopter w/HD Camera Live Video One Key Off / Landing\",<br>\"\
            <b>shortDescription</b>\": \"1 U42W Quadcopter. Syma X5SW-V3 Wifi FPV\
            \ RC Drone Quadcopter 2.4Ghz 6-Axis Gyro with Headless Mode. Syma X20\
            \ Pocket Drone 2.4Ghz Mini RC Quadcopter Headless Mode Altitude Hold.\
            \ One Key Take Off / Landing function: allow beginner to easy to fly the\
            \ drone without any skill.\",</pre><br><b>Restriction:</b> This field\
            \ is returned by the <b>search</b> method only when <code>fieldgroups</code>\
            \ = <code>EXTENDED</code>."
        thumbnailImages:
          type: "array"
          description: "An array of thumbnail images for the item."
          items:
            $ref: "#/components/schemas/Image"
        title:
          type: "string"
          description: "The seller-created title of the item.<br><br><b>Maximum Length:</b>\
            \ 80 characters"
        topRatedBuyingExperience:
          type: "boolean"
          description: "This indicates if the item is a top-rated plus item. There\
            \ are three benefits of a top-rated plus item: a  minimum 30-day money-back\
            \ return policy; shipping the item in 1 business day with tracking provided;\
            \ and the added comfort of knowing that this item is from an experienced\
            \ seller with the highest buyer ratings. For more information, refer to\
            \ <a href=\"https://pages.ebay.com/topratedplus/index.html \" target=\"\
            _blank\">Look for Top Rated Plus Items</a> and <a href=\"https://www.ebay.com/help/selling/seller-levels-performance-standards/seller-levels-performance-standards?id=4080\
            \ \" target=\"_blank\">Seller performance overview</a>."
        tyreLabelImageUrl:
          type: "string"
          description: "The URL to the image that shows the information on the tyre\
            \ label."
        unitPrice:
          description: "The price per unit for the item. Some European countries require\
            \ listings for certain types of products to include the price per unit\
            \ so buyers can accurately compare prices.<br><br>For example:<pre>\"\
            unitPricingMeasure\": \"100g\",<br> \"unitPrice\": {<br>&nbsp;&nbsp;\"\
            value\": \"7.99\",<br>&nbsp;&nbsp;\"currency\": \"GBP\"</pre>"
          $ref: "#/components/schemas/ConvertedAmount"
        unitPricingMeasure:
          type: "string"
          description: "The designation, such as size, weight, volume, count, etc.,\
            \ that was used to specify the quantity of the item. This helps buyers\
            \ compare prices.<br><br>For example, the following tells the buyer that\
            \ the item is 7.99 per 100 grams.<pre>\"unitPricingMeasure\": \"100g\"\
            ,<br> \"unitPrice\": {<br>&nbsp;&nbsp;\"value\": \"7.99\",<br>&nbsp;&nbsp;\"\
            currency\": \"GBP\"</pre>"
        watchCount:
          type: "integer"
          description: "The number of users that have added the item to their watch\
            \ list.<br><br><span class=\"tablenote\"><b>Note:</b> This field is restricted\
            \ to applications that have been granted permission to access this feature.\
            \ You must submit an <a href=\"/my/support/tickets?tab=app-check \" target=\"\
            _blank\">App Check ticket</a> to request this access. In the App Check\
            \ form, add a note to the <b>Application Title/Summary</b> and/or <b>Application\
            \ Details</b> fields indicating that you want access to Watch Count data\
            \ in the Browse API.</span>"
          format: "int32"
      description: "The type that defines the fields for the details of a specific\
        \ item."
    Items:
      type: "object"
      properties:
        items:
          type: "array"
          description: "An arraylist of all the items."
          items:
            $ref: "#/components/schemas/CoreItem"
        total:
          type: "integer"
          description: "The total number of items retrieved."
          format: "int32"
        warnings:
          type: "array"
          description: "An array of warning messages. These types of errors do not\
            \ prevent the method from executing but should be checked."
          items:
            $ref: "#/components/schemas/Error"
      description: "Container for a list of items."
    LegalAddress:
      type: "object"
      properties:
        addressLine1:
          type: "string"
          description: "The first line of the street address."
        addressLine2:
          type: "string"
          description: "The second line of the street address. This field is not always\
            \ used, but can be used for 'Suite Number' or 'Apt Number'."
        city:
          type: "string"
          description: "The city of the address."
        country:
          type: "string"
          description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
            \ \" target=\"_blank\">ISO 3166</a> standard code for the country of the\
            \ address. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay\
            \ API documentation</a>"
        countryName:
          type: "string"
          description: "The name of the country of the address."
        county:
          type: "string"
          description: "The name of the county of the address."
        postalCode:
          type: "string"
          description: "The postal code of the address."
        stateOrProvince:
          type: "string"
          description: "The state or province of the address."
      description: "Type that defines the fields for the seller's address."
    MarketingPrice:
      type: "object"
      properties:
        discountAmount:
          description: "This container returns the monetary amount of the seller discount."
          $ref: "#/components/schemas/ConvertedAmount"
        discountPercentage:
          type: "string"
          description: "This field expresses the percentage of the seller discount\
            \ based on the value in the <code>originalPrice</code> container."
        originalPrice:
          description: "This container returns the monetary amount of the item without\
            \ the discount."
          $ref: "#/components/schemas/ConvertedAmount"
        priceTreatment:
          type: "string"
          description: "Indicates the pricing treatment (discount) that was applied\
            \ to the price of the item.<br><br><span class=\"tablenote\"><b>Note:</b>\
            \ The pricing treatment affects the way and where the discounted price\
            \ can be displayed.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PriceTreatmentEnum'>eBay\
            \ API documentation</a>"
      description: "The type that defines the fields that describe a seller discount."
    PaymentMethod:
      type: "object"
      properties:
        paymentMethodType:
          type: "string"
          description: "The payment method type, such as credit card or cash. For\
            \ implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PaymentMethodTypeEnum'>eBay\
            \ API documentation</a>"
        paymentMethodBrands:
          type: "array"
          description: "The payment method brands, including the payment method brand\
            \ type and logo image."
          items:
            $ref: "#/components/schemas/PaymentMethodBrand"
        paymentInstructions:
          type: "array"
          description: "The payment instructions for the buyer, such as <i>cash in\
            \ person</i> or <i>contact seller</i>."
          items:
            type: "string"
            description: " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PaymentInstructionEnum'>eBay\
              \ API documentation</a>"
        sellerInstructions:
          type: "array"
          description: "The seller instructions to the buyer, such as <i>accepts credit\
            \ cards</i> or <i>see description</i>."
          items:
            type: "string"
            description: " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:SellerInstructionEnum'>eBay\
              \ API documentation</a>"
    PaymentMethodBrand:
      type: "object"
      properties:
        paymentMethodBrandType:
          type: "string"
          description: "The payment method brand, such as Visa or PayPal. For implementation\
            \ help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:PaymentMethodBrandEnum'>eBay\
            \ API documentation</a>"
        logoImage:
          description: "The details of the logo image, such as the size and URL.<br><br><span\
            \ class=\"tablenote\"> <b> Note: </b> Currently, only the <b>imageUrl</b>\
            \ is populated.</span>"
          $ref: "#/components/schemas/Image"
    PickupOptionSummary:
      type: "object"
      properties:
        pickupLocationType:
          type: "string"
          description: "This container returns the local pickup options available\
            \ to the buyer. Possible values are <code>ARRANGED_LOCATION</code> and\
            \ <code>STORE</code>."
      description: "The type that defines the fields for the local pickup options\
        \ that are available for the item. It is used by the <code>pickupOptions</code>\
        \ container."
    Product:
      type: "object"
      properties:
        additionalImages:
          type: "array"
          description: "An array of containers with the URLs for the product images\
            \ that are in addition to the primary image. "
          items:
            $ref: "#/components/schemas/Image"
        additionalProductIdentities:
          type: "array"
          description: "An array of product identifiers associated with the item.\
            \ This container is returned if the seller has associated the eBay Product\
            \ Identifier (ePID) with the item and in the request <b> fieldgroups</b>\
            \ is set to <code>PRODUCT</code>."
          items:
            $ref: "#/components/schemas/AdditionalProductIdentity"
        aspectGroups:
          type: "array"
          description: "An array of containers for the product aspects. Each group\
            \ contains the aspect group name and the aspect name/value pairs."
          items:
            $ref: "#/components/schemas/AspectGroup"
        brand:
          type: "string"
          description: "The brand associated with product. To identify the product,\
            \ this is always used along with MPN (manufacturer part number)."
        description:
          type: "string"
          description: "The rich description of an eBay product, which might contain\
            \ HTML."
        gtins:
          type: "array"
          description: "An array of all the possible GTINs values associated with\
            \ the product. A GTIN is a unique Global Trade Item number of the item\
            \ as defined by <a href=\"https://www.gtin.info \" target=\"_blank\">https://www.gtin.info</a>.\
            \ This can be a UPC (Universal Product Code), EAN (European Article Number),\
            \ or an ISBN (International Standard Book Number) value."
          items:
            type: "string"
        image:
          description: "The primary image of the product. This is often a stock photo."
          $ref: "#/components/schemas/Image"
        mpns:
          type: "array"
          description: "An array of all possible MPN values associated with the product.\
            \ A MPNs is manufacturer part number of the product. To identify the product,\
            \ this is always used along with brand."
          items:
            type: "string"
        title:
          type: "string"
          description: "The title of the product."
      description: "The type that defines the fields for the product information of\
        \ the item."
    ProductIdentity:
      type: "object"
      properties:
        identifierType:
          type: "string"
          description: "The type of product identifier, such as UPC and EAN."
        identifierValue:
          type: "string"
          description: "The product identifier value."
      description: "The type that defines the fields for the product identifier type/value\
        \ pairs of product associated with an item."
    ProductSafetyLabelPictogram:
      type: "object"
      properties:
        pictogramDescription:
          type: "string"
          description: "The description of the safety label pictogram."
        pictogramId:
          type: "string"
          description: "The identifier of the safety label pictogram."
        pictogramUrl:
          type: "string"
          description: "The URL of the safety label pictogram."
      description: "This type is used to provide product safety pictogram(s) for the\
        \ listing."
    ProductSafetyLabelStatement:
      type: "object"
      properties:
        statementDescription:
          type: "string"
          description: "A description of the nature of the product safety label statement."
        statementId:
          type: "string"
          description: "The identifier of the product safety label statement."
      description: "This type is used to describe the seller provided product safety\
        \ label statement."
    ProductSafetyLabels:
      type: "object"
      properties:
        pictograms:
          type: "array"
          description: "An array of seller provided comma-separated string values\
            \ that provides identifier, URL, and description for one or more pictograms\
            \ associated with the listing."
          items:
            $ref: "#/components/schemas/ProductSafetyLabelPictogram"
        statements:
          type: "array"
          description: "An array of seller provided comma-separated string values\
            \ that provide identifier and description for one or more product safety\
            \ statements associated with the listing."
          items:
            $ref: "#/components/schemas/ProductSafetyLabelStatement"
      description: "This type contains seller provided product safety pictograms and\
        \ statements for the listing."
    RatingHistogram:
      type: "object"
      properties:
        count:
          type: "integer"
          description: "The total number of user ratings that the product has received."
          format: "int32"
        rating:
          type: "string"
          description: "This is the average rating for the product. As part of a product\
            \ review, users rate the product. Products are rated from one star (terrible)\
            \ to five stars (excellent), with each star having a corresponding point\
            \ value - one star gets 1 point, two stars get 2 points, and so on. If\
            \ a product had one four-star rating and one five-star rating, its average\
            \ rating would be <code> 4.5</code>, and this is the value that would\
            \ appear in this field."
      description: "The type that defines the fields for product ratings. Only products\
        \ that are in the eBay product catalog can be reviewed and rated."
    Refinement:
      type: "object"
      properties:
        aspectDistributions:
          type: "array"
          description: "An array of containers for the all the aspect refinements."
          items:
            $ref: "#/components/schemas/AspectDistribution"
        buyingOptionDistributions:
          type: "array"
          description: "An array of containers for the all the buying option refinements."
          items:
            $ref: "#/components/schemas/BuyingOptionDistribution"
        categoryDistributions:
          type: "array"
          description: "An array of containers for the all the category refinements."
          items:
            $ref: "#/components/schemas/CategoryDistribution"
        conditionDistributions:
          type: "array"
          description: "An array of containers for the all the condition refinements."
          items:
            $ref: "#/components/schemas/ConditionDistribution"
        dominantCategoryId:
          type: "string"
          description: "The identifier of the category that most of the items are\
            \ part of. "
      description: "This type defines the fields for the various refinements of an\
        \ item. You can use the information in this container to create histograms,\
        \ which help shoppers choose exactly what they want."
    Region:
      type: "object"
      properties:
        regionName:
          type: "string"
          description: "A localized text string that indicates the name of the region.\
            \ Taxes are generally charged at the state/province level or at the country\
            \ level in the case of VAT tax. "
        regionType:
          type: "string"
          description: "An enumeration value that indicates the type of region for\
            \ the tax jurisdiction. <br><br><b> Valid Values: </b> <ul><li><b> STATE_OR_PROVINCE\
            \ </b> - Indicates the region is a state or province within a country,\
            \ such as California or New York in the US, or Ontario or Alberta in Canada.</li><li><b>\
            \ COUNTRY </b> - Indicates the region is a single country.</li></ul> \
            \ Code so that your app gracefully handles any future changes to this\
            \ list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:RegionTypeEnum'>eBay\
            \ API documentation</a>"
      description: "This type is used to provide region details for a tax jurisdiction."
    ResponsiblePerson:
      type: "object"
      properties:
        addressLine1:
          type: "string"
          description: "The first line of the Responsible Person's street address."
        addressLine2:
          type: "string"
          description: "The second line of the Responsible Person's address. This\
            \ field is not always used, but can be used for secondary address information\
            \ such as 'Suite Number' or 'Apt Number'."
        city:
          type: "string"
          description: "The city of the Responsible Person's street address."
        companyName:
          type: "string"
          description: "The name of the Responsible Person or entity."
        contactUrl:
          type: "string"
          description: "The contact URL of the Responsible Person or entity."
        country:
          type: "string"
          description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
            \ \" target=\"_blank\">ISO 3166</a> standard of the country of the address.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay\
            \ API documentation</a>"
        countryName:
          type: "string"
          description: "The country name of the Responsible Person's street address."
        county:
          type: "string"
          description: "The county of the Responsible Person's street address."
        email:
          type: "string"
          description: "The email of the Responsible Person's street address."
        phone:
          type: "string"
          description: "The phone number of the Responsible Person's street address."
        postalCode:
          type: "string"
          description: "The postal code of the Responsible Person's street address."
        stateOrProvince:
          type: "string"
          description: "The state or province of the Responsible Person's street address."
        types:
          type: "array"
          description: "The type(s) associated with the Responsible Person or entity."
          items:
            type: "string"
            description: " For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ResponsiblePersonTypeEnum'>eBay\
              \ API documentation</a>"
      description: "This type provides information, such as name and contact details,\
        \ for an EU-based Responsible Person or entity, associated with the product."
    ReviewRating:
      type: "object"
      properties:
        averageRating:
          type: "string"
          description: "The average rating given to a product based on customer reviews."
        ratingHistograms:
          type: "array"
          description: "An array of containers for the product rating histograms that\
            \ shows the review counts and the product rating."
          items:
            $ref: "#/components/schemas/RatingHistogram"
        reviewCount:
          type: "integer"
          description: "The total number of reviews for the item."
          format: "int32"
      description: "The type that defines the fields for the rating of a product review."
    SearchByImageRequest:
      type: "object"
      properties:
        image:
          type: "string"
          description: "The Base64 string of the image.<br><br>To get the Base64 image\
            \ string, you can use sites such as <a href=\"https://codebeautify.org/image-to-base64-converter\
            \ \" target=\"_blank\">https://codebeautify.org/image-to-base64-converter</a>."
      description: "The type that defines the fields for the image information."
    SearchPagedCollection:
      type: "object"
      properties:
        autoCorrections:
          description: "The auto-corrected inputs."
          $ref: "#/components/schemas/AutoCorrections"
        href:
          type: "string"
          description: "The URI of the current page of results.<br><br>The following\
            \ example of the <b>search</b> method returns items 1 thru 5 from the\
            \ list of items found.<pre>https://api.ebay.com/buy/v1/item_summary/search?q=shirt&limit=5&offset=0</pre>"
        itemSummaries:
          type: "array"
          description: "An array of the items on this page. The items are sorted according\
            \ to the sorting method specified in the request."
          items:
            $ref: "#/components/schemas/ItemSummary"
        limit:
          type: "integer"
          description: "The value of the <code>limit</code> parameter submitted in\
            \ the request, which is the maximum number of items to return on a page,\
            \ from the result set. A result set is the complete set of items returned\
            \ by the method."
          format: "int32"
        next:
          type: "string"
          description: "The URI for the next page of results. This value is returned\
            \ if there is an additional page of results to return from the result\
            \ set.<br><br>The following example of the <b>search</b> method returns\
            \ items 5 thru 10 from the list of items found.<pre>https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=10</pre>"
        offset:
          type: "integer"
          description: "This value indicates the <code>offset</code> used for current\
            \ page of items being returned. Assume the initial request used an <code>offset</code>\
            \ of <code>0</code> and a <code>limit</code> of <code>3</code>. Then in\
            \ the first page of results, this value would be <code>0</code>, and items\
            \ 1-3 are returned. For the second page, this value is <code>3</code>\
            \ and so on."
          format: "int32"
        prev:
          type: "string"
          description: "The URI for the previous page of results. This is returned\
            \ if there is a previous page of results from the result set.<br><br>The\
            \ following example of the <b>search</b> method returns items 1 thru 5\
            \ from the list of items found, which would be the first set of items\
            \ returned.<pre>https://api.ebay.com/buy/v1/item_summary/search?query=t-shirts&limit=5&offset=0</pre>"
        refinement:
          description: "The container for all the search refinements."
          $ref: "#/components/schemas/Refinement"
        total:
          type: "integer"
          description: "The total number of items that match the input criteria.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> <code>total</code> is just an indicator\
            \ of the number of listings for a given query. It could vary based on\
            \ the number of listings with variations included in the result. It is\
            \ strongly recommended that <code>total</code> not be used in pagination\
            \ use cases. Instead, use <a href=\"/api-docs/buy/browse/resources/item_summary/methods/search#response.next\
            \ \">next</a> to determine the results on the next page.</span>"
          format: "int32"
        warnings:
          type: "array"
          description: "The container with all the warnings for the request."
          items:
            $ref: "#/components/schemas/Error"
      description: "The type that defines the fields for a paginated result set. The\
        \ response consists of 0 or more sequenced <i>pages</i> where each page has\
        \ 0 or more items."
    Seller:
      type: "object"
      properties:
        feedbackPercentage:
          type: "string"
          description: "The percentage of the total positive feedback."
        feedbackScore:
          type: "integer"
          description: "The feedback score of the seller. This value is based on the\
            \ ratings from eBay members that bought items from this seller."
          format: "int32"
        sellerAccountType:
          type: "string"
          description: "Indicates if the seller is a business or an individual. This\
            \ is determined when the seller registers with eBay:<ul><li>If they register\
            \ for a business account, this value will be <code>BUSINESS</code>.</li><li>If\
            \ they register for a private account, this value will be <code>INDIVIDUAL</code>.</li></ul>This\
            \ designation is required by the tax laws in some countries.<br><br>This\
            \ field is returned only on the following sites:<br><br>EBAY_AT, EBAY_BE,\
            \ EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL<br><br><b>Valid\
            \ Values:</b> <code>BUSINESS</code> or <code>INDIVIDUAL</code>"
        username:
          type: "string"
          description: "The user name created by the seller for use on eBay."
      description: "The type that defines the fields for basic information about the\
        \ seller of the item returned by the <code>item_summary</code> resource."
    SellerCustomPolicy:
      type: "object"
      properties:
        description:
          type: "string"
          description: "The seller-defined description of the policy."
        label:
          type: "string"
          description: "The seller-defined label for an individual custom policy."
        type:
          type: "string"
          description: "The type of custom policy, such as PRODUCT_COMPLIANCE or TAKE_BACK.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:SellerCustomPolicyTypeEnum'>eBay\
            \ API documentation</a>"
      description: "The container for custom policies that apply to a listed item."
    SellerDetail:
      type: "object"
      properties:
        feedbackPercentage:
          type: "string"
          description: "The percentage of the total positive feedback."
        feedbackScore:
          type: "integer"
          description: "The feedback score of the seller. This value is based on the\
            \ ratings from eBay members that bought items from this seller."
          format: "int32"
        sellerAccountType:
          type: "string"
          description: "This indicates if the seller is a business or an individual.\
            \ This is determined when the seller registers with eBay. If they register\
            \ for a business account, this value will be BUSINESS. If they register\
            \ for a private account, this value will be INDIVIDUAL. This designation\
            \ is required by the tax laws in the following countries:  <br><br> This\
            \ field is returned only on the following sites. <br><br>EBAY_AT, EBAY_BE,\
            \ EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, EBAY_PL\
            \ <br><br><b> Valid Values:</b> BUSINESS or INDIVIDUAL <br><br>Code so\
            \ that your app gracefully handles any future changes to this list. "
        sellerLegalInfo:
          description: "The container with the seller's contact info and fields that\
            \ are required by law."
          $ref: "#/components/schemas/SellerLegalInfo"
        userId:
          type: "string"
          description: "The unique identifier of an eBay user across all eBay sites.\
            \ This value does not change, even when a user changes their username."
        username:
          type: "string"
          description: "The user name created by the seller for use on eBay."
      description: "The type that defines the fields for basic and detailed information\
        \ about the seller of the item returned by the <b> item</b> resource."
    SellerLegalInfo:
      type: "object"
      properties:
        email:
          type: "string"
          description: "The seller's business email address."
        fax:
          type: "string"
          description: "The seller' business fax number."
        imprint:
          type: "string"
          description: "This is a free-form string created by the seller. This is\
            \ information often found on business cards, such as address. This is\
            \ information used by some countries."
        legalContactFirstName:
          type: "string"
          description: "The seller's first name."
        legalContactLastName:
          type: "string"
          description: "The seller's last name."
        name:
          type: "string"
          description: "The name of the seller's business."
        phone:
          type: "string"
          description: "The seller's business phone number."
        registrationNumber:
          type: "string"
          description: "The seller's registration number. This is information used\
            \ by some countries."
        sellerProvidedLegalAddress:
          description: "The container that returns the seller's address to be used\
            \ to contact them."
          $ref: "#/components/schemas/LegalAddress"
        termsOfService:
          type: "string"
          description: "This is a free-form string created by the seller. This is\
            \ the seller's terms or condition, which is in addition to the seller's\
            \ return policies."
        vatDetails:
          type: "array"
          description: "An array of the seller's VAT (value added tax) IDs and the\
            \ issuing country. VAT is a tax added by some European countries."
          items:
            $ref: "#/components/schemas/VatDetail"
        economicOperator:
          description: "Provides required information about the manufacturer and/or\
            \ supplier of the item."
          $ref: "#/components/schemas/EconomicOperator"
        weeeNumber:
          type: "string"
          description: "The Waste Electrical and Electronic Equipment (WEEE) registration\
            \ number required for any seller to place electrical and electronic equipment\
            \ on the market in Germany. This manufacturer number is assigned to the\
            \ first distributors of electrical and electronic equipment and comprises\
            \ a country code and an 8-digit sequence of digits (e.g. “WEEE Reg. No.\
            \ DE 12345678”)."
      description: "The type that defines the fields for the contact information for\
        \ a seller."
    ShipToLocation:
      type: "object"
      properties:
        country:
          type: "string"
          description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
            \ \" target=\"_blank\">ISO 3166</a> standard of the country for where\
            \ the item is to be shipped. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay\
            \ API documentation</a>"
        postalCode:
          type: "string"
          description: "The zip code (postal code) for where the item is to be shipped."
      description: "The type that defines the fields for the country and postal code\
        \ of where an item is to be shipped."
    ShipToLocations:
      type: "object"
      properties:
        regionExcluded:
          type: "array"
          description: "An array of containers that express the large geographical\
            \ regions, countries, state/provinces, or special locations within a country\
            \ where the seller is not willing to ship to."
          items:
            $ref: "#/components/schemas/ShipToRegion"
        regionIncluded:
          type: "array"
          description: "An array of containers that express the large geographical\
            \ regions, countries, or state/provinces within a country where the seller\
            \ is willing to ship to. Prospective buyers must look at the shipping\
            \ regions under this container, as well as the shipping regions that are\
            \ under the <b>regionExcluded</b> to see where the seller is willing to\
            \ ship items. Sellers can specify that they ship 'Worldwide', but then\
            \ add several large geographical regions (e.g. Asia, Oceania, Middle East)\
            \ to the exclusion list, or sellers can specify that they ship to Europe\
            \ and Africa, but then add several individual countries to the exclusion\
            \ list."
          items:
            $ref: "#/components/schemas/ShipToRegion"
      description: "The type that defines the fields that include and exclude geographic\
        \ regions affecting where the item can be shipped. The seller defines these\
        \ regions when listing the item."
    ShipToRegion:
      type: "object"
      properties:
        regionId:
          type: "string"
          description: "The unique identifier of the shipping region. The value returned\
            \ here is dependent on the corresponding <b>regionType</b> value. The\
            \ <b>regionId</b> value for a region does not vary based on the eBay marketplace.\
            \ However, the corresponding <b>regionName</b> value for a region is a\
            \ localized, text-based description of the shipping region. <br><br> If\
            \ the <b>regionType</b> value is <code>WORLDWIDE</code>, the <b>regionId</b>\
            \ value will also be <code>WORLDWIDE</code>.<br><br> If the <b>regionType</b>\
            \ value is <code>WORLD_REGION</code>, the <b>regionId</b> value will be\
            \ one of the following: <code>AFRICA</code>, <code>AMERICAS</code>, <code>ASIA</code>,\
            \ <code>AUSTRALIA</code>, <code>CENTRAL_AMERICA_AND_CARIBBEAN</code>,\
            \ <code>EUROPE</code>, <code>EUROPEAN_UNION</code>, <code>GREATER_CHINA</code>,\
            \ <code>MIDDLE_EAST</code>, <code>NORTH_AMERICA</code>, <code>OCEANIA</code>,\
            \ <code>SOUTH_AMERICA</code>, <code>SOUTHEAST_ASIA</code> or <code>CHANNEL_ISLANDS</code>.<br><br>If\
            \ the <b>regionType</b> value is <code>COUNTRY</code>, the <b>regionId</b>\
            \ value will be the two-letter code for the country, as defined in the\
            \ <a href=\"https://www.iso.org/iso-3166-country-codes.html \" target=\"\
            _blank\">ISO 3166</a> standard.<br><br>If the <b>regionType</b> value\
            \ is <code>STATE_OR_PROVINCE</code>, the <b>regionId</b> value will either\
            \ be the two-letter code for US states and DC (as defined on this <a href=\"\
            https://www.ssa.gov/international/coc-docs/states.html \" target=\"_blank\"\
            >Social Security Administration</a> page), or the two-letter code for\
            \ Canadian provinces (as defined by this <a href=\"https://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp?ecid=murl10006450#1442131\
            \ \" target=\"_blank\">Canada Post</a> page).<br><br>If the <b>regionType</b>\
            \ value is <code>COUNTRY_REGION</code>, the <b>regionId</b> value may\
            \ be one of following: <code>_AH</code> (if a seller is not willing to\
            \ ship to Alaska/Hawaii), <code>_PR</code> (if the seller is not willing\
            \ to ship to US Protectorates), <code>_AP</code> (if seller is not willing\
            \ to ship to a US Army or Fleet Post Office), and <code>PO_BOX</code>\
            \ (if the seller is not willing to ship to a Post Office Box)."
        regionName:
          type: "string"
          description: "A localized text string that indicates the name of the shipping\
            \ region. The value returned here is dependent on the corresponding <b>regionType</b>\
            \ value. <br><br> If the <b>regionType</b> value is <code>WORLDWIDE</code>,\
            \ the <b>regionName</b> value will show <code>Worldwide</code>.<br><br>\
            \ If the <b>regionType</b> value is <code>WORLD_REGION</code>, the <b>regionName</b>\
            \ value will be a localized text string for one of the following large\
            \ geographical regions: Africa, Americas, Asia, Australia, Central America\
            \ and Caribbean, Europe, European Union, Greater China, Middle East, North\
            \ America, Oceania, South America, Southeast Asia, or Channel Islands.<br><br>If\
            \ the <b>regionType</b> value is <code>COUNTRY</code>, the <b>regionName</b>\
            \ value will be a localized text string for any country in the world.<br><br>If\
            \ the <b>regionType</b> value is <code>STATE_OR_PROVINCE</code>, the <b>regionName</b>\
            \ value will be a localized text string for any US state or Canadian province.\
            \ <br><br>If the <b>regionType</b> value is <code>COUNTRY_REGION</code>,\
            \ the <b>regionName</b> value may be a localized version of one of the\
            \ following: Alaska/Hawaii, US Protectorates, APO/FPO (Army or Fleet Post\
            \ Office), or PO BOX."
        regionType:
          type: "string"
          description: "An enumeration value that indicates the level or type of shipping\
            \ region. <br><br><b> Valid Values: </b> <ul><li><b> COUNTRY_REGION </b>\
            \ - Indicates the region is a domestic region or special location within\
            \ a country.</li><li><b> STATE_OR_PROVINCE </b> - Indicates the region\
            \ is a state or province within a country, such as California or New York\
            \ in the US, or Ontario or Alberta in Canada.</li><li><b> COUNTRY </b>\
            \ - Indicates the region is a single country.</li><li><b> WORLD_REGION\
            \ </b> - Indicates the region is a world region, such as Africa, the Middle\
            \ East, or Southeast Asia.</li><li><b> WORLDWIDE </b> - Indicates the\
            \ region is the entire world. This value is only applicable for included\
            \ shiping regions, and not excluded shipping regions.</li></ul> For more\
            \ detail on the actual <b>regionName</b>/<b>regionId</b> values that will\
            \ be returned based on the <b>regionType</b> value, see the <a href=\"\
            /api-docs/buy/browse/resources/item/methods/getItem#response.shipToLocations.regionExcluded.regionId\"\
            >regionId</a> and/or <a href=\"/api-docs/buy/browse/resources/item/methods/getItem#response.shipToLocations.regionExcluded.regionName\"\
            >regionName</a> field descriptions.<br><br> Code so that your app gracefully\
            \ handles any future changes to this list. For implementation help, refer\
            \ to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:RegionTypeEnum'>eBay\
            \ API documentation</a>"
      description: "This type is used provide details about included and excluded\
        \ shipping regions."
    ShippingOption:
      type: "object"
      properties:
        additionalShippingCostPerUnit:
          description: "Any per item additional shipping costs for a multi-item purchase.\
            \ For example, let's say the shipping cost for a power cord is $3. But\
            \ for an additional cord, the shipping cost is only $1. So if you bought\
            \ 3 cords, the <b> shippingCost</b> would be $3 and this value would be\
            \ $2 ($1 for each additional item)."
          $ref: "#/components/schemas/ConvertedAmount"
        cutOffDateUsedForEstimate:
          type: "string"
          description: "The deadline date that the item must be purchased by in order\
            \ to be received by the buyer within the delivery window (<b> maxEstimatedDeliveryDate</b>\
            \ and  <b> minEstimatedDeliveryDate</b> fields). This field is returned\
            \ only for items that are eligible for 'Same Day Handling'. For these\
            \ items, the value of this field is what is displayed in the <b> Delivery</b>\
            \ line on the View Item page.  <br><br>This value is returned in UTC format\
            \ (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time\
            \ of the buyer."
        fulfilledThrough:
          type: "string"
          description: "If the item is being shipped by the eBay <a href=\"https://pages.ebay.com/seller-center/shipping/global-shipping-program.html\
            \ \">Global Shipping program</a>, this field returns <code>GLOBAL_SHIPPING</code>.<br><br>If\
            \ the item is being shipped using the eBay International Shipping program,\
            \ this field returns <code>INTERNATIONAL_SHIPPING</code>. <br><br>Otherwise,\
            \ this field is null. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:FulfilledThroughEnum'>eBay\
            \ API documentation</a>"
        guaranteedDelivery:
          type: "boolean"
          description: "Although this field is still returned, it can be ignored since\
            \ eBay Guaranteed Delivery is no longer a supported feature on any marketplace.\
            \ This field may get removed from the schema in the future."
        importCharges:
          description: "The <a href=\"https://pages.ebay.com/seller-center/shipping/global-shipping-program.html\
            \ \">Global Shipping Program</a> import charges for this item."
          $ref: "#/components/schemas/ConvertedAmount"
        maxEstimatedDeliveryDate:
          type: "string"
          description: "The end date of the delivery window (latest projected delivery\
            \ date).  This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ),\
            \ which you can convert into the local time of the buyer. <br> <br> <span\
            \ class=\"tablenote\"> <b> Note: </b> For the best accuracy, always include\
            \ the location of where the item is be shipped in the <code> contextualLocation</code>\
            \ values of the <a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
            > <code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span> "
        minEstimatedDeliveryDate:
          type: "string"
          description: "The start date of the delivery window (earliest projected\
            \ delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ),\
            \ which you can convert into the local time of the buyer. <br> <br><span\
            \ class=\"tablenote\"> <b> Note: </b> For the best accuracy, always include\
            \ the location of where the item is be shipped in the <code> contextualLocation</code>\
            \ values of the <a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
            > <code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span>"
        quantityUsedForEstimate:
          type: "integer"
          description: "The number of items used when calculating the estimation information.<br><br>This\
            \ field will reflect the value input in the <b>quantity_for_shipping_estimate</b>\
            \ query parameter."
          format: "int32"
        shippingCarrierCode:
          type: "string"
          description: "The name of the shipping provider, such as FedEx, or USPS."
        shippingCost:
          description: "The final shipping cost for all the items after all discounts\
            \ are applied.<br><br>This container will reflect the cost for the quantity\
            \ specified through the <b>quantity_for_shipping_estimate</b> query parameter.<br><br><span\
            \ class=\"tablenote\"><b> Note: </b>The cost does include the value-added\
            \ tax (VAT) for applicable jurisdictions when requested from supported\
            \ marketplaces. In this case, users must pass the <a href=\"/api-docs/static/rest-request-components.html#HTTP\"\
            ><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying the\
            \ supported marketplace (such as <code>EBAY_GB</code>) to see the VAT-inclusive\
            \ cost. For more information on VAT, refer to <a href=\"https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650&st=12&pos=1&query=Your%20VAT%20obligations%20in%20the%20EU&intent=VAT\"\
            >VAT Obligations in the EU</a>.</span>"
          $ref: "#/components/schemas/ConvertedAmount"
        shippingCostType:
          type: "string"
          description: "Indicates the class of the shipping cost. <br><br><b> Valid\
            \ Values: </b> FIXED or CALCULATED <br><br>Code so that your app gracefully\
            \ handles any future changes to this list. "
        shippingServiceCode:
          type: "string"
          description: "The type of shipping service. For example, USPS First Class."
        shipToLocationUsedForEstimate:
          description: "The container that returns the country and postal code of\
            \ where the item is to be shipped. These values come from the <code>contextualLocation</code>\
            \ values in the  <a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
            > <code>X-EBAY-C-ENDUSERCTX</code></a> request header. If the header is\
            \ not submitted, marketplace is used."
          $ref: "#/components/schemas/ShipToLocation"
        trademarkSymbol:
          type: "string"
          description: "Any trademark symbol, such as &#8482; or &reg;, that needs\
            \ to be shown in superscript next to the shipping service name."
        type:
          type: "string"
          description: "The type of a shipping option, such as EXPEDITED, ONE_DAY,\
            \ STANDARD, ECONOMY, PICKUP, etc."
      description: "The type that defines the fields for the details of a shipping\
        \ provider."
    ShippingOptionSummary:
      type: "object"
      properties:
        guaranteedDelivery:
          type: "boolean"
          description: "Although this field is still returned, it can be ignored since\
            \ eBay Guaranteed Delivery is no longer a supported feature on any marketplace.\
            \ This field may get removed from the schema in the future."
        maxEstimatedDeliveryDate:
          type: "string"
          description: "The end date of the delivery window (latest projected delivery\
            \ date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ),\
            \ which you can convert into the local time of the buyer.<br><br><span\
            \ class=\"tablenote\"> <b>Note: </b> For the best accuracy, always include\
            \ the <code>contextualLocation</code> values in the <a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
            \ target=\"_blank\"><code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span><br><span\
            \ class=\"tablenote\"> <b>Note: </b> Estimated delivery dates are not\
            \ returned for CBT items.</span>"
        minEstimatedDeliveryDate:
          type: "string"
          description: "The start date of the delivery window (earliest projected\
            \ delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ),\
            \ which you can convert into the local time of the buyer.<br><br><span\
            \ class=\"tablenote\"><b>Note:</b> For the best accuracy, always include\
            \ the <code>contextualLocation</code> values in the <a href=\"/api-docs/buy/static/api-browse.html#Headers\"\
            \ target=\"_blank\"><code>X-EBAY-C-ENDUSERCTX</code></a> request header.</span><br><span\
            \ class=\"tablenote\"> <b>Note: </b> Estimated delivery dates are not\
            \ returned for CBT items.</span>"
        shippingCost:
          description: "This is the estimated price to ship the item.<br><br>The price\
            \ includes the value-added tax (VAT) for applicable jurisdictions when\
            \ requested from supported marketplaces. In this case, users must do one\
            \ or more of the following to see VAT-inclusive pricing:<ul><li>Pass the\
            \ <a href=\"/api-docs/static/rest-request-components.html#HTTP\" target=\"\
            _blank\"><code>X-EBAY-C-MARKETPLACE-ID</code></a> request header specifying\
            \ the supported marketplace (such as <code>EBAY_GB</code>)</li><li>Pass\
            \ the <code>contextualLocation</code> values for the supported marketplace\
            \ in the <a href=\"/api-docs/buy/static/api-browse.html#Headers\"><code>X-EBAY-C-ENDUSERCTX</code></a>\
            \ request header</li><li>Specify the supported marketplace using the <a\
            \ href=\"/api-docs/buy/static/ref-buy-browse-filters.html#deliveryCountry\"\
            \ target=\"_blank\"><code>deliveryCountry</code></a> <b>filter</b> URI\
            \ parameter (such as <code>filter=deliveryCountry:GB</code>)</li></ul><span\
            \ class=\"tablenote\"><b>Note:</b>For more information on VAT, refer to\
            \ <a href=\"https://www.ebay.co.uk/help/listings/default/vat-obligations-eu?id=4650\
            \ \" target=\"_blank\">Your VAT Obligations in the UK &amp; EU</a>.</span>"
          $ref: "#/components/schemas/ConvertedAmount"
        shippingCostType:
          type: "string"
          description: "Indicates the type of shipping used to ship the item. Possible\
            \ values are <code>FIXED</code> (flat-rate shipping) and <code>CALCULATED</code>\
            \ (shipping cost calculated based on item and buyer location)."
      description: "The type that defines the fields for the shipping information."
    TargetLocation:
      type: "object"
      properties:
        unitOfMeasure:
          type: "string"
          description: "This value shows the unit of measurement used to measure the\
            \ distance between the location of the item and the buyer's location.\
            \ This value is typically <code> mi</code> or <code> km</code>."
        value:
          type: "string"
          description: "This value indicates the distance (measured in the measurement\
            \ unit in the <b> unitOfMeasure</b>  field) between the item location\
            \ and the buyer's location."
      description: "The type that defines the fields for the distance between the\
        \ item location and the buyer's location. "
    TaxJurisdiction:
      type: "object"
      properties:
        region:
          description: "The region of the tax jurisdiction."
          $ref: "#/components/schemas/Region"
        taxJurisdictionId:
          type: "string"
          description: "The identifier of the tax jurisdiction."
      description: "The type that defines the fields for the tax jurisdiction details."
    Taxes:
      type: "object"
      properties:
        ebayCollectAndRemitTax:
          type: "boolean"
          description: "This field is only returned if <code>true</code>, and indicates\
            \ that eBay will collect tax (sales tax, Goods and Services tax, or VAT)\
            \ for at least one line item in the order, and remit the tax to the taxing\
            \ authority of the buyer's residence. "
        includedInPrice:
          type: "boolean"
          description: "This indicates if tax was applied for the cost of the item."
        shippingAndHandlingTaxed:
          type: "boolean"
          description: "This indicates if tax is applied for the shipping cost."
        taxJurisdiction:
          description: "The container that returns the tax jurisdiction."
          $ref: "#/components/schemas/TaxJurisdiction"
        taxPercentage:
          type: "string"
          description: "The percentage of tax."
        taxType:
          type: "string"
          description: "This field indicates the type of tax that may be collected\
            \ for the item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:TaxType'>eBay\
            \ API documentation</a>"
      description: "The type that defines the tax fields."
    TimeDuration:
      type: "object"
      properties:
        unit:
          type: "string"
          description: "An enumeration value that indicates the units of the time\
            \ span (e.g., <code>HOURS</code>). The enumeration value in this field\
            \ defines the period of time being used to measure the duration.<br><br>Refer\
            \ to <a href=\"/api-docs/buy/browse/types/ba:TimeDurationUnitEnum\">TimeDurationUnitEnum</a>\
            \ for the list of supported values. For implementation help, refer to\
            \ <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:TimeDurationUnitEnum'>eBay\
            \ API documentation</a>"
        value:
          type: "integer"
          description: "Retrieves the duration of the time span (no units). The value\
            \ in this field indicates the number of years, months, days, hours, or\
            \ minutes in the defined period."
          format: "int32"
      description: "The type that defines the fields for a period of time in the time-measurement\
        \ units supplied."
    TypedNameValue:
      type: "object"
      properties:
        name:
          type: "string"
          description: "The text representing the name of the aspect for the name/value\
            \ pair, such as Color."
        type:
          type: "string"
          description: "This indicates if the value being returned is a string or\
            \ an array of values. <br><br><b> Valid Values: </b> <ul><li><b> STRING</b>\
            \ - Indicates the value returned is a string.</li>  <li><b> STRING_ARRAY</b>\
            \ - Indicates the value returned is an array of strings.</li></ul>  Code\
            \ so that your app gracefully handles any future changes to this list.\
            \ For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ValueTypeEnum'>eBay\
            \ API documentation</a>"
        value:
          type: "string"
          description: "The value of the aspect for the name/value pair, such as Red."
      description: "The type that defines the fields for the name/value pairs for\
        \ item aspects."
    VatDetail:
      type: "object"
      properties:
        issuingCountry:
          type: "string"
          description: "The two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html\
            \ \" target=\"_blank\">ISO 3166</a> standard of the country issuing the\
            \ seller's VAT (value added tax) ID. VAT is a tax added by some European\
            \ countries. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/ba:CountryCodeEnum'>eBay\
            \ API documentation</a>"
        vatId:
          type: "string"
          description: "The seller's VAT (value added tax) ID. VAT is a tax added\
            \ by some European countries."
      description: "The type the defines the fields for the VAT (value add tax) information."
  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.bulk: "Retrieve eBay items\
              \ in bulk."
            https://api.ebay.com/oauth/api_scope: "View public data from eBay"