SwsimV130


Click here for a complete list of operations.

CreateShipmentNotification

Create Shipment Notification

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.stamps.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130/CreateShipmentNotification"

<?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>
    <CreateShipmentNotification xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130">
      <TrackingNumber>string</TrackingNumber>
      <Carrier>string</Carrier>
      <WeightLb>double</WeightLb>
      <WeightOz>double</WeightOz>
      <TrackingType>string</TrackingType>
      <BrandingId>guid</BrandingId>
      <NotificationSettingId>guid</NotificationSettingId>
      <EmailSenderName>string</EmailSenderName>
      <From>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </From>
      <To>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </To>
      <OrderDetails>
        <OrderDate>date</OrderDate>
        <OrderNumber>string</OrderNumber>
        <ShippingAndHandlingPrice>decimal</ShippingAndHandlingPrice>
        <TotalDiscountAmount>decimal</TotalDiscountAmount>
        <TotalTaxAmount>decimal</TotalTaxAmount>
        <OrderItems>
          <OrderItem>
            <Quantity>int</Quantity>
            <ItemID>string</ItemID>
            <Description>string</Description>
            <UnitPrice>decimal</UnitPrice>
            <ImageUrl>string</ImageUrl>
            <Options xsi:nil="true" />
          </OrderItem>
          <OrderItem>
            <Quantity>int</Quantity>
            <ItemID>string</ItemID>
            <Description>string</Description>
            <UnitPrice>decimal</UnitPrice>
            <ImageUrl>string</ImageUrl>
            <Options xsi:nil="true" />
          </OrderItem>
        </OrderItems>
        <OrderCurrency>string</OrderCurrency>
      </OrderDetails>
      <ShipDate>dateTime</ShipDate>
      <SendEmail>boolean</SendEmail>
    </CreateShipmentNotification>
  </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>
    <CreateShipmentNotificationResponse xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130">
      <Authenticator>string</Authenticator>
      <TrackingUrl>string</TrackingUrl>
    </CreateShipmentNotificationResponse>
  </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.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>
    <CreateShipmentNotification xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130">
      <TrackingNumber>string</TrackingNumber>
      <Carrier>string</Carrier>
      <WeightLb>double</WeightLb>
      <WeightOz>double</WeightOz>
      <TrackingType>string</TrackingType>
      <BrandingId>guid</BrandingId>
      <NotificationSettingId>guid</NotificationSettingId>
      <EmailSenderName>string</EmailSenderName>
      <From>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </From>
      <To>
        <FullName>string</FullName>
        <NamePrefix>string</NamePrefix>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <NameSuffix>string</NameSuffix>
        <Title>string</Title>
        <Department>string</Department>
        <Company>string</Company>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <City>string</City>
        <State>string</State>
        <ZIPCode>string</ZIPCode>
        <ZIPCodeAddOn>string</ZIPCodeAddOn>
        <DPB>string</DPB>
        <CheckDigit>string</CheckDigit>
        <Province>string</Province>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <Urbanization>string</Urbanization>
        <PhoneNumber>string</PhoneNumber>
        <Extension>string</Extension>
        <CleanseHash>string</CleanseHash>
        <OverrideHash>string</OverrideHash>
        <EmailAddress>string</EmailAddress>
        <FullAddress>string</FullAddress>
      </To>
      <OrderDetails>
        <OrderDate>date</OrderDate>
        <OrderNumber>string</OrderNumber>
        <ShippingAndHandlingPrice>decimal</ShippingAndHandlingPrice>
        <TotalDiscountAmount>decimal</TotalDiscountAmount>
        <TotalTaxAmount>decimal</TotalTaxAmount>
        <OrderItems>
          <OrderItem>
            <Quantity>int</Quantity>
            <ItemID>string</ItemID>
            <Description>string</Description>
            <UnitPrice>decimal</UnitPrice>
            <ImageUrl>string</ImageUrl>
            <Options xsi:nil="true" />
          </OrderItem>
          <OrderItem>
            <Quantity>int</Quantity>
            <ItemID>string</ItemID>
            <Description>string</Description>
            <UnitPrice>decimal</UnitPrice>
            <ImageUrl>string</ImageUrl>
            <Options xsi:nil="true" />
          </OrderItem>
        </OrderItems>
        <OrderCurrency>string</OrderCurrency>
      </OrderDetails>
      <ShipDate>dateTime</ShipDate>
      <SendEmail>boolean</SendEmail>
    </CreateShipmentNotification>
  </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>
    <CreateShipmentNotificationResponse xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130">
      <Authenticator>string</Authenticator>
      <TrackingUrl>string</TrackingUrl>
    </CreateShipmentNotificationResponse>
  </soap12:Body>
</soap12:Envelope>