Docs
Catalog API
Products
Videos

Videos

Get All Product Videos

GET /catalog/products/{product_id}/videos

Request

Returns a list of Product Videos. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json

  • data    array[]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Create a Product Video

POST /catalog/products/{product_id}/videos

Request

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 header
    required

Parameters

  • store_hash in path - string

Body

application/json

The model for a POST to create a video on a product.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data

    A product video model.

  • meta    object

    Response metadata.

example

Get a Product Video

GET /catalog/products/{product_id}/videos/{id}

Request

Returns a single Product Video. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data

    A product video model.

  • meta    object

    Response metadata.

example

Update a Product Video

PUT /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 header
    required

Parameters

  • store_hash in path - string

Body

application/json

The model for a PUT to update a video on a product.

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data

    A product video model.

  • meta    object

    Response metadata.

example

Delete a Product Video

DELETE /catalog/products/{product_id}/videos/{id}

Request

Deletes a Product Video.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Did you find what you were looking for?
Get a Catalog SummaryGet All Product Videos