UploadSiteHostedPictures
Note: This call has been deprecated and will be decommissioned on September 30th, 2026. Users are recommended to migrate to the createImageFromFile and createImageFromUrl methods of the Media API.
Use this call to upload a picture to eBay Picture Services (EPS). You can either include a binary attachment, or supply a URL in the ExternalPictureURL field to the location of the picture on an external web server.
Unlike what the call name implies, you can upload only one picture per call. To upload multiple pictures, call UploadSiteHostedPictures once for each picture you want to upload. EPS pictures must be used within 30 days, as pictures not associated with an active listing are automatically deleted from the server after this period.
UploadSiteHostedPictures supports only the XML Trading API (the SOAP Trading API is not supported). You can test this call in the Sandbox environment.
If the call is successful, UploadSiteHostedPictures returns the EPS URL of the picture in SiteHostedPictureDetails.FullURL, the original external picture URL in SiteHostedPictureDetails.ExternalPictureURL (if used), and the URLs for the variously sized images that were generated in SiteHostedPictureDetails.PictureSetMember.MemberURL.
If you need to retrieve the self-hosted and associated EPS URLs, use the GetItem call. The URLs are returned in ExtendedPictureDetails.PictureURLs.eBayPictureURL and ExtendedPictureDetails.PictureURLs.ExternalPictureURL.
Image Requirements
Note: All images must comply with eBay's picture requirements (for more information, see Add pictures in the Trading API User Guide).If a dimension or file size limit is exceeded, the errors returned will include the applicable limits. Image processing issues, such as thumbnail or gallery image generation, can result.
Error 21916604 is returned if the height + width dimension limit is exceeded. For example, if the maximum image dimension limit is 15,000 pixels (height + width), an 800 x 800 image is acceptable (800 + 800 = 1600, which is less than 15,000), but an 8000 x 8000 image is not (8000 + 8000 = 16,000, which is greater than 15,000).
Error 2191448 is returned if the image file size is larger than the maximum file size allowed. For example, if the maximum original file size is 12 MB, images with a file size greater than this are not acceptable.
eBay Picture Services (EPS) supports the uploading of image data in JPG, GIF, PNG, BMP, and TIF formats. An error is generated if you upload images in another format (such as PSD). EPS stores successfully processed images at sizes and compression settings designed to provide the best trade-off between image quality and page-load times.
EPS downscales and compresses the picture and stores it at the different sizes in the image set. If the dimensions of an uploaded picture are less than a size that is stored in EPS, the upload will be accepted, 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.
Uploading Binary Images
If you are uploading a binary image (instead of providing an external picture URL), you must include the picture as a binary MIME attachment after the XML input in the same POST request. Use XML version 1.0.
Example: Uploading a binary image
POST /ws/api.dll HTTP/1.1 Host: api.ebay.com X-EBAY-API-CALL-NAME: UploadSiteHostedPictures X-EBAY-API-SITEID: 0 X-EBAY-API-RESPONSE-ENCODING: XML X-EBAY-API-COMPATIBILITY-LEVEL: 967 X-EBAY-API-DETAIL-LEVEL: 0 Cache-Control: no-cache Postman-Token: d0ddd0cf-6132-afd0-0e30-c286a4616da3 Content-Type: multipart/form-data; boundary=----FormBoundary7MA4YWxkTrZu0gW ------FormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="XML Payload" <?xml version="1.0" encoding="utf-8"?> <UploadSiteHostedPicturesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <RequesterCredentials> <ebl:eBayAuthToken xmlns:ebl="urn:ebay:apis:eBLBaseComponents">TOKEN</ebl:eBayAuthToken> </RequesterCredentials> <PictureName>Gall-Peters projection map</PictureName> <PictureSet>Standard</PictureSet> </UploadSiteHostedPicturesRequest> ------FormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="Gall-Peters Projection"; filename="Gall-Peters_projection_SW.jpg" Content-Type: image/jpeg <<<< BINARY PICTURE DATA >>>> ------FormBoundary7MA4YWxkTrZu0gW--
Usage Details
For more information about eBay Picture Services, see FAQs on eBayPictureServices (EPS) and the UploadSiteHostedPictures API call.
Related Information
See:
Add pictures
Include pictures for variations
Input
See also Samples.
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 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 does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?> <UploadSiteHostedPicturesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <ExternalPictureURL> anyURI </ExternalPictureURL> <PictureData contentType="string"> Base64BinaryType (base64Binary) </PictureData> <PictureName> string </PictureName> <PictureSet> PictureSetCodeType </PictureSet> <PictureSystemVersion> int </PictureSystemVersion> <PictureUploadPolicy> PictureUploadPolicyCodeType </PictureUploadPolicy> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </UploadSiteHostedPicturesRequest>
| Argument | Type | Occurrence | Meaning |
|---|
Call-specific Input Fields
[Jump to standard fields]
ExternalPictureURL
anyURI
Conditional
This field is used if the seller wishes to upload a picture to the EPS server that is currently on another external site. The URL of the picture you want to upload is passed in this field. Only https:// servers are supported. You can include only one ExternalPictureURL field per call.
The eBay server uses the information in this field to retrieve a picture from an external web server. Once retrieved, the picture will be copied to eBay Picture Services and retained for 30 days if not associated with a listing. When associated with a listing, the duration is the length of the listing plus 90 days.
Max length: 1024.
The eBay server uses the information in this field to retrieve a picture from an external web server. Once retrieved, the picture will be copied to eBay Picture Services and retained for 30 days if not associated with a listing. When associated with a listing, the duration is the length of the listing plus 90 days.
Max length: 1024.
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 the 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.
The PictureData field does not contain the binary attachment. The binary attachment is image data, including the 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 An optional reference ID to the binary attachment.
The PictureData field does not contain the binary attachment. The binary attachment is image data, including the 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.
[ attribute contentType ] string 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 the 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.
PictureName
string
Optional
A seller-defined name for the picture. This field is optional, but can make it easier for a seller to track than an arbitrary, eBay-assigned URL.
PictureSet
PictureSetCodeType
Optional
This enumeration value indicates the size of the picture that will be generated.
IMPORTANT: To get the standard website image sizing with Zoom, set this field to Supersize.
Default: Standard.
Applicable values:
CustomCode
(in/out) Reserved for internal use only.
Standard
(in/out) Indicates to generate the "Standard" set of images, which is a set of 7 images of various sizes, for each ExternalPictureURL submitted in the request. This is the default. Note: This field is used only for images that will be used in a listing.
Supersize
(in/out) Indicates to generate the "Standard" set plus a super-sized image for each ExternalPictureURL submitted in the request. In order to include the super-sized image in the Add Item calls, you must also specify Item.PictureDetails.PhotoDisplay.Supersize or Item.PictureDetails.PhotoDisplay.PicturePack. Note: This field is used only for images that will be used in a listing.
(Not all values in PictureSetCodeType apply to this field.)
IMPORTANT: To get the standard website image sizing with Zoom, set this field to Supersize.
Default: Standard.
Applicable values:
(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.
Default: 2.
PictureUploadPolicy
PictureUploadPolicyCodeType
Optional
Determines if the uploaded picture is to replace all the pictures or to be added to the pictures currently available to a seller on the eBay site. The picture is available to the seller on the My Picture Uploads tab within the Sell Your Item pages.
The picture you upload (and its URL) is stored for a period of time on the EPS server. If, within that time, the picture is associated with an item, then the picture persists on the eBay site for the same time length as other pictures uploaded using the UploadSiteHostedPictures call.
The expiration date of the picture is returned in the SiteHostedPictureDetails.UseByDate field in the response.
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 use ONLY.
The picture you upload (and its URL) is stored for a period of time on the EPS server. If, within that time, the picture is associated with an item, then the picture persists on the eBay site for the same time length as other pictures uploaded using the UploadSiteHostedPictures call.
The expiration date of the picture is returned in the SiteHostedPictureDetails.UseByDate field in the response.
Applicable values:
Standard Input 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. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
| MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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., 1149). The version you specify for a call has these basic effects:
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:
|
||||||||||||||||||||||||||||||||||||||||
| 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 performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Output
See also Samples.
The box below lists all fields that might be returned in the 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 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).
<?xml version="1.0" encoding="utf-8"?> <UploadSiteHostedPicturesResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Output Fields --> <PictureSystemVersion> int </PictureSystemVersion> <SiteHostedPictureDetails> SiteHostedPictureDetailsType <BaseURL> anyURI </BaseURL> <ExternalPictureURL> anyURI </ExternalPictureURL> <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 allowed here ... --> <UseByDate> dateTime </UseByDate> </SiteHostedPictureDetails> <!-- 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 allowed here ... --> <LongMessage> string </LongMessage> <SeverityCode> SeverityCodeType </SeverityCode> <ShortMessage> string </ShortMessage> </Errors> <!-- ... more Errors nodes allowed here ... --> <HardExpirationWarning> string </HardExpirationWarning> <Timestamp> dateTime </Timestamp> <Version> string </Version> </UploadSiteHostedPicturesResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
Call-specific Output Fields
[Jump to standard fields]
PictureSystemVersion
int
Always
Specifies the picture system version that was used to upload pictures. Only version 2 is valid.
SiteHostedPictureDetails
SiteHostedPictureDetailsType
Always
The information about an UploadSiteHostedPictures upload, including the URL of the uploaded picture.
SiteHostedPictureDetails
.ExternalPictureURL anyURI Conditionally The URL of the external Web site hosting the uploaded photo. This field is returned if an ExternalPictureURL is provided in the call request.
Max length: 500.
.ExternalPictureURL anyURI Conditionally The URL of the external Web site hosting the uploaded photo. This field is returned if an ExternalPictureURL is provided in the call request.
Max length: 500.
SiteHostedPictureDetails
.FullURL anyURI Always This is the full URL for the uploaded picture on the EPS server. This value should be stored by the seller, as this URL will be needed when create, revise, or relist an item and add this image to the listing.
.FullURL anyURI Always This is the full URL for the uploaded picture on the EPS server. This value should be stored by the seller, as this URL will be needed when create, revise, or relist an item and add this image to the listing.
SiteHostedPictureDetails
.PictureFormat PictureFormatCodeType Always This enumeration value indicates the image format of the generated image, such as JPG, GIF, or PNG.
Applicable values:
CustomCode
(out) Reserved for internal use only.
GIF
(out) Indicates the picture was returned in GIF format.
JPG
(out) Indicates the picture was returned in JPG format. Uploaded pictures in JPG, TIF, or BMP will be returned as JPG.
PNG
(out) Indicates the picture was returned in PNG format.
Code so that your app gracefully handles any future changes to this list.
.PictureFormat PictureFormatCodeType Always This enumeration value indicates the image format of the generated image, such as JPG, GIF, or PNG.
Applicable values:
Code so that your app gracefully handles any future changes to this list.
SiteHostedPictureDetails
.PictureName string Conditionally The seller-defined name for the picture. This field is only returned if a PictureName value was specified in the request. A name for a picture can make it easier to track than an arbitrary, eBay-assigned URL.
.PictureName string Conditionally The seller-defined name for the picture. This field is only returned if a PictureName value was specified in the request. A name for a picture can make it easier to track than an arbitrary, eBay-assigned URL.
SiteHostedPictureDetails
.PictureSet PictureSetCodeType Always This enumeration value indicates the size of the generated picture. This value may differ from the one specified in the request (e.g. if a Supersize image cannot be generated).
Applicable values:
CustomCode
(in/out) Reserved for internal use only.
Standard
(in/out) Indicates to generate the "Standard" set of images, which is a set of 7 images of various sizes, for each ExternalPictureURL submitted in the request. This is the default. Note: This field is used only for images that will be used in a listing.
Supersize
(in/out) Indicates to generate the "Standard" set plus a super-sized image for each ExternalPictureURL submitted in the request. In order to include the super-sized image in the Add Item calls, you must also specify Item.PictureDetails.PhotoDisplay.Supersize or Item.PictureDetails.PhotoDisplay.PicturePack. Note: This field is used only for images that will be used in a listing.
Code so that your app gracefully handles any future changes to this list.
.PictureSet PictureSetCodeType Always This enumeration value indicates the size of the generated picture. This value may differ from the one specified in the request (e.g. if a Supersize image cannot be generated).
Applicable values:
Code so that your app gracefully handles any future changes to this list.
SiteHostedPictureDetails
.PictureSetMember PictureSetMemberType Always,
repeatable: [1..*] The URL and size information for each generated image.
.PictureSetMember PictureSetMemberType Always,
repeatable: [1..*] The URL and size information for each generated image.
SiteHostedPictureDetails
.PictureSetMember
.PictureHeight int Always Height of the picture in pixels.
.PictureSetMember
.PictureHeight int Always Height of the picture in pixels.
SiteHostedPictureDetails
.UseByDate dateTime Always This timestamp indicates when the picture must be uploaded with an eBay listing before it is purged from the EPS server.
By default, unpublished pictures (not associated with an active eBay listing) are kept on the EPS server for thirty days.
.UseByDate dateTime Always This timestamp indicates when the picture must be uploaded with an eBay listing before it is purged from the EPS server.
By default, unpublished pictures (not associated with an active eBay listing) are kept on the EPS server for thirty days.
Standard Output 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 the Ack field.
Applicable values:
CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.
(Not all values in AckCodeType apply to this field.)
Code so that your app gracefully handles any future changes to this list.
Applicable values:
(Not all values in AckCodeType apply to this field.)
Code so that your app gracefully handles any future changes to this list.
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
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.
Note: GetCategories is 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.
Note: GetCategories is 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
Conditionally,
repeatable: [0..*] A list of application-level errors (if any) that occurred when eBay processed the request.
repeatable: [0..*] A list of application-level errors (if any) that occurred when eBay processed the request.
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.
Code so that your app gracefully handles any future changes to this list.
Applicable values:
Code so that your app gracefully handles any future changes to this list.
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.
See Errors By Number.
Errors.ErrorParameters
ErrorParameterType
Conditionally,
repeatable: [0..*] 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.
repeatable: [0..*] 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 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.
[ attribute ParamID ] string 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.Value
string
Conditionally
This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.
If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Error handling section of the Making a Trading API call guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.
Code so that your app gracefully handles any future changes to this list.
Applicable values:
If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
- If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
- If the source of the problem is on eBay's side, 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.
See the Error handling section of the Making a Trading API call guide for more information.
When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.
Code so that your app gracefully handles any future changes to this list.
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 the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.
Note: GetCategories and other Trading API calls 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.
Note: GetCategories and other Trading API calls 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.
Input
Output
Detail Controls
Samples
Change History
Detail Controls
DetailLevel
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Input
Output
Detail Controls
Samples
Change History
Samples
New to making API calls? Please see Making a Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Sample: Basic Call
Uploads an image using a URL.
Description
Seller m***************r is going to list a Harry Potter book and she wants to upload an image of the book. Note: To ensure there are no copyright issues, we are using an image from the eBay Developers Program site instead of an image of the book.
Input
This call uses the ExternalPictureURL field to point to a picture that is hosted on a remote web server.
XML format.
<?xml version="1.0" encoding="utf-8"?>
<UploadSiteHostedPicturesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
<WarningLevel>High</WarningLevel>
<ExternalPictureURL>https://**.*********.****.com/*****/*******/*****/******/****.jpg</ExternalPictureURL>
<PictureName>Developer Page Banner</PictureName>
</UploadSiteHostedPicturesRequest>
Output
This image is uploaded to the eBay Picture Service. The response contains the EPS URLs to the variously sized images that were created, as well as the URL that was passed in with the request.
XML format.
<?xml version="1.0" encoding="UTF-8"?>
<UploadSiteHostedPicturesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019年11月07日T18:44:10.323Z</Timestamp>
<Ack>Success</Ack>
<Version>4</Version>
<Build>mediasvcs-4.4.14_20190831081631969</Build>
<PictureSystemVersion>2</PictureSystemVersion>
<SiteHostedPictureDetails>
<PictureName>Developer Page Banner</PictureName>
<PictureSet>Standard</PictureSet>
<PictureFormat>JPG</PictureFormat>
<FullURL>http://*.*******.***/**/*/***********=/*/***************8/$_*.***?****************7</FullURL>
<BaseURL>http://*.*******.***/**/*/***********=/*/***************8/$_</BaseURL>
<PictureSetMember>
<MemberURL>http://**************************************************/$_0.JPG</MemberURL>
<PictureHeight>24</PictureHeight>
<PictureWidth>96</PictureWidth>
</PictureSetMember>
<PictureSetMember>
<MemberURL>http://**************************************************/$_1.JPG</MemberURL>
<PictureHeight>100</PictureHeight>
<PictureWidth>400</PictureWidth>
</PictureSetMember>
<PictureSetMember>
<MemberURL>http://**************************************************/$_2.JPG</MemberURL>
<PictureHeight>50</PictureHeight>
<PictureWidth>200</PictureWidth>
</PictureSetMember>
<PictureSetMember>
<MemberURL>http://**************************************************/$_*2.JPG</MemberURL>
<PictureHeight>125</PictureHeight>
<PictureWidth>500</PictureWidth>
</PictureSetMember>
<PictureSetMember>
<MemberURL>http://**************************************************/$_*4.JPG</MemberURL>
<PictureHeight>16</PictureHeight>
<PictureWidth>64</PictureWidth>
</PictureSetMember>
<PictureSetMember>
<MemberURL>http://**************************************************/$_*5.JPG</MemberURL>
<PictureHeight>75</PictureHeight>
<PictureWidth>300</PictureWidth>
</PictureSetMember>
<PictureSetMember>
<MemberURL>http://**************************************************/$_*9.JPG</MemberURL>
<PictureHeight>32</PictureHeight>
<PictureWidth>32</PictureWidth>
</PictureSetMember>
<ExternalPictureURL>https://**.*********.****.com/*****/*******/*****/******/****.jpg</ExternalPictureURL>
<UseByDate>2018年11月20日T23:18:20.326Z</UseByDate>
</SiteHostedPictureDetails>
</UploadSiteHostedPicturesResponse>
Input
Output
Detail Controls
Samples
Change History
Change History
| Change Date | Description |
|---|---|
| 1423 2025年07月28日 |
|
| 0997 2017年01月20日 |
|
| 0923 2015年05月15日 |
|
| 0837 2013年08月29日 |
|
| 0801 2012年11月28日 |
|
| 0657 2010年02月17日 |
|
| 0631 2009年08月19日 |
|
| 0605 2009年02月18日 |
|
| 0533 2007年10月03日 |
|
| 0531 2007年09月19日 |
|
| 0513 2007年05月16日 |
|