Docs
Catalog API
Images

Images

Create a Category Image

POST /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.

Supported file types are JPEG/JPG, GIF, PNG and ICO.

Limit image size to 8MB. 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

Body

object | multipart/form-data
  • image_file
    string

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Delete a Category Image

DELETE /catalog/categories/{category_id}/image

Request

Deletes a Category Image.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Did you find what you were looking for?