Skip to main content

POST/document/{document_id}/upload

This method associates the specified file with the specified document ID and uploads the input file. After the file has been uploaded, the processing of the file begins. Supported file types include .PDF, .JPEG/.JPG, and .PNG.

Note: The document ID value returned in the response of the createDocument method is a required input path parameter for this method. This value is also returned in the location header of the createDocument response payload.
A successful upload returns the HTTP Status Code 200 OK.

See Managing documents for additional information.

Note: You must use a Content-Type header with its value set to multipart/form-data.

This call does not have a JSON Request payload but uploads the file as form-data. For example:
file: @"/C:/Users/.../drone_user_warranty.pdf"
See Samples for information.

Input

Resource URI

POST https://api.ebay.com/commerce/media/v1_beta/document/{document_id}/upload

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

ParameterTypeDescription
document_idstringThe unique identifier of the document to be uploaded.

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.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
Content-TypestringThis header indicates the format of the request body provided by the client. Its value should be set to multipart/form-data.

For more information, refer to HTTP request headers.

Occurrence: Required

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 does not use a JSON request payload, but uploads files using multipart form data with information about the form data in the key-value pairs. See Upload the file for more information.

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/fieldTypeDescription
documentIdstring

The unique ID of the document.

Occurrence: Always

documentMetadataDocumentMetadata

This container provides the name, size, and type of the specified file.

Occurrence: Conditional

documentMetadata.fileNamestring

The name of the file including its extension (for example, drone_user_warranty.pdf).

Occurrence: Conditional

documentMetadata.fileSizestring

The size, in bytes, of the document content.

Occurrence: Conditional

documentMetadata.fileTypestring

The type of the file uploaded. Supported file types include the following: pdf, jpeg, jpg, and png.

Occurrence: Conditional

documentStatusDocumentStatusEnum

The status of the document resource.

Once a document has been uploaded using the uploadDocument method, the documentStatus will be SUBMITTED. The document will then either be accepted or rejected. Only documents with the status of ACCEPTED are available to be added to a listing.

Occurrence: Always

documentTypeDocumentTypeEnum

The type of the document uploaded. For example, USER_GUIDE_OR_MANUAL.

Occurrence: Always

languagesarray 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.

StatusMeaning
200Uploaded
400Bad Request
404Document Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
190052API_MEDIAREQUESTNo 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: Upload a document

This sample uploads a document file using a created document ID.

Input

The input is the document ID 1*******-**********d5 as a URI parameter. Although there is no JSON request payload, information about the form data is sent as key-value pairs. Only file is required. See Upload the document file for more information.

POSThttps://api.ebay.com/commerce/media/v1_beta/document/1*******-**********d5/upload

Output

A successful call will show an HTTP status of 200 and the following payload. The response payload includes the document ID, type, status, and document metadata. If the call is successful, the document will be uploaded.

Got thoughts? Click the feedback button – your insights help us improve!