Docs
Catalog API
Images

Images

Create a Brand Image

POST /catalog/brands/{brand_id}/image

Request

Creates a brand image.

Required Fields

  • image_file: Form posts are the only accepted upload option.

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

object | multipart/form-data
  • image_file
    string

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Delete a Brand Image

DELETE /catalog/brands/{brand_id}/image

Request

Deletes a brand image.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • brand_id in path - integer
    required

    The ID of the brand to which the resource belongs.

  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

example

Response

Did you find what you were looking for?