SwsimV40


Click here for a complete list of operations.

CarrierPickup

Request carrier pickup from USPS.

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/swsimv40.asmx HTTP/1.1
Host: swsim.stamps.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://stamps.com/xml/namespace/2014/12/swsim/swsimv40/CarrierPickup"

<?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>
    <CarrierPickup xmlns="http://stamps.com/xml/namespace/2014/12/swsim/swsimv40">
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Company>string</Company>
      <Address>string</Address>
      <SuiteOrApt>string</SuiteOrApt>
      <City>string</City>
      <State>string</State>
      <ZIP>string</ZIP>
      <ZIP4>string</ZIP4>
      <PhoneNumber>string</PhoneNumber>
      <PhoneExt>string</PhoneExt>
      <NumberOfExpressMailPieces>int</NumberOfExpressMailPieces>
      <NumberOfPriorityMailPieces>int</NumberOfPriorityMailPieces>
      <NumberOfInternationalPieces>int</NumberOfInternationalPieces>
      <NumberOfOtherPieces>int</NumberOfOtherPieces>
      <TotalWeightOfPackagesLbs>int</TotalWeightOfPackagesLbs>
      <PackageLocation>FrontDoor or BackDoor or SideDoor or KnockOnDoorOrRingBell or MailRoom or Office or Reception or InOrAtMailbox or Other</PackageLocation>
      <SpecialInstruction>string</SpecialInstruction>
    </CarrierPickup>
  </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>
    <CarrierPickupResponse xmlns="http://stamps.com/xml/namespace/2014/12/swsim/swsimv40">
      <Authenticator>string</Authenticator>
      <ErrorMsg>string</ErrorMsg>
      <PickupDate>string</PickupDate>
      <PickUpDayOfWeek>string</PickUpDayOfWeek>
      <ConfirmationNumber>string</ConfirmationNumber>
    </CarrierPickupResponse>
  </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/swsimv40.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>
    <CarrierPickup xmlns="http://stamps.com/xml/namespace/2014/12/swsim/swsimv40">
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Company>string</Company>
      <Address>string</Address>
      <SuiteOrApt>string</SuiteOrApt>
      <City>string</City>
      <State>string</State>
      <ZIP>string</ZIP>
      <ZIP4>string</ZIP4>
      <PhoneNumber>string</PhoneNumber>
      <PhoneExt>string</PhoneExt>
      <NumberOfExpressMailPieces>int</NumberOfExpressMailPieces>
      <NumberOfPriorityMailPieces>int</NumberOfPriorityMailPieces>
      <NumberOfInternationalPieces>int</NumberOfInternationalPieces>
      <NumberOfOtherPieces>int</NumberOfOtherPieces>
      <TotalWeightOfPackagesLbs>int</TotalWeightOfPackagesLbs>
      <PackageLocation>FrontDoor or BackDoor or SideDoor or KnockOnDoorOrRingBell or MailRoom or Office or Reception or InOrAtMailbox or Other</PackageLocation>
      <SpecialInstruction>string</SpecialInstruction>
    </CarrierPickup>
  </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>
    <CarrierPickupResponse xmlns="http://stamps.com/xml/namespace/2014/12/swsim/swsimv40">
      <Authenticator>string</Authenticator>
      <ErrorMsg>string</ErrorMsg>
      <PickupDate>string</PickupDate>
      <PickUpDayOfWeek>string</PickUpDayOfWeek>
      <ConfirmationNumber>string</ConfirmationNumber>
    </CarrierPickupResponse>
  </soap12:Body>
</soap12:Envelope>