Videos
Get All Product Videos
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/videosRequest
Returns a list of Product Videos. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
dataarray[]
example
Create a Product Video
POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/videosRequest
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.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
The model for a POST to create a video on a product.
example
Response
Body
Response payload for the BigCommerce API.
data
A product video model.
example
Get a Product Video
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/videos/{id}Request
Returns a single Product Video. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
Response payload for the BigCommerce API.
data
A product video model.
example
Update a Product Video
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/videos/{id}Request
Updates a *Product Video.
Required Fields
- none
Read-Only Fields
- id
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.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
The model for a PUT to update a video on a product.
example
Response
Body
Response payload for the BigCommerce API.
data
A product video model.
example
Delete a Product Video
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/videos/{id}Request
Deletes a Product Video.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string