Helpcenter +918010117117 https://help.storehippo.com/s/573db3149f0d58741f0cc63b/ms.settings/5256837ccc4abf1d39000001/57614ef64256dc6851749879-480x480.png" [email protected] https://www.facebook.com/StoreHippohttps://twitter.com/StoreHippohttps://www.linkedin.com/company/hippoinnovations/https://plus.google.com/+Storehippo/posts
B4,309-10 Spaze iTech Park, Sector 49, Sohna Road, 122001 Gurgaon India

Related Topics

StoreHippo API Global Widgets Global Objects

Resources

Overview ms.blogs ms.brands ms.carts ms.categories ms.collections ms.coupon_codes ms.discounts_new ms.domains ms.email_logs ms.enquiries ms.fulfillments ms.invoices ms.languages ms.mailing_lists ms.navigations ms.notifications ms.orders ms.pages ms.products ms.redirects ms.reviews ms.sellers ms.ssl_certificates ms.store_ledger ms.store_locations ms.users

Notifications

(ms.notifications)

you need swagger

This entity is used to send different types of notifications like: -Email,Sms,Push,Browser

Fields

Name Description
_id
Type: string
 		The unique identifier for the orders. This one is used for API purposes.
name
Type: string
 		This field contains the name of the notification.
description
Type: string
 		This field contains the short description about when this notification will be used.
publish
Type: string
 		Flag that determines if a category is published i.e. visible to users.
group
Type: string
 		This field describes the group_set of notification. There are three groups for notifications.
  • Order
  • Shipping
  • User
type
Type: object
 		This field is array of object, used to define the type of notification you want to send.
There are four types of notifications:
  • Email
  • SMS
  • Push
  • Browser
email
Type: object
 		This field is an object containing information about email and its header info:-
{
     "from_email": "[email protected]",
     "cc":  ['[email protected]','[email protected]'],
     "subject" :"Order Confirmation",
     "message: :  "Your Order with OrderId 504 is confirmed"
} 

from_email: It contains the email id of the sender.
cc: It contains emails to be kept in cc.
subject: It contains the subject of email.
message: It contains the message to be send in email.
sms
Type: object
 		It contains the message to be send in the SMS.

{
message: "test message"
} 

 

Commands

Name Routes
add post  /api/1/entity/ms.notifications TRY IT !
edit put  /api/1/entity/ms.notifications/{_id} TRY IT !
list get  /api/1/entity/ms.notifications TRY IT !
get get  /api/1/entity/ms.notifications/{_id} TRY IT !
delete delete  /api/1/entity/ms.notifications/{_id} TRY IT !

Notifications

(ms.notifications)

you need swagger

This entity is used to send different types of notifications like: -Email,Sms,Push,Browser

Fields

Name Description
_id
Type: string
 		The unique identifier for the orders. This one is used for API purposes.

name
Type: string
 		This field contains the name of the notification.

description
Type: string
 		This field contains the short description about when this notification will be used.

publish
Type: string
 		Flag that determines if a category is published i.e. visible to users.

group
Type: string
 		This field describes the group_set of notification. There are three groups for notifications.
  • Order
  • Shipping
  • User

type
Type: object
 		This field is array of object, used to define the type of notification you want to send.
There are four types of notifications:
  • Email
  • SMS
  • Push
  • Browser

email
Type: object
 		This field is an object containing information about email and its header info:-
{
     "from_email": "[email protected]",
     "cc":  ['[email protected]','[email protected]'],
     "subject" :"Order Confirmation",
     "message: :  "Your Order with OrderId 504 is confirmed"
} 

from_email: It contains the email id of the sender.
cc: It contains emails to be kept in cc.
subject: It contains the subject of email.
message: It contains the message to be send in email.

sms
Type: object
 		It contains the message to be send in the SMS.

{
message: "test message"
} 

 

Commands

Name Routes
add post  /api/1/entity/ms.notifications TRY IT !
edit put  /api/1/entity/ms.notifications/{_id} TRY IT !
list get  /api/1/entity/ms.notifications TRY IT !
get get  /api/1/entity/ms.notifications/{_id} TRY IT !
delete delete  /api/1/entity/ms.notifications/{_id} TRY IT !