eBay Trading APIVersion 1003

PictureDetailsType

Contains the data for the pictures associated with an item. Not applicable to Half.com.

Type that uses PictureDetailsType:

Calls that use PictureDetailsType:

Fields



ExtendedPictureDetails ( ExtendedPictureDetailsType ) [0..1]
This container returns the URLs of the seller's self-hosted (hosted outside of eBay) pictures and the URL for the corresponding eBay Picture Services (EPS), that was generated when the self-hosted picture was uploaded.
See the Field Index to learn which calls use ExtendedPictureDetails.

ExternalPictureURL ( anyURI ) [0..*]
When returned this contains the original URL of a self-hosted pictures, associated with the item when the item was listed.
See the Field Index to learn which calls use ExternalPictureURL.

GalleryDuration ( token ) [0..1]
Number of days that the Featured Gallery type applies to a listing. Applicable values include 'Days_7' and 'LifeTime'.

When a seller chooses Featured as the Gallery type, the listing is highlighted and is included at the top of search results. This functionality is applicable only for Gallery Featured items and returns an error for any other Gallery type. Additionally, an error is returned if the seller attempts to downgrade from Lifetime to limited duration, but the seller can upgrade from limited duration to Lifetime duration. This field is not applicable to auction listings.
See the Field Index to learn which calls use GalleryDuration.

GalleryErrorInfo ( string ) [0..1]
Indicates the reason the gallery generation failed, such as, URL for the image is not valid. This field is returned when GalleryStatus field is returned and does not appear when the gallery generation is successful.
See the Field Index to learn which calls use GalleryErrorInfo.

GalleryStatus ( GalleryStatusCodeType ) [0..1]
Indicates if the gallery image upload failed and gives a reason for the failure, such as 'InvalidUrl' or 'ServerDown'. It is not returned if the gallery image is uploaded successfully.
See the Field Index to learn which calls use GalleryStatus.

GalleryType ( GalleryTypeCodeType ) [0..1]
Specifies the Gallery enhancement type for the listing. All listings automatically get the Gallery enhancement at no cost, so you never need to set this field to Gallery.

Gallery types are accumulative. This means if you use Plus, you also get the features of Gallery and if you use Featured, you get all the features of Gallery and Plus. Passing the values Plus and Featured together in the same request will return an error.

The Gallery image will be the first PictureURL in the array of PictureURL fields.

When revising a listing, you cannot remove Plus or Featured, however you can upgrade to Featured. When you upgrade, the original feature fee is credited, and the new feature fee is charged.
See the Field Index to learn which calls use GalleryType.

PhotoDisplay ( PhotoDisplayCodeType ) [0..1]
Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL.

You cannot use PhotoDisplay in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.

Some PhotoDisplay options can result in listing fees, even when the item is relisted. If you are relisting an item that was originally listed with a PhotoDisplay option, and you do not want that PhotoDisplay enhancement in your relisted item, you need to specifically remove PhotoDisplay in your RelistItem call (or RelistFixedPriceItem, as applicable) by setting PhotoDisplay to None. Use VerifyRelistItem to review your listing fees before you relist an item.
See the Field Index to learn which calls use PhotoDisplay.

PictureSource ( PictureSourceCodeType ) [0..1]
The service hosting the pictures in PictureURL, if any. This information is primarily useful for Picture Manager subscribers, who pay a flat subscription fee instead of individual picture fees per listing. Only returned when PictureURL is returned.
See the Field Index to learn which calls use PictureSource.

PictureURL ( anyURI ) [0..*]
Contains the URL for a picture of the item. The URL can be from the eBay Picture Services (images previously uploaded) or from a server outside of eBay (self-hosted). You can pass in up to 12 URLs but you cannot mix self-hosted and EPS-hosted URL in one listing.

On the US and Canada eBay Motors sites (for all vehicle listings) a listing can contain up to 24 pictures. The Gallery image will be the first PictureURL in the array of PictureURL fields.

Note: All images, whether they are hosted by EPS or self-hosted, must comply with the Picture Requirements. To specify multiple pictures, send each URL in a separate, PictureDetails.PictureURL element. The first URL passed in will be the Gallery image and appears on the View Item page.

If a URI contains spaces, replace them with %20. For example, http://example.com/my image.jpg must be submitted as http://example.com/my%20image.jpg to replace the space in the image file name.

Note: Embedding pictures in the description (by using IMG tags) is discouraged. Studies show that shopper often do not look at the description. The recommended process is to specify the image URLs using PictureURL. If a listing uses a single self-hosted picture (except in the case of a multi-variation listing), the picture will be copied to eBay Picture Services (ESP) and the PictureDetails.PictureURL value returned by GetItem will be an EPS URL.

For VerifyAddItem only: You must include a picture even when using VerifyAddItem. If you don't have a image file, you can use the following fake eBay Picture Services URL (http://i2.ebayimg.com/abc/M28/dummy.jpg) with this call.

For ReviseItem and RelistItem only: To remove a picture when revising or relisting an item, specify PictureDetails with all the pictures that you want the listing to include. That is, you need to completely replace the original set of URLs with the revised set. You cannot remove all the PictureURL fields from a listing because each listing requires at least one picture.

Remember: The Gallery image will be the first PictureURL in the array of PictureURL fields. So if the first image passed in when relisting/revising is different from when the listing was created, the Gallery image will be changed.

Note: For some large merchants, there are no limitations on when pictures can be added or removed from a fixed-price listing, even when the listing has had transactions or is set to end within 12 hours.
See the Field Index to learn which calls use PictureURL.