The details of an item that can be purchased.
- Full name:
\SapientPro\EbayBrowseSDK\Models\Item - This class implements:
\SapientPro\EbayBrowseSDK\Models\EbayModelInterface
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 image.imageUrl field.
public ?array $additionalImagesA list of add-on services that may be selected for the item or that may apply automatically.
public ?array $addonServicesThis indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers.
public bool $adultOnly(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 localizedAspects container.
public ?string $ageGroupA container for information about whether an item, or the item group when returned for the getItemsByItemGroup method, is qualified for the Authenticity Guarantee program.
Note: The AUTHENTICITY_GUARANTEE value being returned by the getItemsByItemGroup 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 items.itemId value for that item and use the getItem 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 qualifiedPrograms array and authenticityGuarantee container in the getItem response for this information.
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.
Note: Refer to the Authenticity Guarantee page for more information.
public ?\SapientPro\EbayBrowseSDK\Models\AuthenticityGuaranteeProgram $authenticityGuaranteeA container for information about whether an item is from a verified seller.
public ?\SapientPro\EbayBrowseSDK\Models\AuthenticityVerificationProgram $authenticityVerificationA list of available coupons for the item.
public ?array $availableCouponsThis integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.
public ?int $bidCount(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 localizedAspects container.
public ?string $brandA comma separated list of all the purchase options available for the item. The values returned are:
FIXED_PRICE- Indicates the buyer can purchase the item for a set price using the Buy It Now button.AUCTION- 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.BEST_OFFER- 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 Making a Best Offer.CLASSIFIED_AD- Indicates that the final sales transaction is to be completed outside of the eBay environment.
public ?array $buyingOptionsThe ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children.
public string $categoryIdThe IDs of every category in the item path, separated by pipe characters, starting with the top level parent category.
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: 11700|159907|69197|115947.
public string $categoryIdPathText that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks
public string $categoryPath(Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container.
public ?string $colorA short text description for the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names.
Code so that your app gracefully handles any future changes to this list.
public ?string $conditionA full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item.
public ?string $conditionDescriptionThe identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names.
Code so that your app gracefully handles any future changes to this list.
public ?string $conditionIdThe 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.
public ?\SapientPro\EbayBrowseSDK\Models\ConvertedAmount $currentBidPriceThe full description of the item that was created by the seller. This can be plain text or rich content and can be very large.
public string $descriptionThe 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.
Currently, this value is required for electronic devices and furniture.
public ?\SapientPro\EbayBrowseSDK\Models\ConvertedAmount $ecoParticipationFeeThis field indicates if the item can be purchased using the Buy Order API.
- If the value of this field is
true, this indicates that the item can be purchased using the Order API. - If the value of this field is
false, this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.
public bool $eligibleForInlineCheckoutThis indicates if the item can be purchased using Guest Checkout in the Order API. You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards.
public bool $enabledForGuestCheckoutThis indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating.
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.
When the manufacturer's specifications for this item are available, the link to this information is returned in the productFicheWebUrl field.
public ?string $energyEfficiencyClassAn EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.
public ?string $epidThe 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.
public ?array $estimatedAvailabilities(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 localizedAspects container.
public ?string $genderThe unique Global Trade Item number of the item as defined by https://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.
public ?string $gtinHazardous materials labels for the item.
public ?\SapientPro\EbayBrowseSDK\Models\HazardousMaterialsLabels $hazardousMaterialsLabelsThe URL of the primary image of the item. The other images of the item are returned in the additionalImages container.
public \SapientPro\EbayBrowseSDK\Models\Image $imageThe 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.
If the seller provided an ePID for the item, the seller's value is returned in the epid field.
Note: This field is returned only for authorized Partners.
public ?string $inferredEpidThe URL to the View Item page of the item which includes the affiliate tracking ID.
Note: 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.
The itemAffiliateWebUrl is only returned if:
- The marketplace through which the item is being viewed is part of the eBay Partner Network. Currently Poland (
EBAY_PL) and Singapore (EBAY_SG) are not supported.
For additional information, refer to eBay Partner Network. - The seller enables affiliate tracking for the item by including the
X-EBAY-C-ENDUSERCTXrequest header in the method.
public ?string $itemAffiliateWebUrlA timestamp that indicates the date and time an item listing was created.
This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer.
public ?string $itemCreationDateThis timestamp indicates 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.
Note: This field is only returned for auction listings.
public ?string $itemEndDateThe unique RESTful identifier of the item.
public string $itemIdThe physical location of the item.
public ?\SapientPro\EbayBrowseSDK\Models\Address $itemLocationThe 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.
public string $itemWebUrlThe 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.
public string $legacyItemIdThe ID of the eBay marketplace where the item is listed. For implementation help, refer to eBay API documentation
public \SapientPro\EbayBrowseSDK\Enums\MarketplaceIdEnum $listingMarketplaceIdAn array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item.
public ?array $localizedAspectsThe number of items in a lot. In other words, a lot size is the number of items that are being sold together.
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.
| Item | Lot Definition | Lot Size |
|---|---|---|
| A package of 24 AA batteries | A box of 10 packages | 10 |
| A P235/75-15 Goodyear tire | 4 tires | 4 |
| Fashion Jewelry Rings | Package of 100 assorted rings | 100 |
Note: Lots are not supported in all categories.
public ?int $lotSizeThe original price and the discount amount and percentage.
public ?\SapientPro\EbayBrowseSDK\Models\MarketingPrice $marketingPrice(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 localizedAspects container.
public ?string $materialThe 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 Automatic bidding.
public ?\SapientPro\EbayBrowseSDK\Models\ConvertedAmount $minimumPriceToBidThe 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.
public ?string $mpn(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 localizedAspects container.
public ?string $patternThe payment methods for the item, including the payment method types, brands, and instructions for the buyer.
public ?array $paymentMethodsThe cost of just the item. This amount does not include any adjustments such as discounts or shipping costs.
Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.
public \SapientPro\EbayBrowseSDK\Models\ConvertedAmount $priceIndicates 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 eBay API documentation
public ?\SapientPro\EbayBrowseSDK\Enums\PriceDisplayConditionEnum $priceDisplayConditionThe 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.
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.
Note: This container is returned only if the item_id in the request is for an item group (items with variations, such as color and size).
public ?\SapientPro\EbayBrowseSDK\Models\ItemGroupSummary $primaryItemGroupThe container that returns the product rating details, such as review count, rating histogram, and average rating.
public ?\SapientPro\EbayBrowseSDK\Models\ReviewRating $primaryProductReviewRatingThis field is returned as true 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.
For more information, see Promoted Listings.
public bool $priorityListingThe container that returns the product information of the item.
public ?\SapientPro\EbayBrowseSDK\Models\Product $productThe 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 all items with an EEK rating and is returned only if this information is available. The EEK rating of the item is returned in the energyEfficiencyClass field.
public ?string $productFicheWebUrlAn array of the qualified programs available for the item, or for the item group when returned for the getItemsByItemGroup method, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION.
Note: The AUTHENTICITY_GUARANTEE value being returned by the getItemsByItemGroup 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 items.itemId value for that item and use the getItem 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 qualifiedPrograms array and authenticityGuarantee container in the getItem response for this information.
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.
Note: eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.
The eBay Authenticity Guarantee program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers.
public ?array $qualifiedProgramsThe maximum number for a specific item that one buyer can purchase.
public ?int $quantityLimitPerBuyerA 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.
Note: Support for this field is currently limited to the France marketplace.
public ?string $repairScoreThis 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.
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.
Note: This is returned only for auctions that have a reserve price.
public ?bool $reservePriceMetThe container that returns an overview of the seller's return policy.
public ?\SapientPro\EbayBrowseSDK\Models\ItemReturnTerms $returnTermsThe container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.
public \SapientPro\EbayBrowseSDK\Models\SellerDetail $sellerA list of the custom policies that are applied to a listing.
public ?array $sellerCustomPoliciesAn identifier generated/incremented when a seller revises the item. There are two types of item revisions:
- Seller changes, such as changing the title
- eBay system changes, such as changing the quantity when an item is purchased
public ?string $sellerItemRevisionAn array of shipping options containers that have the details about cost, carrier, etc. of one shipping option.
public array $shippingOptionsThe container that returns the geographic regions to be included and excluded that define where the item can be shipped.
public ?\SapientPro\EbayBrowseSDK\Models\ShipToLocations $shipToLocationsThis text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.).
public ?string $shortDescription(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 localizedAspects container.
public ?string $size(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container.
Valid Values:
AU (Australia),
BR (Brazil),
CN (China),
DE (Germany),
EU (European Union),
FR (France),
IT (Italy),
JP (Japan),
MX (Mexico),
US (USA),
UK (United Kingdom)
Code so that your app gracefully handles any future changes to this list.
public ?string $sizeSystem(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 localizedAspects container.
public ?string $sizeTypeA subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results.
public ?string $subtitleThe container for the tax information for the item.
public ?array $taxesThe seller-created title of the item.
Maximum Length: 80 characters
public string $titleThis 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 Top Rated Plus Items and Becoming a Top Rated Seller and qualifying for Top Rated Plus help topics for more information.
public ?bool $topRatedBuyingExperienceThe URL to the image that shows the information on the tyre label.
public ?string $tyreLabelImageUrlThis 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.
public ?int $uniqueBidderCountThis 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.
For example: "unitPricingMeasure": "100g",
"unitPrice": {
"value": "7.99",
"currency": "GBP"
public ?\SapientPro\EbayBrowseSDK\Models\ConvertedAmount $unitPriceThe designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices.
For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g",
"unitPrice": {
"value": "7.99",
"currency": "GBP"
public ?string $unitPricingMeasureAn array of warning messages. These types of errors do not prevent the method from executing but should be checked.
public ?array $warningsThe number of users that have added the item to their watch list.
Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to Watch Count data in the Browse API.
public ?int $watchCountAutomatically generated from source code comments on 2023-06-15 using phpDocumentor and saggre/phpdocumentor-markdown