Catalog - Categories
Create a Category Image
POST /stores/{store_hash}/v3/catalog/categories/{category_id}/image
Request
Create a Category Image.
Required Fields
- image_file: Form posts are the only accepted upload option.
Only one image at a time can be created.
Limit image size to 1MB.
To update a Category Image, use the Update categories endpoint and an image_url
.
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.
Response
Body
object | application/json
dataobject
metaobject
Response metadata.
example
Delete a Category Image
DELETE /stores/{store_hash}/v3/catalog/categories/{category_id}/image
Request
Deletes a Category Image.
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.
- category_id in path - integer - required
The ID of the
Category
to which the resource belongs.