SwsimV130
Click here for a complete list of operations.
ScheduleCarrierPickup
Schedule carrier pickup.
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/ScheduleCarrierPickup" <?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> <ScheduleCarrierPickup xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130"> <ContactInformation> <Email>string</Email> </ContactInformation> <Address> <Company>string</Company> <Address>string</Address> <City>string</City> <State>string</State> <ZIP>string</ZIP> <ZIP4>string</ZIP4> <Address2>string</Address2> <Address3>string</Address3> </Address> <PackageInformation> <NumberOfExpressMailPieces>int</NumberOfExpressMailPieces> <NumberOfPriorityMailPieces>int</NumberOfPriorityMailPieces> <NumberOfInternationalPieces>int</NumberOfInternationalPieces> <NumberOfFirstClassPieces>int</NumberOfFirstClassPieces> <NumberOfParcelSelectPieces>int</NumberOfParcelSelectPieces> <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> </PackageInformation> <Carrier>All or USPS or FedEx or DHLExpress or UPS or CanadaPost or DhlECommerce or Zorbit</Carrier> <PickupTimeEarliest>string</PickupTimeEarliest> <PickupTimeLatest>string</PickupTimeLatest> <PickupType>Default or AutoPickup</PickupType> </ScheduleCarrierPickup> </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> <ScheduleCarrierPickupResponse xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130"> <Authenticator>string</Authenticator> <PickupDate>string</PickupDate> <PickUpDayOfWeek>string</PickUpDayOfWeek> <ConfirmationNumber>string</ConfirmationNumber> <PickupTimeEarliest>string</PickupTimeEarliest> <PickupTimeLatest>string</PickupTimeLatest> <EstimatedAmount>decimal</EstimatedAmount> </ScheduleCarrierPickupResponse> </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> <ScheduleCarrierPickup xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130"> <ContactInformation> <Email>string</Email> </ContactInformation> <Address> <Company>string</Company> <Address>string</Address> <City>string</City> <State>string</State> <ZIP>string</ZIP> <ZIP4>string</ZIP4> <Address2>string</Address2> <Address3>string</Address3> </Address> <PackageInformation> <NumberOfExpressMailPieces>int</NumberOfExpressMailPieces> <NumberOfPriorityMailPieces>int</NumberOfPriorityMailPieces> <NumberOfInternationalPieces>int</NumberOfInternationalPieces> <NumberOfFirstClassPieces>int</NumberOfFirstClassPieces> <NumberOfParcelSelectPieces>int</NumberOfParcelSelectPieces> <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> </PackageInformation> <Carrier>All or USPS or FedEx or DHLExpress or UPS or CanadaPost or DhlECommerce or Zorbit</Carrier> <PickupTimeEarliest>string</PickupTimeEarliest> <PickupTimeLatest>string</PickupTimeLatest> <PickupType>Default or AutoPickup</PickupType> </ScheduleCarrierPickup> </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> <ScheduleCarrierPickupResponse xmlns="http://stamps.com/xml/namespace/2021/16/swsim/SwsimV130"> <Authenticator>string</Authenticator> <PickupDate>string</PickupDate> <PickUpDayOfWeek>string</PickUpDayOfWeek> <ConfirmationNumber>string</ConfirmationNumber> <PickupTimeEarliest>string</PickupTimeEarliest> <PickupTimeLatest>string</PickupTimeLatest> <EstimatedAmount>decimal</EstimatedAmount> </ScheduleCarrierPickupResponse> </soap12:Body> </soap12:Envelope>