GET/document/{document_id}
This method retrieves the current status and metadata of the specified document.
Important! The document ID value returned in the response payload of the createDocument method is a required input path parameter for this method.
See Managing documents for additional information.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| document_id | string | The unique identifier of the document for which status and metadata is being retrieved. This value is returned in the response of the createDocument method. Occurrence: Required |
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 |
|---|---|---|
| documentId | string | The unique ID of the document. Occurrence: Always |
| documentMetadata | DocumentMetadata | This container provides the name, size, and type of the specified file. Occurrence: Conditional |
| documentMetadata.fileName | string | The name of the file including its extension (for example, Occurrence: Conditional |
| documentMetadata.fileSize | string | The size, in bytes, of the document content. Occurrence: Conditional |
| documentMetadata.fileType | string | The type of the file uploaded. Supported file types include the following: Occurrence: Conditional |
| documentStatus | DocumentStatusEnum | The status of the document resource. Occurrence: Always |
| documentType | DocumentTypeEnum | The type of the document uploaded. For example, Occurrence: Always |
| languages | array of LanguageEnum | This array shows the language(s) used in the document. 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 | Uploaded |
| 400 | Bad Request |
| 404 | Document 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 |
|---|---|---|---|
| 190052 | API_MEDIA | REQUEST | No document found with id {document_id}. |
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 Document Details
This sample retrieves the details of a document for the specified documentId 1*******-**********d5 including the documentMetadata, documentStatus, documentType, and languages.
Input
The input is document_id. There is no payload with this request.
GEThttps://api.ebay.com/commerce/media/v1_beta/document/1*******-**********d5
Output
If the call is successful, details of the document will be retrieved.