GET/image/{image_id}
This method retrieves an EPS image URL and its expiration details for the unique identifier specified in the path parameter image_id. Use the retrieved EPS image URL to add the image to a listing through the Inventory API or the Trading API. See Managing images for additional details.
Note: If a user inputs a valid image_id as a path parameter but the EPS image associated with that ID has expired, the call will fail and a 404 Not Found status code will be returned.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the apim.ebay.com root URI with apim.sandbox.ebay.com
URI parameters
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.inventory
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| expirationDate | string | The date and time when an unused EPS image will expire and be removed from the EPS server, in Coordinated Universal Time (UTC). As long as an EPS image is being used in an active listing, that image will remain on the EPS server and be accessible. Occurrence: Always |
| imageUrl | string | The EPS URL to access the uploaded image. This URL will be used in listing calls to add the image to a listing. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 190000 | API_MEDIA | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 190013 | API_MEDIA | REQUEST | Unauthorized access. |
| 190200 | API_MEDIA | REQUEST | The image resource was not found. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get Image Details
This sample retrieves the details of an image, including the image url and expiration date.
Input
The input is image_id. There is no payload with this request.
GEThttps://apim.ebay.com/commerce/media/v1_beta/image/p***************a
Output
If the call is successful, the details of the image will be retrieved.