Docs
Catalog API
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
  • include_fields in query - array

    Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

    Type: array[string]

  • exclude_fields in query - array

    Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

    Type: array[string]

  • page in query - integer

    Specifies the page number in a limited (paginated) list of products.

  • limit in query with default of 50 - integer

    Controls the number of items per page in a limited (paginated) list of products.

example

Response

Body

object | application/json
  • data
    array[object]

  • 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
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

application/json

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

  • title
    string

    The title for the video. If left blank, this will be filled in according to data on a host site.

    >= 0 characters<= 255 characters

    Example: Writing Great Documentation

  • description
    string

    The description for the video. If left blank, this will be filled in according to data on a host site.

    Example: A video about documenation

  • sort_order
    integer

    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 sort_order the same as or greater than the videoʼs new sort_order value will have their sort_orders reordered.

    Min: -2147483648
    Max: 2147483647

    Example: 1

  • type
    string

    The video type (a short name of a host site).

    Allowed: youtube

  • video_id
    string

    The ID of the video on a host site.

    >= 0 characters<= 25 characters

    Example: z3fRu9pkuXE

  • title
    string

    The title for the video. If left blank, this will be filled in according to data on a host site.

    >= 0 characters<= 255 characters

    Example: Writing Great Documentation

  • description
    string

    The description for the video. If left blank, this will be filled in according to data on a host site.

    Example: A video about documenation

  • sort_order
    integer

    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 sort_order the same as or greater than the videoʼs new sort_order value will have their sort_orders reordered.

    Min: -2147483648
    Max: 2147483647

    Example: 1

  • type
    string

    The video type (a short name of a host site).

    Allowed: youtube

  • video_id
    string

    The ID of the video on a host site.

    >= 0 characters<= 25 characters

    Example: z3fRu9pkuXE

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
  • include_fields in query - array

    Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

    Type: array[string]

  • exclude_fields in query - array

    Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

    Type: array[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
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

application/json

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

  • title
    string

    The title for the video. If left blank, this will be filled in according to data on a host site.

    >= 0 characters<= 255 characters
  • description
    string

    The description for the video. If left blank, this will be filled in according to data on a host site.

  • sort_order
    integer

    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 sort_order the same as or greater than the videoʼs new sort_order value will have their sort_orders reordered.

    Min: -2147483648
    Max: 2147483647
  • type
    string

    The video type (a short name of a host site).

    Allowed: youtube

  • id
    integer

    The unique numeric ID of the product video; increments sequentially.

  • title
    string

    The title for the video. If left blank, this will be filled in according to data on a host site.

    >= 0 characters<= 255 characters
  • description
    string

    The description for the video. If left blank, this will be filled in according to data on a host site.

  • sort_order
    integer

    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 sort_order the same as or greater than the videoʼs new sort_order value will have their sort_orders reordered.

    Min: -2147483648
    Max: 2147483647
  • type
    string

    The video type (a short name of a host site).

    Allowed: youtube

  • id
    integer

    The unique numeric ID of the product video; increments sequentially.

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
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

  • product_id in path - integer
    required

    The ID of the Product to which the resource belongs.

  • id in path - integer
    required

    The BigCommerce ID of the Video

example

Response

Did you find what you were looking for?