v2.video.edit_video_info
POST /api/v2/video/edit_video_info
You need to call v2.media.init_video_upload, v2.media.upload_video_part, and v2.media.complete_video_upload to upload the video, and call the v2.media.get_video_upload_result to get the video_upload_id of uploaded video first, then call this API to set video post information. After submit, the video is still draft status, you need to call v2.video.post_video to post the video to Shopee Video. You can only set and update post information before the video is post.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/video/edit_video_info
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| user_id | int | 1 | Shopee's unique identifier for a user. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm. |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| video_upload_list | object[] | True | Video information collection, no more than 5. | |
| video_upload_id | string | True | sg-11110199-6v99e-mgezdwct5eyya0 | ID of uploaded video. Obtain from v2.media.get_video_upload_result. |
| caption | string | False | this is a test video | Description of the Shopee Video. |
| cover_image_url | string | True | https://down-sg.img.susercontent.com/sg-11110199-6v99e-mgezdwct5eyya0\_pack\_v1\_1000001\_1 | Selected cover image url of the Shopee Video. Obtain from v2.video.get_cover_list. |
| item_info | object[] | False | List of products to be linked with the Shopee Video, no more than 6. | |
| item_id | int64 | True | 2 | Shopee's unique identifier for an item. |
| custom_item_name | string | False | item display name | Product display name in Shopee Video. |
| allow_info | object | True | Whether allow stitch and duet. | |
| allow_duet | boolean | True | true | Whether allow duet. |
| allow_stitch | boolean | True | true | Whether allow stitch. |
| scheduled_info | object | True | When scheduled_post is true, scheduled_post_time must not empty. When scheduled_post is false, scheduled_post_time must empty. | |
| scheduled_post | boolean | True | true | Whether post it to Shopee Video at scheduled time. |
| scheduled_post_time | timestamp | False | 1761734929450 | Scheduled post time, millisecond timestamp. When scheduled_post is true, scheduled_post_time must not empty. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| request_id | string | 07af0e73-f806-4b09-af22-d28a72eae63a | The identifier for an API request for error tracking. |
| response | object | Detail informations you are querying. | |
| success_list | string[] | [ "sg-11110199-6v99e-mgezdwct5eyya0"] | The list of video_upload_id edit successfully. |
| failure_list | object[] | The list of video_upload_id edit failed. | |
| fail_video_upload_id | string | sg-11110199-6v99e-mgezdwct5eyya0 | Failed video_upload_id. |
| failed_reason | string | can not edit video info,please retry | Failed reason of the corresponding video_upload_id. |