PUT api/v7/ProductDescriptions
Add or Update a product description information from a client.
Tables Impacted
ProductDesc
Request Information
URI Parameters
None.
Body Parameters
Product description information to update in db
ProductDescriptionRequest| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| productCode * |
PLU Key |
string |
Yes |
String length: between 1 and 30, inclusive |
| brandDescription |
Brand description |
string |
No |
String length: between 1 and 128, inclusive |
| specialComments |
Special comment |
string |
No |
String length: between 1 and 255, inclusive |
| rebateText |
Rebate Text |
string |
No |
String length: between 1 and 255, inclusive |
| couponText |
flag for coupon text |
string |
No |
String length: between 1 and 255, inclusive |
| longDescription |
Long description of product |
string |
No |
String length: between 1 and 64, inclusive |
| detailDescription |
Detail description of product. For e.g. Product's html encode blob or long descriptive message or image blob |
string |
No |
None. |
| culture * |
Culture Code. For example: en-US, fr, fr-CA, es, ja-JP etc. |
string |
Conditional |
Conditionally required: Required if you wish to associate description with culture. If not provided, in most cases 'Organizational Culture' is taken String length: between 1 and 10, inclusive |
| description * |
Description Text (Culture specific) |
string |
Yes |
String length: between 1 and 30, inclusive |
| customerAuditDate |
Audit information |
date |
No |
None. |
Request Formats
application/json, text/json
{
"productCode": "00000000000099",
"brandDescription": "brandDesc-en",
"specialComments": "sp-en",
"rebateText": "reb",
"couponText": "coup",
"longDescription": "longDesc",
"detailDescription": "detail description blob",
"culture": "en",
"description": "shortDesc",
"customerAuditDate": "2018-01-01T00:00:00"
}
application/xml, text/xml
<ProductDescriptionRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <culture>en</culture> <description>shortDesc</description> <customerAuditDate>2018-01-01T00:00:00</customerAuditDate> <longDescription>longDesc</longDescription> <detailDescription>detail description blob</detailDescription> <brandDescription>brandDesc-en</brandDescription> <specialComments>sp-en</specialComments> <rebateText>reb</rebateText> <couponText>coup</couponText> <productCode>00000000000099</productCode> </ProductDescriptionRequest>
Response Information
Resource Description
Returns a HTTPResponse Message stating the success/failure of API Action
HttpResponseMessage| Name | Description | Type |
|---|---|---|
| Version | Version | |
| Content | HttpContent | |
| StatusCode | HttpStatusCode | |
| ReasonPhrase | string | |
| Headers | Collection of Object | |
| RequestMessage | HttpRequestMessage | |
| IsSuccessStatusCode | boolean |
Response Formats
application/json, text/json
{
"message": "Record successfully saved.",
"propertyName": "Success"
}
application/xml, text/xml
<ApiValidationMessage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <message>Record successfully saved.</message> <propertyName>Success</propertyName> </ApiValidationMessage>