PUT api/v7/ProductPrices
Add or Update a product price information from a client.
Tables Impacted
ProductPrice
Request Information
URI Parameters
None.
Body Parameters
Product price information to update in db
ProductPriceRequest| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| productCode * |
PLU Key |
string |
Yes |
String length: between 1 and 30, inclusive |
| orgName |
Current Organization Name |
string |
No |
None. |
| currencyCode * |
The ISO 4217 currency code for the currency the price is in. |
string |
Yes |
String length: between 1 and 10, inclusive |
| effectiveStart * |
The start date and time for the price. Enables setting up prices for the future. |
date |
Yes |
None. |
| effectiveEnd |
The end date and time for the price. |
date |
No |
None. |
| taxClassCode |
The full tax class code for the tax class. |
string |
No |
None. |
| orgUnitLevelIndex |
organization level sequencial index |
integer |
No |
None. |
| priceAttributes |
product price attributes |
PriceAttributes |
No |
None. |
| originalPrice |
Original price |
decimal number |
No |
None. |
| compValuePrice |
Comp Value price |
decimal number |
No |
None. |
| specialMemberPrice |
Special Member Price |
decimal number |
No |
None. |
| unitPrice * |
Unit price |
decimal number |
Yes |
None. |
| unitCost |
Unit cost |
decimal number |
No |
None. |
| seasonalLowPrice |
Seasonal Low price |
decimal number |
No |
None. |
| lastNonClearancePrice |
Last Non Clearance Price |
decimal number |
No |
None. |
| bulkQuantity |
Bulk quantity |
integer |
No |
None. |
| bulkPrice |
Minimum quantity |
decimal number |
No |
None. |
| clearance |
Clearance |
string |
No |
String length: between 1 and 255, inclusive |
| customerAuditDate |
Product Price last modified audit information |
date |
No |
None. |
Request Formats
application/json, text/json
{
"productCode": "00000000000099",
"orgName": "111",
"currencyCode": "USD",
"effectiveStart": "2010-04-06T14:15:45",
"orgUnitLevelIndex": 0,
"priceAttributes": {
"eventId": 111,
"eventName": "Event name"
},
"originalPrice": 19.0,
"unitPrice": 19.99,
"bulkPrice": 1.0,
"clearance": "0",
"customerAuditDate": "2018-01-01T00:00:00"
}
application/xml, text/xml
<ProductPriceRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<orgName>111</orgName>
<originalPrice>19</originalPrice>
<compValuePrice xsi:nil="true" />
<specialMemberPrice xsi:nil="true" />
<unitPrice>19.99</unitPrice>
<unitCost xsi:nil="true" />
<seasonalLowPrice xsi:nil="true" />
<lastNonClearancePrice xsi:nil="true" />
<bulkQuantity xsi:nil="true" />
<bulkPrice>1.0</bulkPrice>
<clearance>0</clearance>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
<currencyCode>USD</currencyCode>
<effectiveStart>2010-04-06T14:15:45</effectiveStart>
<effectiveEnd xsi:nil="true" />
<orgUnitLevelIndex>0</orgUnitLevelIndex>
<priceAttributes>
<eventId>111</eventId>
<eventName>Event name</eventName>
</priceAttributes>
<productCode>00000000000099</productCode>
</ProductPriceRequest>
Response Information
Resource Description
A response containing an acknowledgment
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>