POST Communications/AddNotificationConfiguration

Request Information

URI Parameters

None.

Body Parameters

NotificationConfigurationBinding
NameDescriptionTypeAdditional information
TemplateID

integer

Required
NotifiableID

in case of NotifiableType=OrderStatus, this is the ID of the Order. etc.

 integer

None.
NotifiableTypeID

this is a GlobalType (OrderStatus, ShippingOrderStatus)

 integer

None.
Subject

string

String length: inclusive between 0 and 100
Notify

tells if an e-mail will be sent

 boolean

Required
Lang

string

None.
StoreID

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "TemplateID": 1,
  "NotifiableID": 1,
  "NotifiableTypeID": 1,
  "Subject": "sample string 2",
  "Notify": true,
  "Lang": "sample string 4",
  "StoreID": 5
}

application/xml, text/xml

Sample: 
<NotificationConfigurationBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Communication">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 4</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">5</StoreID>
  <NotifiableID>1</NotifiableID>
  <NotifiableTypeID>1</NotifiableTypeID>
  <Notify>true</Notify>
  <Subject>sample string 2</Subject>
  <TemplateID>1</TemplateID>
</NotificationConfigurationBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample: 
1

application/xml, text/xml

Sample: 
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>