UploadSiteHostedPictures - Call Reference - eBay Trading Web Services

UploadSiteHostedPictures

Uploads a picture to EPS (eBay Picture Services) by including a binary attachment. This call is available only in the XML API (not in the SOAP API). This call requires that you use HTTP version 1.0.

This call will only be successful if a binary attachment is included, after the XML input, as part of the request.

If you want to use this call as part of the My Picture Uploads feature, see PictureUploadPolicy.

Please see FAQs on eBayPictureServices (EPS) and the UploadSiteHostedPictures API call and see samples at the following locations:

Java sample for UploadSiteHostedPictures

.NET sample in C# for UploadSiteHostedPictures

PHP sample for UploadSiteHostedPictures

VB6 sample for UploadSiteHostedPictures

The binary attachment is image data, including headers, from a JPG, GIF, PNG, BMP, or TIF format image file. JPG is recommended. If you use, for example, PNG, it will be converted to JPG (or GIF) format.

The binary attachment must be sent after the XML input as a MIME attachment, in the same POST request.

The only necessary call-specific input is an attachment of a picture. An EPS (eBay Picture Services) URL is returned for the picture, in SiteHostedPictureDetails.FullURL. The value in SiteHostedPictureDetails.FullURL must be stored by your application (for use by AddItem, ReviseItem, or RelistItem in the Item.PictureDetails.PictureURL field) because no API call is available for finding a URL of an uploaded, unassociated picture.

That is, your application uses the value in SiteHostedPictureDetails.FullURL to associate the picture with an item (using Item.PictureDetails.PictureURL in AddItem, ReviseItem, or RelistItem). This must be done within 48 hours; unassociated pictures are automatically deleted after that period.

The maximum picture size is 4 MB. EPS downscales and compresses the picture to store it at the different sizes in the imageset. For good quality results, the recommended minimum dimensions of the uploaded picture are at least 1000 pixels on the longer side. Recommended JPG quality is 90 or greater. The file size of images meeting these minimum requirements is 200KB-400KB. Larger dimensions and file sizes will not typically provide better quality in the final images processed by EPS.

If the dimensions of an uploaded picture are less than a size that is stored in EPS, the upload will be accepted (without warning) and the stored picture will be the same dimensions as the uploaded picture. In this case, image quality of the stored picture is likely to be degraded.

If end-users use image processing editors or utilities to prepare pictures for upload (e.g., crop, rotates, brightness correction, etc.), they should avoid use of Save for the Web commands or options to save output since these will cause reduced image quality after the uploaded pictures are processed by EPS. They should use the standard Save command instead.

EPS supports upload of image data in JPG, GIF, PNG, BMP, and TIF formats. Other image formats, such as PSD, will result in an error. Successfully processed uploads for item pictures are stored in EPS in JPG format, at sizes and compression settings designed to provide the best trade-off between image quality and page-load times.

If the API request specifies a Supersize imageset and the response confirms that a Supersize or Large imageset was created, then the AddItem, ReviseItem, or RelistItem call must specify Supersize or PicturePack as the PhotoDisplayType. In the case of ReviseItem, if there are existing pictures for a listing, it is not possible to change the PhotoDisplayType from Normal to Supersize or PicturePack.

UploadSiteHostedPictures Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<UploadSiteHostedPicturesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <PictureData contentType="string"> Base64BinaryType (base64Binary) </PictureData>
  <PictureName> string </PictureName>
  <PictureSet> PictureSetCodeType </PictureSet>
  <PictureSystemVersion> int </PictureSystemVersion>
  <PictureUploadPolicy> PictureUploadPolicyCodeType </PictureUploadPolicy>
</UploadSiteHostedPicturesRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
PictureData	Base64BinaryType (base64Binary)	Optional	An optional reference ID to the binary attachment. The PictureData field does not contain the binary attachment. The binary attachment is image data, including headers, from a JPG, GIF, PNG, BMP, or TIF format image file. The binary attachment must be sent as a MIME attachment, in your POST request, after the XML input.
PictureData [ attribute contentType ]	string	Optional	Stores an optional reference ID to the binary attachment.
PictureName	string	Optional	A name you provide for the picture. Returned as SiteHostedPictureDetails.PictureName in the call response.
PictureSet	PictureSetCodeType	Optional	The image sizes that will be generated. Default: Standard. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • Standard (in/out) Default value for requests. The size for the standard, 3-picture set for item pictures. • Supersize (in/out) Supersize, 4-picture set. If you specify this value on input, and this value is returned in the response, then in AddItem or a related call, you must specify Item.PictureDetails.PhotoDisplay.Supersize or Item.PictureDetails.PhotoDisplay.PicturePack. (Not all values in PictureSetCodeType apply to this field.)
PictureSystemVersion	int	Optional	Specifies the picture system version. Only version 2 is valid. Available to support future changes in the picture system version. Default: 2.
PictureUploadPolicy	PictureUploadPolicyCodeType	Optional	When the My Picture Uploads feature is available (see the Trading API Release Notes), applications (including non-listing apps, such as photo-editors and digital-camera software) will be able to use the PictureUploadPolicy field to specify that an uploaded picture is available to a seller on the eBay site. When you use PictureUploadPolicy, you are specifying that the picture you uploaded (and its URL) is stored for 48 hours on the eBay site. (If, within 48 hours, the picture is associated with an item, then it persists on the eBay site for the same time length as other pictures uploaded using the UploadSiteHostedPictures call). As a result of the storage on the eBay site, the picture is available to the seller on the My Picture Uploads tab within the Sell Your Item (SYI) pages. A maximum of 25 URLs can be stored. Applicable values: • Add (in) Specifies that an uploaded picture is added to the pictures available to a seller on the eBay site. • ClearAndAdd (in) Specifies, first, that all pictures available to a seller on the eBay site are removed, and then second, that the currently uploaded picture is made available to the seller. • CustomCode (in) Reserved for internal or future use.

UploadSiteHostedPictures Output

The box below lists all fields that might be returned in the call response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<UploadSiteHostedPicturesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <PictureSystemVersion> int </PictureSystemVersion>
  <SiteHostedPictureDetails> SiteHostedPictureDetailsType 
    <BaseURL> anyURI </BaseURL>
    <FullURL> anyURI </FullURL>
    <PictureFormat> PictureFormatCodeType </PictureFormat>
    <PictureName> string </PictureName>
    <PictureSet> PictureSetCodeType </PictureSet>
    <PictureSetMember> PictureSetMemberType 
      <MemberURL> anyURI </MemberURL>
      <PictureHeight> int </PictureHeight>
      <PictureWidth> int </PictureWidth>
    </PictureSetMember>
    <!-- ... more PictureSetMember nodes here ... -->
  </SiteHostedPictureDetails>
</UploadSiteHostedPicturesResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific fields]
Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Errors.ErrorParameters	ErrorParameterType (repeatable)	Conditionally	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
PictureSystemVersion	int	Always	Specifies the picture system version that was used to upload pictures. Only version 2 is valid.
SiteHostedPictureDetails	SiteHostedPictureDetailsType	Always	Contains information about an UploadSiteHostedPictures upload, including the URL of the uploaded picture.
SiteHostedPictureDetails .BaseURL	anyURI	Always	Truncated version of FullURL.
SiteHostedPictureDetails .FullURL	anyURI	Always	The URL for the uploaded picture. Store this value for association with an item listing. That is, after you use UploadSiteHostedPictures to upload an image, use the value in FullURL to associate the image with an item (specify the value in Item.PictureDetails.PictureURL in AddItem, ReviseItem, or RelistItem) within 48 hours. Unassociated pictures are automatically deleted after that period.
SiteHostedPictureDetails .PictureFormat	PictureFormatCodeType	Always	The format into which an uploaded picture has been converted. This value is usually JPG, but may be GIF. Applicable values: • CustomCode (out) Reserved for internal or future use. • GIF (out) GIF format. • JPG (out) JPG format.
SiteHostedPictureDetails .PictureName	string	Conditionally	Corresponds to the PictureName input value that you specified in the request. You can use the PictureName output field to confirm that the UploadSiteHostedPictures response corresponds to a specific UploadSiteHostedPictures request.
SiteHostedPictureDetails .PictureSet	PictureSetCodeType	Always	The size of images generated. This value may differ from the one requested, e.g. if a Supersize image cannot be generated. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • Large (out) When returned as output in the call response, the characters after setid may contain this value if a Supersize image cannot be generated. If this value is returned in the response, then in AddItem or a related call, you must specify Item.PictureDetails.PhotoDisplay.Supersize or Item.PictureDetails.PhotoDisplay.PicturePack. • Standard (in/out) Default value for requests. The size for the standard, 3-picture set for item pictures. • Supersize (in/out) Supersize, 4-picture set. If you specify this value on input, and this value is returned in the response, then in AddItem or a related call, you must specify Item.PictureDetails.PhotoDisplay.Supersize or Item.PictureDetails.PhotoDisplay.PicturePack.
SiteHostedPictureDetails .PictureSetMember	PictureSetMemberType (repeatable)	Always	URL and size information for each generated and stored size. This data is not necessarily needed by your application, but is provided for use in picture previews. This data is used for display control for specific pictures in the generated imageset. This data is supplied for all generated pictures.
SiteHostedPictureDetails .PictureSetMember.MemberURL	anyURI	Always	URL for the picture.
SiteHostedPictureDetails .PictureSetMember .PictureHeight	int	Always	Height of the picture in pixels.
SiteHostedPictureDetails .PictureSetMember.PictureWidth	int	Always	Width of the picture in pixels.

UploadSiteHostedPictures Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

UploadSiteHostedPictures Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for UploadSiteHostedPictures.

UploadSiteHostedPictures Change History

Version	Description
533 2007-10-03	PictureUploadPolicy (added): This field is part of the My Picture Uploads feature. See the Trading API Release Notes for information about the availablility of this field.
531 2007-09-19	(doc change) The documentation has been updated to state that you must use HTTP version 1.0 for this call.
513 2007-05-16	(added) New call.

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 585

eBay Trading API
Call Reference Version 585