POST api/v1/ProductImageAdd

Add/Update product image

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
ImageTypeID	Derived from a call to ProductImageType	integer	Required
ProductID	The product id for which you want to set the image. Can be used in place of ProductCode	integer	None.
ProductCode	The product code for which you want to set the image. Can be used in place of ProductID	string	Max length: 25
ImageData	Base64 encoded JPG	string	None.
ImageURL		string	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "ImageTypeID": 2,
  "ProductID": 3,
  "ProductCode": "sample string 4",
  "ImageData": "sample string 5",
  "ImageURL": "sample string 6"
}

application/xml, text/xml

Sample:

<ProductImageAdd_Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <ImageTypeID>2</ImageTypeID>
  <ProductID>3</ProductID>
  <ProductCode>sample string 4</ProductCode>
  <ImageData>sample string 5</ImageData>
  <ImageURL>sample string 6</ImageURL>
</ProductImageAdd_Params>

Response Information

Resource Description

Returns:
200 OK Returns a collection of product stock data
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if the requested product code or product id don't exist 503 Service Unavailable

ProductImageAdd_Results

Name	Description	Type	Additional information
OK		boolean	None.
ProductImageAdd_Results_Issues		Collection of ProductImageAdd_Results_Issue	None.

Response Formats

application/json, text/json

Sample:

{
  "OK": true,
  "ProductImageAdd_Results_Issues": [
    {
      "ID": 1,
      "Message": "sample string 2",
      "ExtraData": "sample string 3"
    },
    {
      "ID": 1,
      "Message": "sample string 2",
      "ExtraData": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<ProductImageAdd_Results xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OK>true</OK>
  <ProductImageAdd_Results_Issues>
    <ProductImageAdd_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </ProductImageAdd_Results_Issue>
    <ProductImageAdd_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </ProductImageAdd_Results_Issue>
  </ProductImageAdd_Results_Issues>
</ProductImageAdd_Results>