This method updates the video cover if the video is placed as the main (first) media in the product gallery. To update the cover of the video in product gallery use the Upload gallery video cover method. Maximum allowed file size is 20Mb. JPG, PNG, and GIF are accepted.
If the video already has a cover, the uploaded image will replace the existing one. When uploading an image for a video cover, the image itself needs to be sent in the body of your request in a form of binary data. The file that you wish to upload needs to be prepared for that format and then sent to Ecwid API endpoint.
Alternatively, you can specify an externalUrl to your file as a request parameter and Ecwid will download it from there.
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token. |
Response
A JSON object of type 'UploadStatus' with the following fields:
UploadStatus
| Field | Type | Description |
|---|---|---|
| id | number | Internal image ID |
Errors
In case of error, Ecwid responds with an error HTTP status code and JSON-formatted body containing error description
HTTP codes
| HTTP Status | Description |
|---|---|
| 400 | Request parameters are malformed |
| 402 | The functionality/method is not available on the merchant plan |
| 403 | Access token doesn't have update_catalog scope |
| 404 | Product is not found / Video #0 is not found |
| 413 | The image file is too large (Maximum allowed size is 20Mb) |
| 415 | Unsupported content-type: expected application/octet-stream |
| 422 | The uploaded file is not an image |
| 500 | Uploading of the image file failed or there was an internal server error while processing a file |
Error response body (optional)
| Field | Type | Description |
|---|---|---|
| errorMessage | string | Error message |