Service/Ebay/Finding/Search/Item.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http:framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- http:framework.zend.com/license/new-bsd New BSD License
- Package
- Zend_Service
- Subpackage
- Ebay
- Version
- $Id: Item.php 22824 2010-08-09 18:59:54Z renanbr $
\Zend_Service_Ebay_Finding_Search_Item
Package: Zend_Service\Ebay
- Parent(s)
- \Zend_Service_Ebay_Finding_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- http:framework.zend.com/license/new-bsd New BSD License
- Uses
Properties
boolean $autoPay
If true, the seller requires immediate payment for the item. If false (or
not specified), immediate payment is not requested. Buyers must have a
PayPal account to purchase items that require immediate payment.
A seller can choose to require immediate payment for Fixed Price and Buy
It Now listings, including eBay Stores Inventory listings. If a Buy It
Now item ends as an auction (that is, if the Buy It Now option is removed
due to bids being placed on the listing), the immediate payment
requirement does not apply.
Details- Type
- boolean
integer $charityId
A unique identification number assigned by eBay to registered nonprofit
charity organizations.
Details
- Type
- integer
float $distance
The distance that the item is from the buyer, calculated usin
buyerPostalCode.
The unit for distance varies by site, and is either miles or kilometers.
If the country whose site you are searching uses kilometers to measure
distance (for example, India/EBAY-IN), the unit is kilometers. If the
site is either the US or UK, the distance unit is miles.
This value is only returned for distance-based searches. You must
specify a buyerPostalCode and either sort by Distance, or use a
combination of the MaxDistance LocalSearch itemFilters.
Details- Type
- float
string[] $galleryPlusPictureURL
URL for the Gallery Plus image.
The size of Gallery Plus images (up to 400 x 400 pixels) is bigger than
the size of standard gallery images. In site search results, you can view
the Gallery Plus image by hovering over or clicking the Enlarge link or
magifying glass icon. The image uses one of the following graphics
formats: JPEG, BMP, TIFF, or GIF. This field is only returned when the
seller has opted for the Gallery Plus option for the given item.
Details- Type
- string[]
string $galleryURL
URL for the Gallery thumbnail image.
The image must be provided in one of the following graphics formats:
JPEG, BMP, TIF, or GIF. Returned only if the seller chose to show a
gallery image.
Details- Type
- string
string $globalId
The identifier for the site on which the item is listed.
Returns a Global ID, which is a unique identifier that specifies the
combination of the site, language, and territory. In other eBay APIs
(such as the Shopping API), this value is know as the site ID.
Detailsstring $itemId
The ID that uniquely identifies the item listing.
eBay generates this ID when an item is listed. ID values are unique
across all eBay sites.
Details- Type
- string
\Zend_Service_Ebay_Finding_ListingInfo $listingInfo
The format type of the listing, such as online auction, fixed price, or
advertisement.
Details
string $location
Physical location of the item, as specified by the seller.
This gives a general indication from where the item will be shipped (or
delivered).
Details- Type
- string
string[] $paymentMethod
Identifies the payment method (or methods) the seller will accept for the
item (such as PayPal).
Payment methods are not applicable to eBay Real Estate advertisement
listings or other Classified Ad listing formats.
Detailsstring $postalCode
The postal code where the listed item is located.
This field is returned only if a postal code has been specified by the
seller. eBay proximity and local search behavior can use the combination
of buyerPostalCode and postalCode values.
Details- Type
- string
\Zend_Service_Ebay_Finding_Category $primaryCategory
Details about the first (or only) category in which the item is listed.
Note that items can be listed in more than a single category.
Detailsstring $productId
Unique identifier for the eBay catalog product with which the item was
listed.
An eBay catalog product consists of pre-filled Item Specifics, additional
descriptive information, plus a stock photo (if available). These product
details are used to pre-fill item information, which is used to describe
the item and can also help surface the item in searches.
eBay supports the following types of product ID types: ISBN, UPC, EAN,
and ReferenceID (ePID, also known as an eBay Product Reference ID).
ReferenceID values are returned when available. A UPC, ISBN, or EAN
product identifier will be returned only when a ReferenceID is not
available.
This productId value can be used as input with findItemsByProduct to
retrieve items that were listed with the specified eBay catalog product.
This field is only returned when a product was used to list the item.
Details- Type
- string
\Zend_Service_Ebay_Finding_Category $secondaryCategory
Details about the second category in which the item is listed.
This element is not returned if the seller did not specify a secondary
category.
Details\Zend_Service_Ebay_Finding_SellerInfo $sellerInfo
Information about the item's seller.
Only returned if SellerInfo is specified in the outputSelector field in
the request.
Details\Zend_Service_Ebay_Finding_SellingStatus $sellingStatus
Specifies the item's selling status with regards to eBay's processing
workflow.
Details
\Zend_Service_Ebay_Finding_ShippingInfo $shippingInfo
Container for data about a listing's shipping details.
Details
\Zend_Service_Ebay_Finding_Storefront $storeInfo
Information about the eBay store in which the item is listed.
Only returned if the item is listed in a store and StoreInfo is specified
in the outputSelector field in the request.
Detailsstring $subtitle
Subtitle of the item.
Only returned if the seller included a subtitle for the listing.
Details- Type
- string
string $title
Name of the item as it appears in the listing title, or in search and
browse results.
Details
- Type
- string
string $viewItemURL
The URL to view this specific listing on eBay.
The returned URL is optimized to support natural search. That is, the URL
is designed to make items on eBay easier to find via popular internet
search engines. The URL includes the item title along with other
optimizations. To note, "?" (question mark) optimizes to "_W0QQ", "&"
(ampersand) optimizes to "QQ", and "=" (equals sign) optimizes to "Z".
Do not modify the returned URLs in your application queries (for example,
eBay won't recognize the URL if you change QQ to &). In the Sandbox
environment (and on the Hong Kong site), the data returned in this field
is a standard ViewItem URL rather than the ViewItemURL for natural
search.
Details- Type
- string
Methods
findItemsByProduct(\Zend_Service_Ebay_Finding $proxy, \Zend_Config | array $options = null) : \Zend_Service_Ebay_Finding_Response_Items
Parameters
Returns
Name | Type | Description |
---|---|---|
$proxy | \Zend_Service_Ebay_Finding | |
$options | \Zend_Config | array |
Type | Description |
---|---|
\Zend_Service_Ebay_Finding_Response_Items |