ItemSummary

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ItemSummary",
  "title": "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."
    },
    "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</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=\"/devzone/finding/callref/enums/conditionIdList.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=\"/devzone/finding/callref/enums/conditionIdList.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 (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer."
    },
    "itemEndDate": {
      "type": "string",
      "description": "The date and time up to which the item can be purchased. 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> This field is not returned for Good 'Til Cancelled (GTC) listings.</span>"
    },
    "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"
    },
    "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."
}