SwsimV130


Click here for a complete list of operations.

CreateNotificationSetting

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /swsim/swsimv130.asmx HTTP/1.1
Host: swsim.testing.stamps.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130/CreateNotificationSetting"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateNotificationSetting xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130">
      <NotificationSettingProperties>
        <Triggers>
          <Trigger>
            <NotificationType>ShipmentCreated or DeliveryDateAnnounced or OutForDelivery or Delivered</NotificationType>
            <Channels xsi:nil="true" />
          </Trigger>
          <Trigger>
            <NotificationType>ShipmentCreated or DeliveryDateAnnounced or OutForDelivery or Delivered</NotificationType>
            <Channels xsi:nil="true" />
          </Trigger>
        </Triggers>
        <EmailConfig>
          <ContentBlocks>
            <ContentBlock xsi:nil="true" />
            <ContentBlock xsi:nil="true" />
          </ContentBlocks>
          <FromName>string</FromName>
          <ReplyToEmail>string</ReplyToEmail>
          <BCCEmails>
            <BccEmail xsi:nil="true" />
            <BccEmail xsi:nil="true" />
          </BCCEmails>
        </EmailConfig>
        <AllowSMSOptIn>boolean</AllowSMSOptIn>
      </NotificationSettingProperties>
      <Reference>string</Reference>
      <SetAsDefault>boolean</SetAsDefault>
    </CreateNotificationSetting>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateNotificationSettingResponse xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130">
      <Authenticator>string</Authenticator>
      <NotificationSettingId>guid</NotificationSettingId>
    </CreateNotificationSettingResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /swsim/swsimv130.asmx HTTP/1.1
Host: swsim.testing.stamps.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateNotificationSetting xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130">
      <NotificationSettingProperties>
        <Triggers>
          <Trigger>
            <NotificationType>ShipmentCreated or DeliveryDateAnnounced or OutForDelivery or Delivered</NotificationType>
            <Channels xsi:nil="true" />
          </Trigger>
          <Trigger>
            <NotificationType>ShipmentCreated or DeliveryDateAnnounced or OutForDelivery or Delivered</NotificationType>
            <Channels xsi:nil="true" />
          </Trigger>
        </Triggers>
        <EmailConfig>
          <ContentBlocks>
            <ContentBlock xsi:nil="true" />
            <ContentBlock xsi:nil="true" />
          </ContentBlocks>
          <FromName>string</FromName>
          <ReplyToEmail>string</ReplyToEmail>
          <BCCEmails>
            <BccEmail xsi:nil="true" />
            <BccEmail xsi:nil="true" />
          </BCCEmails>
        </EmailConfig>
        <AllowSMSOptIn>boolean</AllowSMSOptIn>
      </NotificationSettingProperties>
      <Reference>string</Reference>
      <SetAsDefault>boolean</SetAsDefault>
    </CreateNotificationSetting>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateNotificationSettingResponse xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130">
      <Authenticator>string</Authenticator>
      <NotificationSettingId>guid</NotificationSettingId>
    </CreateNotificationSettingResponse>
  </soap12:Body>
</soap12:Envelope>