POST/video
This method creates a video. When using this method, specify the title, size, and classification of the video to be created. Description is an optional field for this method.
Tip: See Adding a video to your listing in the eBay Seller Center for details about video formatting requirements and restrictions, or visit the relevant eBay site help pages for the region in which the listings will be posted.
When a video is successfully created, the method returns the HTTP Status Code 201 Created.The method also returns the location response header containing the video ID, which you can use to retrieve the video.
Note: There is no ability to edit metadata on videos at this time. There is also no method to delete videos.
To upload a created video, use the uploadVideo method.
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
This method has no URI parameters.
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.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. 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
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| classification | array of Classification | The intended use for this video content. Currently, videos can only be added and associated with eBay listings, so the only supported value is Occurrence: Required |
| description | string | The description of the video. Occurrence: Optional |
| size | integer | The size, in bytes, of the video content. Occurrence: Required |
| title | string | The title of the video. Occurrence: Required |
Output
HTTP response headers
See HTTP response headers for details.
| Header | Meaning |
|---|---|
| Location | The created video resource location and the unique video ID. |
Response payload
This call has no payload.
Response fields
This call has no field definitions.
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 |
|---|---|
| 201 | Created |
| 400 | Bad Request |
| 403 | Forbidden |
| 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. |
| 190002 | API_MEDIA | REQUEST | Missing or invalid size. Size (in bytes) is required. |
| 190003 | API_MEDIA | REQUEST | Maximum size exceeded for supported uploads. Please refer to documentation. |
| 190004 | API_MEDIA | REQUEST | Title length exceeded. Please refer to documentation. |
| 190005 | API_MEDIA | REQUEST | Description length exceeded. Please refer to documentation. |
| 190006 | API_MEDIA | REQUEST | Title is required. |
| 190013 | API_MEDIA | REQUEST | Unauthorized access. |
| 190014 | API_MEDIA | REQUEST | A video classification is required. |
| 190016 | API_MEDIA | REQUEST | Markups are not permitted in the video title. |
| 190017 | API_MEDIA | REQUEST | Markups are not permitted in the video description. |
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: Create a video
This sample creates a video given a title, size, and classification as metadata.
Input
The inputs are the title, size, classification, and (optionally) description.
POSThttps://apim.ebay.com/commerce/media/v1_beta/video
Output
The output is an HTTP status. If the call is successful, the video will be created and the video ID is returned in the Location header.