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

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.

  • 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]

    Allowed: name | type | sku | description | weight | width | depth | height | price | cost_price | retail_price | sale_price | map_price | tax_class_id | product_tax_code | calculated_price | categories | brand_id | option_set_id | option_set_display | inventory_level | inventory_warning_level | inventory_tracking | reviews_rating_sum | reviews_count | total_sold | fixed_cost_shipping_price | is_free_shipping | is_visible | is_featured | related_products | warranty | bin_picking_number | layout_file | upc | mpn | gtin | date_last_imported | search_keywords | availability | availability_description | condition | is_condition_shown | order_quantity_minimum | order_quantity_maximum | page_title | meta_keywords | meta_description | date_created | date_modified | view_count | preorder_release_date | preorder_message | is_preorder_only | is_price_hidden | price_hidden_label | custom_url | base_variant_id | open_graph_type | open_graph_title | open_graph_description | open_graph_use_meta_description | open_graph_use_product_name | open_graph_use_image

  • 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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/videos' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Data about the response, including pagination and collection totals.

example

{
"data": [
{
"id": 6,
"type": "youtube",
"video_id": "PqBTp23RLhI",
"product_id": 192,
"sort_order": 1,
"title": "Creating and Editing Banners | BigCommerce Tutorials",
"description": "Learn how to create and edit marketing banners. Marketing banners are a great way to advertise sales, display coupon codes, and add design elements. Let’s take a look at how you can leverage banners to convert your store’s visitors into paying customers.",
"length": "01:54"
},
{
"id": 7,
"type": "youtube",
"video_id": "EhYBjzqd-nI",
"product_id": 192,
"sort_order": 2,
"title": "BigCommerce Company Values",
"description": "These are the core principles upon which BigCommerce was built, guiding what we do and how we do it. Each employee learns them, loves them and lives them. Our merchants benefit from them every time they use our product or get help from our support team.\n\nJoin the BigCommerce team and help us build software that changes lives!\n\nhttps://www.bigcommerce.com/careers/",

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

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.

  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | 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

example

{
"title": "Writing Great Documentation",
"description": "A video about documenation",
"sort_order": 1,
"type": "youtube",
"video_id": "z3fRu9pkuXE"
}

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data
    object

    A product video model.

  • meta
    object

    Response metadata.

example

{
"title": "Your Video",
"description": "Company Values",
"sort_order": 1,
"type": "youtube",
"video_id": "123345AA"
}

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

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
  • 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]

    Allowed: name | type | sku | description | weight | width | depth | height | price | cost_price | retail_price | sale_price | map_price | tax_class_id | product_tax_code | calculated_price | categories | brand_id | option_set_id | option_set_display | inventory_level | inventory_warning_level | inventory_tracking | reviews_rating_sum | reviews_count | total_sold | fixed_cost_shipping_price | is_free_shipping | is_visible | is_featured | related_products | warranty | bin_picking_number | layout_file | upc | mpn | gtin | date_last_imported | search_keywords | availability | availability_description | condition | is_condition_shown | order_quantity_minimum | order_quantity_maximum | page_title | meta_keywords | meta_description | date_created | date_modified | view_count | preorder_release_date | preorder_message | is_preorder_only | is_price_hidden | price_hidden_label | custom_url | base_variant_id | open_graph_type | open_graph_title | open_graph_description | open_graph_use_meta_description | open_graph_use_product_name | open_graph_use_image

  • 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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/videos/[id]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data
    object

    A product video model.

  • meta
    object

    Response metadata.

example

{
"title": "Your Video",
"description": "Company Values",
"sort_order": 1,
"type": "youtube",
"video_id": "123345AA"
}

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

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
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | 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.

example

{
"title": "string",
"description": "string",
"sort_order": -2147483648,
"type": "youtube",
"id": 0
}

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data
    object

    A product video model.

  • meta
    object

    Response metadata.

example

{
"title": "Your Video",
"description": "Company Values",
"sort_order": 1,
"type": "youtube",
"video_id": "123345AA"
}

Delete a Product Video

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

Request

Deletes a Product Video.

Authentication

  • X-Auth-Token in header

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

curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/videos/[id]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Did you find what you were looking for?