POST /catalog/products/{product_id}/videos
Creates a Product Video.
Required Fields
- video_id
Read-Only Fields
- id
Publicly accessible URLs are valid parameters.
The Catalog API integrates with third-party YouTube, and you must load videos through YouTube. The YouTube Terms of Service and Google Privacy Policy apply, as indicated in our Privacy Policy and Terms of Service.
Servers
- https://api.bigcommerce.com/stores/{store_hash}/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
product_id |
Integer | Yes |
The ID of the |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The MIME type of the response body. Default value: "application/json" |
Content-Type |
String | Yes |
The MIME type of the request body. Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
sort_order |
Integer | No |
The order in which the video will be displayed on the product page. Higher integers give the video a lower priority. When updating, if the video is given a lower priority, all videos with a |
description |
String | No |
The description for the video. If left blank, this will be filled in according to data on a host site. |
video_id |
String | No |
The ID of the video on a host site. |
title |
String | No |
The title for the video. If left blank, this will be filled in according to data on a host site. |
type |
String | No |
The video type (a short name of a host site). Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.