Docs
Catalog API
Product modifiers
Images

Images

Create product modifier Image

POST /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}/image

Request

Creates a Modifier Image.

The image will show on the storefront when the value is selected.

Required Fields

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

Authentication

  • X-Auth-Token in header

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.

  • modifier_id in path - integer
    required

    The ID of the product modifier.

  • value_id in path - integer
    required

    The ID of the product modifier value.

Body

object | multipart/form-data

  • image_file    string

Response

Body

object | application/json

Image Response returns for:

  • Create Variant Image
  • Create Modifier Image
  • Create Category Image
  • Create Brand Image

  • data    object

    An object containing a publicly accessible image URL, or a form post that contains an image file.

  • meta    object

    Response metadata.

example

{
"data": {
"image_url": "https://cdn8.bigcommerce.com/s-id30h7ohwf/product_images/attribute_rule_images/85_source_1536863430.png"
},
"meta": {}
}
Did you find what you were looking for?
Delete a product modifierCreate product modifier Image