PUT v1/product/{id}

Update a product for the authenticated user

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
id

ID of the product you want to update

string

Required.

Body Parameters

Information about the product

UpdateProductModel
NameDescriptionTypeAdditional Information
ProductName

Name of the product

string

Required.

ProductCode

Product Code defined by you (optional, but Product Name with Product Code should always be unique)

string

None.

ProductFamily

Product Family Name

string

None.

Description

Long description of the product

string

None.

CustomFields

Custom Field List (if they have been defined)

Collection of UDFFieldModel

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "ProductName": "sample string 1",
  "ProductCode": "sample string 2",
  "ProductFamily": "sample string 3",
  "Description": "sample string 4",
  "CustomFields": [
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:37:09.3541103+00:00"
    },
    {
      "FieldName": "sample string 1",
      "Type": "sample string 2",
      "StringValue": "sample string 3",
      "DoubleValue": 4.1,
      "DatetimeValue": "2025-05-24T11:37:09.3541103+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<UpdateProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KAPTA.Domain.ViewModel.v1">
  <CustomFields>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T11:37:09.3541103+00:00</DatetimeValue>
      <DoubleValue>4.1</DoubleValue>
      <FieldName>sample string 1</FieldName>
      <StringValue>sample string 3</StringValue>
      <Type>sample string 2</Type>
    </UDFFieldModel>
    <UDFFieldModel>
      <DatetimeValue>2025-05-24T11:37:09.3541103+00:00</DatetimeValue>
      <DoubleValue>4.1</DoubleValue>
      <FieldName>sample string 1</FieldName>
      <StringValue>sample string 3</StringValue>
      <Type>sample string 2</Type>
    </UDFFieldModel>
  </CustomFields>
  <Description>sample string 4</Description>
  <ProductCode>sample string 2</ProductCode>
  <ProductFamily>sample string 3</ProductFamily>
  <ProductName>sample string 1</ProductName>
</UpdateProductModel>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.