USPSOrderAutomation Web Service

USPSOrderAutomation

Click here for a complete list of operations.

CreateOrderStandard

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 /USPSOrder.asmx HTTP/1.1
Host: prod.uspsorder.granitenet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://USPSWebService/USPSB2B"

<?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:Header>
    <UserCredentials xmlns="http://USPSWebService/USPSB2B">
      <UserName>string</UserName>
      <Password>string</Password>
    </UserCredentials>
  </soap:Header>
  <soap:Body>
    <CREATEORDER>
      <TRANSMISSION_INFO>
        <LAST_TRANSMISSION_DATE>dateTime</LAST_TRANSMISSION_DATE>
        <USPS_LAST_UPDATED_DATE>dateTime</USPS_LAST_UPDATED_DATE>
      </TRANSMISSION_INFO>
      <USPS_ORDER_ID>string</USPS_ORDER_ID>
      <ORDER_ACTION>bytes</ORDER_ACTION>
      <ORDER_TYPE>bytes</ORDER_TYPE>
      <USPS_WORK_STATUS>bytes</USPS_WORK_STATUS>
      <REQUESTED_DUE_DATE>date</REQUESTED_DUE_DATE>
      <EXPEDITE_REQUEST_INDICATOR>bytes</EXPEDITE_REQUEST_INDICATOR>
      <VENDOR>string</VENDOR>
      <PAYMENT_CONTRACT_ACCOUNT>string</PAYMENT_CONTRACT_ACCOUNT>
      <DEMARC>string</DEMARC>
      <PROJECT_ID>string</PROJECT_ID>
      <USPS_LOCATION>
        <USPS_SITE_ID>string</USPS_SITE_ID>
        <SUBSCRIBER_TYPE>string</SUBSCRIBER_TYPE>
        <SUBSCRIBER_SUBTYPE>string</SUBSCRIBER_SUBTYPE>
        <FDB_ID>string</FDB_ID>
        <DISTRICT_NAME>string</DISTRICT_NAME>
        <USPS_NEW_BUILDING_INDICATOR>bytes</USPS_NEW_BUILDING_INDICATOR>
        <USPS_LOCATION_NAME>string</USPS_LOCATION_NAME>
        <DESTINATION_SITE_FLAG>string</DESTINATION_SITE_FLAG>
        <CURR_USPS_LOCATION_ADDRESS1>string</CURR_USPS_LOCATION_ADDRESS1>
        <CURR_USPS_LOCATION_CITY>string</CURR_USPS_LOCATION_CITY>
        <CURR_USPS_LOCATION_STATE>string</CURR_USPS_LOCATION_STATE>
        <CURR_USPS_LOCATION_ZIPCODE>string</CURR_USPS_LOCATION_ZIPCODE>
        <CURR_USPS_LOCATION_COUNTRY>string</CURR_USPS_LOCATION_COUNTRY>
        <CURR_USPS_LOCATION_EXT_ADDR>string</CURR_USPS_LOCATION_EXT_ADDR>
        <NEW_USPS_LOCATION_ADDRESS1>string</NEW_USPS_LOCATION_ADDRESS1>
        <NEW_USPS_LOCATION_CITY>string</NEW_USPS_LOCATION_CITY>
        <NEW_USPS_LOCATION_STATE>string</NEW_USPS_LOCATION_STATE>
        <NEW_USPS_LOCATION_ZIPCODE>string</NEW_USPS_LOCATION_ZIPCODE>
        <NEW_USPS_LOCATION_COUNTRY>string</NEW_USPS_LOCATION_COUNTRY>
        <NEW_USPS_LOCATION_EXT_ADDR>string</NEW_USPS_LOCATION_EXT_ADDR>
      </USPS_LOCATION>
      <USPS_LOCATION>
        <USPS_SITE_ID>string</USPS_SITE_ID>
        <SUBSCRIBER_TYPE>string</SUBSCRIBER_TYPE>
        <SUBSCRIBER_SUBTYPE>string</SUBSCRIBER_SUBTYPE>
        <FDB_ID>string</FDB_ID>
        <DISTRICT_NAME>string</DISTRICT_NAME>
        <USPS_NEW_BUILDING_INDICATOR>bytes</USPS_NEW_BUILDING_INDICATOR>
        <USPS_LOCATION_NAME>string</USPS_LOCATION_NAME>
        <DESTINATION_SITE_FLAG>string</DESTINATION_SITE_FLAG>
        <CURR_USPS_LOCATION_ADDRESS1>string</CURR_USPS_LOCATION_ADDRESS1>
        <CURR_USPS_LOCATION_CITY>string</CURR_USPS_LOCATION_CITY>
        <CURR_USPS_LOCATION_STATE>string</CURR_USPS_LOCATION_STATE>
        <CURR_USPS_LOCATION_ZIPCODE>string</CURR_USPS_LOCATION_ZIPCODE>
        <CURR_USPS_LOCATION_COUNTRY>string</CURR_USPS_LOCATION_COUNTRY>
        <CURR_USPS_LOCATION_EXT_ADDR>string</CURR_USPS_LOCATION_EXT_ADDR>
        <NEW_USPS_LOCATION_ADDRESS1>string</NEW_USPS_LOCATION_ADDRESS1>
        <NEW_USPS_LOCATION_CITY>string</NEW_USPS_LOCATION_CITY>
        <NEW_USPS_LOCATION_STATE>string</NEW_USPS_LOCATION_STATE>
        <NEW_USPS_LOCATION_ZIPCODE>string</NEW_USPS_LOCATION_ZIPCODE>
        <NEW_USPS_LOCATION_COUNTRY>string</NEW_USPS_LOCATION_COUNTRY>
        <NEW_USPS_LOCATION_EXT_ADDR>string</NEW_USPS_LOCATION_EXT_ADDR>
      </USPS_LOCATION>
      <CONTACT_INFORMATION>
        <TECHNICIAN_NAME>string</TECHNICIAN_NAME>
        <TECHNICIAN_PHONE>string</TECHNICIAN_PHONE>
        <TECHNICIAN_EMAIL>string</TECHNICIAN_EMAIL>
        <USPS_IS_MANAGER_NAME>string</USPS_IS_MANAGER_NAME>
        <USPS_IS_MANAGER_PHONE>string</USPS_IS_MANAGER_PHONE>
        <USPS_PRI_CONTACT_NAME>string</USPS_PRI_CONTACT_NAME>
        <USPS_PRI_CONTACT_PHONE>string</USPS_PRI_CONTACT_PHONE>
        <USPS_ALT_CONTACT_NAME>string</USPS_ALT_CONTACT_NAME>
        <USPS_ALT_CONTACT_PHONE>string</USPS_ALT_CONTACT_PHONE>
      </CONTACT_INFORMATION>
      <DIRECT_BILLING_INFORMATION>
        <BILL_DIRECT_INDICATOR>bytes</BILL_DIRECT_INDICATOR>
        <BILL_DIRECT_SITE_ID>string</BILL_DIRECT_SITE_ID>
        <BILL_CONTACT_NAME>string</BILL_CONTACT_NAME>
        <BILL_CONTACT_PHONE>string</BILL_CONTACT_PHONE>
        <BILL_LOCATION_NAME>string</BILL_LOCATION_NAME>
        <BILL_LOCATION_ADDRESS1>string</BILL_LOCATION_ADDRESS1>
        <BILL_LOCATION_CITY>string</BILL_LOCATION_CITY>
        <BILL_LOCATION_STATE>string</BILL_LOCATION_STATE>
        <BILL_LOCATION_ZIPCODE>string</BILL_LOCATION_ZIPCODE>
        <BILL_DELIVERY_ORDER_NUMBER>string</BILL_DELIVERY_ORDER_NUMBER>
      </DIRECT_BILLING_INFORMATION>
      <CLINS>
        <CLIN_INFORMATION rec_num="unsignedByte">
          <CLIN_NUMBER>string</CLIN_NUMBER>
          <CLIN_DESCRIPTION>string</CLIN_DESCRIPTION>
          <CLIN_UNIT_PRICE>decimal</CLIN_UNIT_PRICE>
          <CLIN_QUANTITY>decimal</CLIN_QUANTITY>
        </CLIN_INFORMATION>
        <CLIN_INFORMATION rec_num="unsignedByte">
          <CLIN_NUMBER>string</CLIN_NUMBER>
          <CLIN_DESCRIPTION>string</CLIN_DESCRIPTION>
          <CLIN_UNIT_PRICE>decimal</CLIN_UNIT_PRICE>
          <CLIN_QUANTITY>decimal</CLIN_QUANTITY>
        </CLIN_INFORMATION>
      </CLINS>
      <SERVICE_INFORMATION>
        <SERVICE_TYPE>string</SERVICE_TYPE>
        <SERVICE_SUBTYPE>string</SERVICE_SUBTYPE>
        <SERVICE_IDENTIFIER>string</SERVICE_IDENTIFIER>
        <CIRCUIT_ID>string</CIRCUIT_ID>
        <NETWORK_SERVICE_PROVIDER>string</NETWORK_SERVICE_PROVIDER>
        <DEVICE_NAME>string</DEVICE_NAME>
        <IP_ADDRESS_REQUEST>bytes</IP_ADDRESS_REQUEST>
        <LAN_IP_ADDRESS>string</LAN_IP_ADDRESS>
        <LAN_IP_SUBNET>string</LAN_IP_SUBNET>
        <WAN_IP>string</WAN_IP>
        <WAN_SUBNET>string</WAN_SUBNET>
        <PRIMARY_DNS>string</PRIMARY_DNS>
        <SECONDARY_DNS>string</SECONDARY_DNS>
        <WAN_SPEED>string</WAN_SPEED>
        <LAN_SPEED>string</LAN_SPEED>
        <LAN_DUPLEX>bytes</LAN_DUPLEX>
        <IP_HELPER>string</IP_HELPER>
        <IP_TYPE>bytes</IP_TYPE>
        <OOB_PHONE_NUMBER>string</OOB_PHONE_NUMBER>
      </SERVICE_INFORMATION>
      <SPECIAL_INSTRUCTIONS>string</SPECIAL_INSTRUCTIONS>
      <ATTACHMENTS>
        <USPS_ATTACHMENTS rec_num="unsignedByte">
          <USPS_ATTACHMENT_FILENAME>string</USPS_ATTACHMENT_FILENAME>
          <USPS_PROVIDED_ATTACHMENT>base64Binary</USPS_PROVIDED_ATTACHMENT>
        </USPS_ATTACHMENTS>
        <USPS_ATTACHMENTS rec_num="unsignedByte">
          <USPS_ATTACHMENT_FILENAME>string</USPS_ATTACHMENT_FILENAME>
          <USPS_PROVIDED_ATTACHMENT>base64Binary</USPS_PROVIDED_ATTACHMENT>
        </USPS_ATTACHMENTS>
      </ATTACHMENTS>
    </CREATEORDER>
  </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>
    <CREATEORDER_RESP>
      <USPS_ORDER_ID>string</USPS_ORDER_ID>
      <VENDOR_ORDER_ID>string</VENDOR_ORDER_ID>
      <VENDOR_STATUS>string</VENDOR_STATUS>
      <VENDOR_LAST_UPDATED_DATE>dateTime</VENDOR_LAST_UPDATED_DATE>
      <COMMENTS>
        <COMMENTS_INFO rec_num="unsignedByte">
          <COMMENT>string</COMMENT>
        </COMMENTS_INFO>
        <COMMENTS_INFO rec_num="unsignedByte">
          <COMMENT>string</COMMENT>
        </COMMENTS_INFO>
      </COMMENTS>
    </CREATEORDER_RESP>
  </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 /USPSOrder.asmx HTTP/1.1
Host: prod.uspsorder.granitenet.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:Header>
    <UserCredentials xmlns="http://USPSWebService/USPSB2B">
      <UserName>string</UserName>
      <Password>string</Password>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <CREATEORDER>
      <TRANSMISSION_INFO>
        <LAST_TRANSMISSION_DATE>dateTime</LAST_TRANSMISSION_DATE>
        <USPS_LAST_UPDATED_DATE>dateTime</USPS_LAST_UPDATED_DATE>
      </TRANSMISSION_INFO>
      <USPS_ORDER_ID>string</USPS_ORDER_ID>
      <ORDER_ACTION>bytes</ORDER_ACTION>
      <ORDER_TYPE>bytes</ORDER_TYPE>
      <USPS_WORK_STATUS>bytes</USPS_WORK_STATUS>
      <REQUESTED_DUE_DATE>date</REQUESTED_DUE_DATE>
      <EXPEDITE_REQUEST_INDICATOR>bytes</EXPEDITE_REQUEST_INDICATOR>
      <VENDOR>string</VENDOR>
      <PAYMENT_CONTRACT_ACCOUNT>string</PAYMENT_CONTRACT_ACCOUNT>
      <DEMARC>string</DEMARC>
      <PROJECT_ID>string</PROJECT_ID>
      <USPS_LOCATION>
        <USPS_SITE_ID>string</USPS_SITE_ID>
        <SUBSCRIBER_TYPE>string</SUBSCRIBER_TYPE>
        <SUBSCRIBER_SUBTYPE>string</SUBSCRIBER_SUBTYPE>
        <FDB_ID>string</FDB_ID>
        <DISTRICT_NAME>string</DISTRICT_NAME>
        <USPS_NEW_BUILDING_INDICATOR>bytes</USPS_NEW_BUILDING_INDICATOR>
        <USPS_LOCATION_NAME>string</USPS_LOCATION_NAME>
        <DESTINATION_SITE_FLAG>string</DESTINATION_SITE_FLAG>
        <CURR_USPS_LOCATION_ADDRESS1>string</CURR_USPS_LOCATION_ADDRESS1>
        <CURR_USPS_LOCATION_CITY>string</CURR_USPS_LOCATION_CITY>
        <CURR_USPS_LOCATION_STATE>string</CURR_USPS_LOCATION_STATE>
        <CURR_USPS_LOCATION_ZIPCODE>string</CURR_USPS_LOCATION_ZIPCODE>
        <CURR_USPS_LOCATION_COUNTRY>string</CURR_USPS_LOCATION_COUNTRY>
        <CURR_USPS_LOCATION_EXT_ADDR>string</CURR_USPS_LOCATION_EXT_ADDR>
        <NEW_USPS_LOCATION_ADDRESS1>string</NEW_USPS_LOCATION_ADDRESS1>
        <NEW_USPS_LOCATION_CITY>string</NEW_USPS_LOCATION_CITY>
        <NEW_USPS_LOCATION_STATE>string</NEW_USPS_LOCATION_STATE>
        <NEW_USPS_LOCATION_ZIPCODE>string</NEW_USPS_LOCATION_ZIPCODE>
        <NEW_USPS_LOCATION_COUNTRY>string</NEW_USPS_LOCATION_COUNTRY>
        <NEW_USPS_LOCATION_EXT_ADDR>string</NEW_USPS_LOCATION_EXT_ADDR>
      </USPS_LOCATION>
      <USPS_LOCATION>
        <USPS_SITE_ID>string</USPS_SITE_ID>
        <SUBSCRIBER_TYPE>string</SUBSCRIBER_TYPE>
        <SUBSCRIBER_SUBTYPE>string</SUBSCRIBER_SUBTYPE>
        <FDB_ID>string</FDB_ID>
        <DISTRICT_NAME>string</DISTRICT_NAME>
        <USPS_NEW_BUILDING_INDICATOR>bytes</USPS_NEW_BUILDING_INDICATOR>
        <USPS_LOCATION_NAME>string</USPS_LOCATION_NAME>
        <DESTINATION_SITE_FLAG>string</DESTINATION_SITE_FLAG>
        <CURR_USPS_LOCATION_ADDRESS1>string</CURR_USPS_LOCATION_ADDRESS1>
        <CURR_USPS_LOCATION_CITY>string</CURR_USPS_LOCATION_CITY>
        <CURR_USPS_LOCATION_STATE>string</CURR_USPS_LOCATION_STATE>
        <CURR_USPS_LOCATION_ZIPCODE>string</CURR_USPS_LOCATION_ZIPCODE>
        <CURR_USPS_LOCATION_COUNTRY>string</CURR_USPS_LOCATION_COUNTRY>
        <CURR_USPS_LOCATION_EXT_ADDR>string</CURR_USPS_LOCATION_EXT_ADDR>
        <NEW_USPS_LOCATION_ADDRESS1>string</NEW_USPS_LOCATION_ADDRESS1>
        <NEW_USPS_LOCATION_CITY>string</NEW_USPS_LOCATION_CITY>
        <NEW_USPS_LOCATION_STATE>string</NEW_USPS_LOCATION_STATE>
        <NEW_USPS_LOCATION_ZIPCODE>string</NEW_USPS_LOCATION_ZIPCODE>
        <NEW_USPS_LOCATION_COUNTRY>string</NEW_USPS_LOCATION_COUNTRY>
        <NEW_USPS_LOCATION_EXT_ADDR>string</NEW_USPS_LOCATION_EXT_ADDR>
      </USPS_LOCATION>
      <CONTACT_INFORMATION>
        <TECHNICIAN_NAME>string</TECHNICIAN_NAME>
        <TECHNICIAN_PHONE>string</TECHNICIAN_PHONE>
        <TECHNICIAN_EMAIL>string</TECHNICIAN_EMAIL>
        <USPS_IS_MANAGER_NAME>string</USPS_IS_MANAGER_NAME>
        <USPS_IS_MANAGER_PHONE>string</USPS_IS_MANAGER_PHONE>
        <USPS_PRI_CONTACT_NAME>string</USPS_PRI_CONTACT_NAME>
        <USPS_PRI_CONTACT_PHONE>string</USPS_PRI_CONTACT_PHONE>
        <USPS_ALT_CONTACT_NAME>string</USPS_ALT_CONTACT_NAME>
        <USPS_ALT_CONTACT_PHONE>string</USPS_ALT_CONTACT_PHONE>
      </CONTACT_INFORMATION>
      <DIRECT_BILLING_INFORMATION>
        <BILL_DIRECT_INDICATOR>bytes</BILL_DIRECT_INDICATOR>
        <BILL_DIRECT_SITE_ID>string</BILL_DIRECT_SITE_ID>
        <BILL_CONTACT_NAME>string</BILL_CONTACT_NAME>
        <BILL_CONTACT_PHONE>string</BILL_CONTACT_PHONE>
        <BILL_LOCATION_NAME>string</BILL_LOCATION_NAME>
        <BILL_LOCATION_ADDRESS1>string</BILL_LOCATION_ADDRESS1>
        <BILL_LOCATION_CITY>string</BILL_LOCATION_CITY>
        <BILL_LOCATION_STATE>string</BILL_LOCATION_STATE>
        <BILL_LOCATION_ZIPCODE>string</BILL_LOCATION_ZIPCODE>
        <BILL_DELIVERY_ORDER_NUMBER>string</BILL_DELIVERY_ORDER_NUMBER>
      </DIRECT_BILLING_INFORMATION>
      <CLINS>
        <CLIN_INFORMATION rec_num="unsignedByte">
          <CLIN_NUMBER>string</CLIN_NUMBER>
          <CLIN_DESCRIPTION>string</CLIN_DESCRIPTION>
          <CLIN_UNIT_PRICE>decimal</CLIN_UNIT_PRICE>
          <CLIN_QUANTITY>decimal</CLIN_QUANTITY>
        </CLIN_INFORMATION>
        <CLIN_INFORMATION rec_num="unsignedByte">
          <CLIN_NUMBER>string</CLIN_NUMBER>
          <CLIN_DESCRIPTION>string</CLIN_DESCRIPTION>
          <CLIN_UNIT_PRICE>decimal</CLIN_UNIT_PRICE>
          <CLIN_QUANTITY>decimal</CLIN_QUANTITY>
        </CLIN_INFORMATION>
      </CLINS>
      <SERVICE_INFORMATION>
        <SERVICE_TYPE>string</SERVICE_TYPE>
        <SERVICE_SUBTYPE>string</SERVICE_SUBTYPE>
        <SERVICE_IDENTIFIER>string</SERVICE_IDENTIFIER>
        <CIRCUIT_ID>string</CIRCUIT_ID>
        <NETWORK_SERVICE_PROVIDER>string</NETWORK_SERVICE_PROVIDER>
        <DEVICE_NAME>string</DEVICE_NAME>
        <IP_ADDRESS_REQUEST>bytes</IP_ADDRESS_REQUEST>
        <LAN_IP_ADDRESS>string</LAN_IP_ADDRESS>
        <LAN_IP_SUBNET>string</LAN_IP_SUBNET>
        <WAN_IP>string</WAN_IP>
        <WAN_SUBNET>string</WAN_SUBNET>
        <PRIMARY_DNS>string</PRIMARY_DNS>
        <SECONDARY_DNS>string</SECONDARY_DNS>
        <WAN_SPEED>string</WAN_SPEED>
        <LAN_SPEED>string</LAN_SPEED>
        <LAN_DUPLEX>bytes</LAN_DUPLEX>
        <IP_HELPER>string</IP_HELPER>
        <IP_TYPE>bytes</IP_TYPE>
        <OOB_PHONE_NUMBER>string</OOB_PHONE_NUMBER>
      </SERVICE_INFORMATION>
      <SPECIAL_INSTRUCTIONS>string</SPECIAL_INSTRUCTIONS>
      <ATTACHMENTS>
        <USPS_ATTACHMENTS rec_num="unsignedByte">
          <USPS_ATTACHMENT_FILENAME>string</USPS_ATTACHMENT_FILENAME>
          <USPS_PROVIDED_ATTACHMENT>base64Binary</USPS_PROVIDED_ATTACHMENT>
        </USPS_ATTACHMENTS>
        <USPS_ATTACHMENTS rec_num="unsignedByte">
          <USPS_ATTACHMENT_FILENAME>string</USPS_ATTACHMENT_FILENAME>
          <USPS_PROVIDED_ATTACHMENT>base64Binary</USPS_PROVIDED_ATTACHMENT>
        </USPS_ATTACHMENTS>
      </ATTACHMENTS>
    </CREATEORDER>
  </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>
    <CREATEORDER_RESP>
      <USPS_ORDER_ID>string</USPS_ORDER_ID>
      <VENDOR_ORDER_ID>string</VENDOR_ORDER_ID>
      <VENDOR_STATUS>string</VENDOR_STATUS>
      <VENDOR_LAST_UPDATED_DATE>dateTime</VENDOR_LAST_UPDATED_DATE>
      <COMMENTS>
        <COMMENTS_INFO rec_num="unsignedByte">
          <COMMENT>string</COMMENT>
        </COMMENTS_INFO>
        <COMMENTS_INFO rec_num="unsignedByte">
          <COMMENT>string</COMMENT>
        </COMMENTS_INFO>
      </COMMENTS>
    </CREATEORDER_RESP>
  </soap12:Body>
</soap12:Envelope>