eBay Trading APIVersion 1131

PictureDetailsType

Contains the data for the pictures associated with an item.

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.

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]
This field is used to specify the type of picture gallery to use for the listing. If this field is omitted, a standard picture gallery is used for the listing. There is no listing fee for a standard picture gallery.

To use the Gallery Plus feature, you must include this field and set its value to Plus. To use the Featured Gallery feature (a feature that includes the Gallery Plus feature, you must include this field and set its value to Featured.

The Gallery image will be the first URL passed into the first PictureURL field, so if you want a specific picture to be the Gallery image, you should make sure you pass the URL for this picture in the first PictureURL field.

When revising a listing, if you disable the Gallery Plus or Featured Gallery feature by including the GalleryType and setting its value to Gallery, the original feature fee for either of these features will not be credited to the seller.

Note: The Featured Gallery listing feature is being deprecated for all sites. If a seller attempts to set the value of GalleryType to Featured, it is allowed, but a warning will be returned announcing the deprecation of the feature. Starting August 15, 2019, this feature cannot be added when creating a new listing or revising an existing listing. For existing listings that already have the feature, the seller will not be able to change the duration to Lifetime. On September 15, 2019, this feature will be wired off. If a seller revises an existing listing that had this feature set, the GalleryType value will automatically default to Gallery.
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 picture URLs (for most categories and marketplaces) for each listing, but you cannot mix self-hosted and EPS-hosted URLs in the same listing. The UploadSiteHostedPictures call can be used to upload pictures to EPS. Note that if pictures are externally-hosted, they must be hosted on a site that is using the 'https' protocol. URLs using the 'http' protocol will not be allowed.

Note: If a URL contains spaces, those spaces can be replaced with %20. For example, https://example.com/my image.jpg must be submitted as https://example.com/my%20image.jpg to replace the space in the image file name. However, a semicolon character (;) cannot be replaced with %20, so a semicolon cannot be a part of the URL, as an error will occur. 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 eBay picture requirements, including the requirement that all images must be at least 500 pixels on its longest side. If the image does not satisfy the 500 pixels requirement, the listing may be blocked. For more information about other requirements and tips for adding pictures to listings, see the Adding pictures to your listings help page. To specify multiple pictures, send each URL in a separate, PictureDetails.PictureURL element. The first URL passed in defaults to be the 'gallery image', and will be the first picture that is shown when a user lands on the View Item page.



If a listing uses a single, self-hosted picture (except in the case of a multiple-variation listing), the picture will be copied to eBay Picture Services (EPS) 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 (https://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.