Documentation for PUT api/inventory/InventoryImage

PUT api/inventory/InventoryImage

Edit details of specific Inventory item.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
InventoryMediaID	InventoryMedia ID	integer	None.
ProductID	This is the Product ID or item number	string	None.
Filename	This is the FileName	string	None.
ImageType	Image Type	integer	None.
Description	Description for the Image	string	None.
Title	Title for the Image	string	None.
IsActive	Indicate if Image is active for the item	boolean	None.
SortOrder	Sort Order to display Image	integer	None.
IsListImage	Identify if Image is a List Image	boolean	None.
IsDetailImage	Identify if Image is a Detail Image	boolean	None.
IsVideo	Identify if Image is a Video	boolean	None.
ExternalReferenceID	ExternalReferenceID	string	None.
ExternalReferenceTypeID	ExternalReferenceTypeID	integer	None.
IsResourceServerImage	IsResourceServerImage	boolean	None.

Request Formats

application/xml, text/xml

Sample:

<InventoryImageViewModel>
  <InventoryMediaID>1</InventoryMediaID>
  <ProductID>sample string 2</ProductID>
  <Filename>sample string 3</Filename>
  <ImageType>4</ImageType>
  <Description>sample string 5</Description>
  <Title>sample string 6</Title>
  <IsActive>True</IsActive>
  <SortOrder>8</SortOrder>
  <IsListImage>True</IsListImage>
  <IsDetailImage>True</IsDetailImage>
  <IsVideo>True</IsVideo>
  <ExternalReferenceID>sample string 12</ExternalReferenceID>
  <ExternalReferenceTypeID>1</ExternalReferenceTypeID>
  <IsResourceServerImage>True</IsResourceServerImage>
</InventoryImageViewModel>

application/json, text/json

Sample:

{
  "InventoryMediaID": 1,
  "ProductID": "sample string 2",
  "Filename": "sample string 3",
  "ImageType": 4,
  "Description": "sample string 5",
  "Title": "sample string 6",
  "IsActive": true,
  "SortOrder": 8,
  "IsListImage": true,
  "IsDetailImage": true,
  "IsVideo": true,
  "ExternalReferenceID": "sample string 12",
  "ExternalReferenceTypeID": 1,
  "IsResourceServerImage": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'InventoryImageViewModel'.

Response Information

Resource Description

InventoryImageViewModel

Name	Description	Type	Additional information
InventoryMediaID	InventoryMedia ID	integer	None.
ProductID	This is the Product ID or item number	string	None.
Filename	This is the FileName	string	None.
ImageType	Image Type	integer	None.
Description	Description for the Image	string	None.
Title	Title for the Image	string	None.
IsActive	Indicate if Image is active for the item	boolean	None.
SortOrder	Sort Order to display Image	integer	None.
IsListImage	Identify if Image is a List Image	boolean	None.
IsDetailImage	Identify if Image is a Detail Image	boolean	None.
IsVideo	Identify if Image is a Video	boolean	None.
ExternalReferenceID	ExternalReferenceID	string	None.
ExternalReferenceTypeID	ExternalReferenceTypeID	integer	None.
IsResourceServerImage	IsResourceServerImage	boolean	None.

Response Formats

application/xml, text/xml

Sample:

<InventoryImageViewModel>
  <InventoryMediaID>1</InventoryMediaID>
  <ProductID>sample string 2</ProductID>
  <Filename>sample string 3</Filename>
  <ImageType>4</ImageType>
  <Description>sample string 5</Description>
  <Title>sample string 6</Title>
  <IsActive>True</IsActive>
  <SortOrder>8</SortOrder>
  <IsListImage>True</IsListImage>
  <IsDetailImage>True</IsDetailImage>
  <IsVideo>True</IsVideo>
  <ExternalReferenceID>sample string 12</ExternalReferenceID>
  <ExternalReferenceTypeID>1</ExternalReferenceTypeID>
  <IsResourceServerImage>True</IsResourceServerImage>
</InventoryImageViewModel>

application/json, text/json

Sample:

{
  "InventoryMediaID": 1,
  "ProductID": "sample string 2",
  "Filename": "sample string 3",
  "ImageType": 4,
  "Description": "sample string 5",
  "Title": "sample string 6",
  "IsActive": true,
  "SortOrder": 8,
  "IsListImage": true,
  "IsDetailImage": true,
  "IsVideo": true,
  "ExternalReferenceID": "sample string 12",
  "ExternalReferenceTypeID": 1,
  "IsResourceServerImage": true
}