Embedded Files
Scope
Scope
The main scope of push notifications are to notify you when something like products, prices, storage, customer etc was changed (any change / any new or deleted event).
The notification consist in a JSON message sent to your URL address, which contains the identifier of the entity, document that was changed.
For e g. if a new product was created you will receive a JSON type notification like this:
{
"NotificationType": "Product Change",
"ChangeType": "Update",
"Trigger": "M_Product",
"Value": "00087GH" -- product value that was created.
}
Therefore you should call Product/List API method filtered by the product value you received by notification in order to get all the information you need about the new product created.
Push Notification Activation
Push Notification Activation
To receive notifications you need to activate it. To stop a notification you need to disable it.
To activate a notification make a POST request, using the token you received with the following information:
Header:
NotificationType: predefined list of notification; Mandatory
CallbackURL: your URL address where the notification will be sent; Mandatory
Request body(optional):
Parameters list as JSON object: allows you to specify the entities, documents which are going to be monitored.
To change the parameters list you need to disable the notification and to activate again with the new list of parameters.
The activation or deactivation of a push notification becomes effective within seconds or up to two hours.
Eg:
Enabling Product Change notification (POST method):
https://api.socratecloud.com/webapi/rest/notification/activate/{version}?accessToken={access_token}&NotificationType=Product Change&CallbackURL=https://push.to.address.com/
Disabling Product Change notification:
https://api.socratecloud.com/webapi/rest/notification/deactivate/{version}?accessToken={access_token}&NotificationType=Product Change
The message sent to the URL address (CallbackURL) is JSON type:
{
"NotificationType": "Product Change",
"ChangeType": "Update",
"Trigger": "M_Product",
"Value": "00087GH"
}
Push Notification List
Push Notification List
There are available a list of push notifications:
Product Change
Price Change
Storage Change
BOM Storage Change
BPartner Change
BPartner Bank Account Change
BPartner Location Change
BPartner Contact Change
BPartner Merge
Project Change
Sales Order Change
Sales Invoice Change
Payment Change
Receipt Change
Receipt Confirmation Change
Shipment Change
Delivery Confirmation Change
Physical Inventory Change
Internal Material Receipt Change
Internal Use Inventory Change
Material Movement Change
Request Change
Product Change
Product Change
You will be notified when a product and its prices, inventory are changed. You will receive notification only for the products marked as 'SelfService'.
After you receive the notification message call product/list method API filtered by (product) value.
Available Parameters List to enter when enabling this notification:
Price Change
Price Change
You will be notified when a price is changed. After you receive the notification message call product/price/list method API filtered by (product) value.
Available Parameters List to enter when enabling this notification:
Storage Change
Storage Change
You will be notified when a storage quantity is changed (only for non-BOM products). After you receive the notification message call product/storage/list method API filtered by
(product) value.
Available Parameters List to enter when enabling this notification:
BOM Storage Change
BOM Storage Change
You will be notified when a storage quantity is changed(only for BOM products). After you receive the notification message call product/storage/list method API filtered by
(product) value.
Available Parameters List to enter when enabling this notification:
BPartner Change
BPartner Change
You will be notified when a business partner is changed. After you receive the notification message call bpartner/full/list method API filtered by
(bpartner) value.
Available Parameters List to enter when enabling this notification:
BPartner Merge
BPartner Merge
You will be notified when business partner is merged. After you receive the notification message call bpartner/full/list method API filtered by
(bpartner) id.
Available Parameters List to enter when enabling this notification:
BPartner Bank Account Change
BPartner Bank Account Change
You will be notified when a record from Business Partner/Bank Account tab is changed. After you receive the notification message
bpartner/bank_account/list method API filtered by (bpartner) value.
Available Parameters List to enter when enabling this notification:
BPartner Location Change
BPartner Location Change
You will be notified when a record from Business Partner/Location tab is changed. After you receive the notification message call
bpartner/location/list method API filtered by (bpartner) value.
Available Parameters List to enter when enabling this notification:
BPartner Contact Change
BPartner Contact Change
You will be notified when a record from Business Partner/Contact tab is changed. After you receive the notification message call
bpartner/contact/list method API filtered by (bpartner) value.
Available Parameters List to enter when enabling this notification:
Project Change
Project Change
You will be notified when a Project is changed. After you receive the notification message call project/list method API filtered by (project) name.
No available Parameters List to enter when enabling this notification.
Sales Order Change
Sales Order Change
You will be notified when a sales order (master document) is changed. After you receive the notification message call
order/full/list method API filtered by (document number) value.
Available Parameters List to enter when enabling this notification:
Sales Invoice Change
Sales Invoice Change
You will be notified when a Customer Invoice (master document) is changed. After you receive the notification message call
invoice/full/list method API filtered by (document number) value.
Available Parameters List to enter when enabling this notification:
Payment Change
Payment Change
You will be notified when a Payment is changed. After you receive the notification message call payment/list method API filtered by (document number) value.
Available Parameters List to enter when enabling this notification:
Receipt Change
Receipt Change
You will be notified when a Receipt (aka NIR) is changed. After you receive the notification message call receipt/full/list method API filtered by
(document number) value.
Available Parameters List to enter when enabling this notification:
Receipt Confirmation Change
Receipt Confirmation Change
You will be notified when a Receipt Confirmation is changed. After you receive the notification message call receipt/confirmation/full/list method API filtered by
(document number) value.
Available Parameters List to enter when enabling this notification:
Shipment Change
Shipment Change
You will be notified when a Shipment is changed. After you receive the notification message call shipment/full/list method API filtered by
(document number) value.
Available Parameters List to enter when enabling this notification:
Delivery Confirmation Change
Delivery Confirmation Change
You will be notified when a Shipment Confirmation is changed. After you receive the notification message call shipment/confirmation/full/list method API
filtered by (document number) value.
Available Parameters List to enter when enabling this notification:
Physical Inventory Change
Physical Inventory Change
You will be notified when a Physical Inventory document is changed. After you receive the notification message call physical_inventory/full/list method API
filtered by (document number) value.
Available Parameters List to enter when enabling this notification:
Internal Material Receipt Change
Internal Material Receipt Change
You will be notified when an Internal Material Receipt (aka Bon Primire) document is changed. After you receive the notification message call
internal_material_receipt/full/list method API filtered by (document number) value.
Available Parameters List to enter when enabling this notification:
Internal Inventory Use Change
Internal Inventory Use Change
You will be notified when an Internal Inventory Use (aka Bon Consum) document is changed. After you receive the notification message call
internal_use_inventory/full/list method API filtered by (document number) value.
Available Parameters List to enter when enabling this notification:
Material Movement Change
Material Movement Change
You will be notified when a Material Movement (aka Bon Transfer) document is changed. After you receive the notification message call
material_movement/full/list method API filtered by (document number) value.
Available Parameters List to enter when enabling this notification:
Request Change
Request Change
You will be notified when an Request is changed. After you receive the notification message call request/full/list method API filtered by
(document number) value.
Available Parameters List to enter when enabling this notification:
Production Change
Production Change
You will be notified when an Production is changed. After you receive the notification message call request/full/list method API filtered by
(document number) value.
Available Parameters List to enter when enabling this notification:
Page updated
Report abuse