category

category.image.add

Add image to category

post/category.image.add.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/category.image.add.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

category_idstring required

Defines category id where the image should be added

image_namestring required

Defines image's name

urlstring required

Defines URL of the image that has to be added

type'base' | 'thumbnail' required

Defines image's types that are specified by comma-separated list

store_idstring

Store Id

labelstring

Defines alternative text that has to be attached to the picture

mimestring

Mime type of image http://en.wikipedia.org/wiki/Internet_media_type.

positioninteger

Defines image’s position in the list

apply_to_translationsboolean

Defines whether to add image to all category translations

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Response

successful operation

return_codeinteger
return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.