Images
Create a Brand Image
POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/{brand_id}/imageRequest
Creates a brand image.
Required Fields
- image_file: Form posts are the only accepted upload option. For more information on how to upload an image see Adding product images. NOTE: Ensure you set the
Content-Typeheader tomultipart/form-data; boundary=--example-boundary--and set the correct URL for this endpoint.
Read-Only Fields
- id
Only one image at a time can be created. To update a brand image, use the Update a brand endpoint and an image_url.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- brand_id in path - integerrequired
The ID of the brand to which the resource belongs.
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
Body
object | multipart/form-data
image_filestring
Response
Body
object | application/json
dataobject
example
Delete a Brand Image
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/brands/{brand_id}/imageRequest
Deletes a brand image.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- brand_id in path - integerrequired
The ID of the brand to which the resource belongs.
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
example
Response
Did you find what you were looking for?