GET api/v7/ProductDescriptions/{productCode}?description={description}
Search products description for client and return products description information as response.
Request Information
URI Parameters
| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| productCode * |
Product code to lookup a product descriptions |
string |
Yes |
None. |
| description |
Product description code to lookup a product descriptions |
string |
No |
None. |
Body Parameters
None.
Response Information
Resource Description
A response contains related products description information
ProductDescriptionResponse| Name | Description | Type |
|---|---|---|
| productCode |
PLU Key |
string |
| descriptions |
Product description |
Collection of Product Description Information |
Response Formats
application/json, text/json
Sample:
{
"productCode": "11111111111111",
"descriptions": [
{
"longDescription": "Water Treatment",
"culture": "en-US",
"description": "Water Trtmnt",
"customerAuditDate": "2018-01-01T00:00:00"
}
]
}
application/xml, text/xml
Sample:
<ProductDescriptionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<productCode>11111111111111</productCode>
<descriptions>
<ProductDescriptionInfo>
<culture>en-US</culture>
<description>Water Trtmnt</description>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
<longDescription>Water Treatment</longDescription>
</ProductDescriptionInfo>
</descriptions>
</ProductDescriptionResponse>