Related Documents
Document Properties
Kbid2V5027
Last Modified23-Jun-2020
Added to KB15-Aug-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Update product price notification SMB


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/customers/-/users/-/notifications/price/<sku-number>

Http Method

PUT

Short Description

Updates product price notification

Query Parameters

 

Example Requests

/customers/-/users/-/notifications/price/4565239

HTTP Status Codes

200 OK

400 Bad Request
       Possible values for header 'error-key':

    • account.productnotification.invalid_fields.error
    • account.productnotification.missing_fields.error

401 Unauthorized

403 Forbidden

404 Not Found

Description

Updates the price notification of the product.

Cartridge

app_sf_rest, app_sf_rest_smb

Application

SMB Web Shop

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationResource
com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO 

Request Example

{
    "type": "ProductNotification",
    "price": {
        "type": "Money",
        "value": 263.95,
        "currencyMnemonic": "USD"
    },
    "notificationMailAddress": "pmiller@test.intershop.de"
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO

Response Example

With status code 200:

{
    "type": "ProductNotification",
    "price": {
        "type": "Money",
        "value": 263.95,
        "currencyMnemonic": "USD"
    },
    "notificationMailAddress": "pmiller@test.intershop.de"
}

With status code 400 response will be filled with error message and a possible error-key header. Example:

Status Code: 400 Bad Request
Accept-Ranges: bytes
Connection: close
Content-Length: 66
Content-Type: text/plain
Date: Fri, 08 Nov 2013 16:17:18 GMT
Server: Apache/2
authentication-token: standard@PBEWithMD5AndTripleDES:DKO7fhWjbYc=|DVnqYtExhOQouzEZURgninUb3/6N0BUJPgCEmGqcC9uUiyVNd+RojA==
error-invalid-attributes: notificationMailAddress
error-key: account.productnotification.invalid_fields.error
error-type: error-invalid-attributes
 
Bad Request (The following attributes are invalid: notificationMailAddress)

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationResource
com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO 

XML Request Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProductNotification>
    <notificationMailAddress>pmiller@test.intershop.de</notificationMailAddress>
    <price type="Money">
        <currencyMnemonic>USD</currencyMnemonic>
        <value>253.95</value>
    </price>
</ProductNotification>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO

XML Response Example

With status code 200:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProductNotification type="ProductNotification" type="ProductNotification">
    <notificationMailAddress>pmiller@test.intershop.de</notificationMailAddress>
    <price type="Money">
        <currencyMnemonic>USD</currencyMnemonic>
        <value>253.96</value>
    </price>
</ProductNotification> 

With status code 400 response will be filled with error message and a possible error-key header. Example:

Status Code: 400 Bad Request
Accept-Ranges: bytes
Connection: close
Content-Length: 66
Content-Type: text/plain
Date: Fri, 08 Nov 2013 16:17:18 GMT
Server: Apache/2
authentication-token: standard@PBEWithMD5AndTripleDES:DKO7fhWjbYc=|DVnqYtExhOQouzEZURgninUb3/6N0BUJPgCEmGqcC9uUiyVNd+RojA==
error-invalid-attributes: notificationMailAddress
error-key: account.productnotification.invalid_fields.error
error-type: error-invalid-attributes
 
Bad Request (The following attributes are invalid: notificationMailAddress)

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Tickets