Catalog - Products
Get All Product Videos
GET /stores/{store_hash}/v3/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
- 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 - string
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
- exclude_fields in query - string
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
- page in query - integer
Specifies the page number in a limited (paginated) list of products.
- limit in query - integer
Controls the number of items per page in a limited (paginated) list of products.
example
Response
Body
dataarray[object]
metaobject
Data about the response, including pagination and collection totals.
example
Create a Product Video
POST /stores/{store_hash}/v3/catalog/products/{product_id}/videos
Request
Creates a Product Video.
Required Fields
- video_id
Read-Only Fields
- id
Publicly accessible URLs are valid parameters. Videos must be loaded through YouTube at this time.
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
The model for a POST to create a video on a product.
titlestring
>= 0 characters<= 255 charactersThe title for the video. If left blank, this will be filled in according to data on a host site.
Example: Writing Great Documentation
descriptionstring
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_orderinteger
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 newsort_order
value will have theirsort_order
s reordered.Example: 1
typestring
The video type (a short name of a host site).
Allowed: youtube
video_idstring
>= 0 characters<= 25 charactersThe ID of the video on a host site.
Example: z3fRu9pkuXE
example
Response
Body
Response payload for the BigCommerce API.
dataobject
A product video model.
metaobject
Response metadata.
example
Get a Product Video
GET /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 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
- include_fields in query - string
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
- exclude_fields in query - string
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
example
Response
Body
Response payload for the BigCommerce API.
data
A product video model.
metaobject
Response metadata.
example
Update a Product Video
PUT /stores/{store_hash}/v3/catalog/products/{product_id}/videos/{id}
Request
Updates a *Product Video.
Required Fields
- none
Read-Only Fields
- id
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
The model for a PUT to update a video on a product.
titlestring
>= 0 characters<= 255 charactersThe title for the video. If left blank, this will be filled in according to data on a host site.
descriptionstring
The description for the video. If left blank, this will be filled in according to data on a host site.
sort_orderinteger
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 newsort_order
value will have theirsort_order
s reordered.typestring
The video type (a short name of a host site).
Allowed: youtube
idinteger
The unique numeric ID of the product video; increments sequentially.
example
Response
Body
Response payload for the BigCommerce API.
dataobject
A product video model.
metaobject
Response metadata.
example
Delete a Product Video
DELETE /stores/{store_hash}/v3/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