usps-webtools-api.yml

openapi: 3.0.0
info:
  version: '1.0'
  title: 'USPS Web Tools API'
  description: 'This site is an open source effort to improve the experience for developers utilizing the <a href="https://www.usps.com/business/web-tools-apis/" target="_blank">USPS Web Tools APIs</a>. <br><br>Documentation is generated using [Redoc](https://github.com/Redocly/redoc) and an [OpenAPI 3.0](https://spec.openapis.org/oas/v3.0.0) spec created from the USPS official [documentation](https://www.usps.com/business/web-tools-apis/documentation-updates.htm") (PDF format). <br><br>We have corrected errors and made UX improvements but welcome your feedback on how to improve this site in the future.  Contact us at <a href="mailto: lob-openapi@lob.com?subject=USPSWebTools docs" target="_blank">lob-openapi@lob.com</a>'  
servers:
  - url: 'http://production.shippingapis.com'
tags:
  - name: Who is Lob?
    x-traitTag: true
    description: |
      Lob offers Direct Mail APIs Designed for Developers.
      <br>
      <br>
      <ul>
        <li><a href=" https://docs.lob.com/#tag/Postcards" target="_blank">Print & Mail APIs</a></li>
        <li><a href=" https://docs.lob.com/#tag/US-Verifications" target="_blank">Address Verification APIs</a></li>
        <li><a href=" https://docs.lob.com/#tag/Getting-Started" target="_blank">Get Started with Lob.</a></li>
      </ul>
      <p>
      Transform outdated, manual print & mail processes with Lob’s 
      easy-to-integrate APIs. Trigger on-demand postcards, letters, and 
      checks directly from your CRM or custom applications.
      </p>
      <br>
      <p>
      Improve your mail deliverability by adding address autocomplete on 
      the front-end, and correct, standardize, and cleanse address data 
      for assured delivery across 240+ countries and territories.
      </p>
      <br>
      <p>
      Meet compliance requirements by deploying webhooks to automatically 
      track production and delivery for each piece of mail. 
      Send HIPAA-compliant mailings that properly protect healthcare 
      data and report on real-time and historic mail statuses for 
      compliance audits.
      </p>
  - name: Web Tools Authentication
    x-traitTag: true
    description: |
      USPS Web Tools API are accessible using your Web Tools User ID. To authenticate a request add 
      the USERID attribute to the outermost XML element and set the value equal to your Web Tools User ID.
      <br><br>
      For example, `<AddressValidateRequest USERID="{WEB_TOOLS_USER_NAME}">`
      <br><br>
      [Register](https://www.usps.com/business/web-tools-apis/) on the USPS Web Tools API Portal for your Web Tools ID.
      <br><br>
      You'll receive an email with your Web Tools username (This is your USERID)
      <br><br>
      <img src="images/webtools-email-username.png">
      <br><br>
      
      USPS official [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") - PDF format.
      <br><br>
      <em>Note: USPS Web Tools API does not follow standard OAuth, OpenID or Basic Authentication patterns. For this reason,
      securitySchemes have been omitted in the OpenAPI specification used to generate this documentation. </em> 

      ### Important Notice: User ID
      The Web Tools User ID provided is for you and your company to use when requesting data via the Internet from the U.S. Postal Service API servers. As per the Terms and Conditions of Use Agreement you agreed to during the Web Tools registration process, you are responsible to maintain the confidentiality of your User ID as specified. You may not package any APIs with your User ID for resale or distribution to others. The U.S. Postal Service does not prohibit the reuse and/or distribution of the API documentation (User's Guide) with sample code in order to generate awareness, encourage use or provide ease-of-use to customers or affiliates.
      <br><br>
      <strong>Warning</strong> - If the U.S. Postal Service discovers use of the same User ID from more than one web site, all users will be subject to loss of access to the USPS production server and/or termination of the licenses granted under the Terms and Conditions of Use. 
  - name: Postman
    x-traitTag: true
    description: |
      We've created a Postman public workspace for developers to explore the 
      USPS Web Tools APIs.  You will need your own Web Tools UserID to use this 
      collection.  [See Authentication](#tag/Authentication)

      ### Address Verification
      <div class="postman-run-button" data-postman-action="collection/fork" data-postman-var-1="16169677-e6373072-8748-4ea1-9fa7-bbe3f50b53ca"
      data-postman-collection-url="entityId=16169677-e6373072-8748-4ea1-9fa7-bbe3f50b53ca&entityType=collection&workspaceId=a1340f6a-f0e3-4f1d-b724-0a96e695f12c"></div>
      <script type="text/javascript">
        (function (p,o,s,t,m,a,n) {
          !p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); });
          !o.getElementById(s+t) && o.getElementsByTagName("head")[0].appendChild((
            (n = o.createElement("script")),
            (n.id = s+t), (n.async = 1), (n.src = m), n
        ));
       }(window, document, "_pm", "PostmanRunObject", "https://run.pstmn.io/button.js"));
      </script>

      ### Domestic Mail Service
      <div class="postman-run-button"
        data-postman-action="collection/fork"
        data-postman-var-1="16169677-32a26398-5c84-4628-81cc-1bad9859d093"
        data-postman-collection-url="entityId=16169677-32a26398-5c84-4628-81cc-1bad9859d093&entityType=collection&workspaceId=a1340f6a-f0e3-4f1d-b724-0a96e695f12c"></div>
        <script type="text/javascript">
         (function (p,o,s,t,m,a,n) {
            !p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); });
            !o.getElementById(s+t) && o.getElementsByTagName("head")[0].appendChild((
             (n = o.createElement("script")),
              (n.id = s+t), (n.async = 1), (n.src = m), n
           ));
          }(window, document, "_pm", "PostmanRunObject", "https://run.pstmn.io/button.js"));
      </script>

        ### Track & Confirm Package
        <div class="postman-run-button"
          data-postman-action="collection/fork"
          data-postman-var-1="16169677-1af62154-f1a6-4a66-8e99-8538164e5fcf"
          data-postman-collection-url="entityId=16169677-1af62154-f1a6-4a66-8e99-8538164e5fcf&entityType=collection&workspaceId=a1340f6a-f0e3-4f1d-b724-0a96e695f12c"></div>
          <script type="text/javascript">
            (function (p,o,s,t,m,a,n) {
                !p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); });
               !o.getElementById(s+t) && o.getElementsByTagName("head")[0].appendChild((
                (n = o.createElement("script")),
               (n.id = s+t), (n.async = 1), (n.src = m), n
               ));
           }(window, document, "_pm", "PostmanRunObject", "https://run.pstmn.io/button.js"));
          </script>


  - name: Address Verification APIs
    x-traitTag: false
    description: |  
      The Address Validation APIs can be used in conjunction with USPS 
      SHIPPING OR MAILING SERVICES ONLY. The Address API must only be 
      used on an individual transactional basis, i.e. not batch processing 
      or cleansing of a database, but as a customer enters the information 
      into a form on a website. Failure to comply with these terms and 
      conditions can result in termination of USPS API access without prior 
      notice.
  
  - name: Address
    x-traitTag: false
    description: |
      The Address/Standardization "Verify" API, which corrects errors in street addresses, including 
      abbreviations and missing information, and supplies ZIP Codes and ZIP Codes + 4. The Verify API 
      supports up to five lookups per transaction. By eliminating address errors, you will improve 
      overall package delivery service.
      
  - name: City & State
    x-traitTag: false
    description: |
      City/State Lookup API returns the city and state corresponding to the given ZIP Code. 
      The CityStateLookup API processes up to five lookups per request.
  
  - name: ZIP Code
    x-traitTag: false
    description: |
      The ZipCodeLookup API, which returns the ZIP Code and ZIP Code + 4 corresponding to the given 
      address, city, and state (use USPS state abbreviations). The ZipCodeLookup API processes up to 
      five lookups per request.

  - name: Domestic Mail Service
    x-traitTag: true
    description: |
      Domestic Mail Service Standards

  - name: Priority Mail
    x-traitTag: false
    description: |
      The Priority Mail Service Standards API receives requests and returns the number of days (on average) it will
      take a Priority Mail package to arrive at its destination. Ensure that end-users understand that these are service
      standards and not guaranteed commitments. The Priority Mail Service Standards API processes a single request
      
  - name: StandardB
    x-traitTag: false
    description: |
      The Package Services “StandardB” API receives requests and returns the average number of days it will take a
      package to arrive at its destination. There are four types of Package Services: Standard Post, Bound Printed
      Matter, Library Mail, and Media Mail. The Package Services “StandardB” API processes a single request. Ensure
      that end-users understand that these are service standards and not guaranteed commitments.

  - name: First Class Mail
    x-traitTag: false
    description: |
      The First Class Mail Service Standards API receives requests and returns the average number of days it will take
      a package to arrive at its destination. The First Class Mail Service Standards API processes a single request.
      Ensure that end-users understand that these are service standards and not guaranteed commitments.

  - name: Express Mail Commitment
    x-traitTag: false
    description: |
      The Express Mail Service Commitments API provides delivery commitments for Express Mail packages for the
      given Zip Codes to include package drop-off information. A user provides an origination and a destination Zip
      Code and an optional current or future date that the package will be shipped.

  - name: Package Track & Confirm
    x-traitTag: true
    description: |
      To obtain Package Tracking API (API=TrackV2) access, users will need to contact the USPS Web Tools 
      Program Office to request access and supply additional information for customer verification. 
      
      Note: This applies to both TrackV2 API simplified track requests (i.e., “TrackRequest”) and 
      TrackV2 API detailed track requests (i.e., “TrackFieldRequest”). Users should follow these 
      steps to submit a request for Tracking APIs access: 

      Navigate to: https://usps.force.com/emailus/s/web-tools-inquiry and provide user 
      name (Web Tools User ID), select “Tracking APIs”, select “Track API” and submit the 
      request with the following information below in the “Additional Information” text box:
      <br><br>
      <ul>
      <li>Web Tools UserID</li>
      <li>Mailer ID (MID)</li>
      <li>Company Name</li>
      <li>Requester First and Last Name</li>
      <li>Requester Email</li>
      <li>Requester Phone number</li>
      <li>Mailing Address</li>
      <li>Mailing City</li>
      <li>Mailing State</li>
      <li>Mailing Zip Code</li>
      <li>PROD Registration Date</li>
      <li>API access requested: Package Tracking (API=TrackV2)</li>
      <li>Anticipated volume</li>
      <li>Any additional information from the customer</li>
      </ul>
      Four service APIs are offered in conjunction with “Revision=1” of the Package Tracking “Fields” API: Track and Confirm by Email, Proof of Delivery, Tracking Proof of Delivery, and Return Receipt Electronic. The response data from Track/Confirm Fields request determines which services are available for a tracking ID. Each request input to the Web Tools server for the tracking service APIs is limited to one tracking ID. These APIs require additional permissions from the Web Tools Program Office in order to gain
        
      USPS Web Tools User Guide
      access. When you request access for these APIs, please identify your anticipated API volume, mailer ID, and how you will be utilizing this API. A mailer identification number (MID) is a 6 or 9-digit number assigned to a customer through the USPS Business Customer Gateway (BCG). Please refer to the following links for help:
      
      * https://gateway.usps.com/eAdmin/view/knowledge?securityId=MID • https://postalpro.usps.com/mailing/mailer-id
  
  - name: Package Tracking
    x-traitTag: false
    description: |
      The Track/Confirm Web Tools API provides tracking status and delivery information for USPS packages. The Track/Confirm 
      API limits the data requested to thirty-five (35) packages per transaction.
      <br><br>
      Note: The data returned by the Package Track Web Tools API is intended for display only. The content or sequence of the String 
      data returned by the API may change. Consequently, if you desire to apply any kind of logic against the tracking data, then 
      you will need to use the Track/Confirm fields.
      <br><br>
      The Package Tracking “Fields” API is similar to the Package Track API except for the request fields, API name, and 
      the return information. Data returned still contains the detail and summary information, but this information is 
      broken down into fields instead of having only one line of text. Up to 10 tracking IDs may be contained in each 
      API request to the Web Tools server.

  - name: Track & Confirm by Email
    x-traitTag: false
    description: |
      The Track and Confirm by Email API allows the customer to submit their 
      email address to be notified of current or future tracking activity. 
      When you request access for this API, please identify your anticipated 
      API volume, mailer ID and how you will be utilizing this API. 

      A mailer identification number (MID) is a 6 or 9-digit number assigned 
      to a customer through the USPS Business Customer Gateway (BCG). 
      Please refer to the following links for help:

      * https://gateway.usps.com/eAdmin/view/knowledge?securityId=MID 
      * https://postalpro.usps.com/mailing/mailer-id

  - name: Proof of Delivery
    x-traitTag: false
    description: |

      Proof of Delivery is a letter that includes the recipient's name and a 
      copy of their signature. The Proof of Delivery API allows the customer 
      to request proof of delivery notification via email. When you request 
      access for this API, please identify your anticipated API volume, 
      mailer ID and how you will be utilizing this API. A mailer identification 
      number (MID) is a 6 or 9-digit number assigned to a customer through 
      the USPS Business Customer Gateway (BCG). Please refer to the following 
      links for help:

      * https://gateway.usps.com/eAdmin/view/knowledge?securityId=MID 
      * https://postalpro.usps.com/mailing/mailer-id
  
  - name: Return Receipt Electronic
    x-traitTag: false
    description: |

      The Return Receipt Electronic API allows the customer to request a copy 
      of the proof of delivery record via email. When you request access for 
      this API, please identify your anticipated API volume, mailer ID and 
      how you will be utilizing this API. A mailer identification number (MID) 
      is a 6 or 9-digit number assigned to a customer through the USPS Business 
      Customer Gateway (BCG). Please refer to the following links for help:

      * https://gateway.usps.com/eAdmin/view/knowledge?securityId=MID 
      * https://postalpro.usps.com/mailing/mailer-id

  - name: Track Proof of Delivery
    x-traitTag: false
    description: |
      Track Proof of Delivery is a letter that includes the recipient's name 
      and a copy of their signature. The Track Proof of Delivery API allows 
      the customer to request proof of delivery notification via email. 
      When you request access for this API, please identify your anticipated 
      API volume, mailer ID and how you will be utilizing this API. 
      A mailer identification number (MID) is a 6 or 9-digit number 
      assigned to a customer through the USPS Business Customer Gateway 
      (BCG). Please refer to the following links for help:

      * https://gateway.usps.com/eAdmin/view/knowledge?securityId=MID
      * https://postalpro.usps.com/mailing/mailer-id
  
  - name: Rate Calculation
    x-traitTag: true
    description: |
      USPS Web Tools - Domestic Rate Calculator
  
  - name: Domestic
    x-traitTag: false
    description: |
      The Track/Confirm Web Tools API provides tracking status and delivery information for USPS packages. The Track/Confirm 
      API limits the data requested to thirty-five (35) packages per transaction.
      <br><br>
      Note: The data returned by the Package Track Web Tools API is intended for display only. The content or sequence of the String 
      data returned by the API may change. Consequently, if you desire to apply any kind of logic against the tracking data, then 
      you will need to use the Track/Confirm fields.
      <br><br>
      The Package Tracking “Fields” API is similar to the Package Track API except for the request fields, API name, and 
      the return information. Data returned still contains the detail and summary information, but this information is 
      broken down into fields instead of having only one line of text. Up to 10 tracking IDs may be contained in each 
      API request to the Web Tools server.
  
x-tagGroups:
  - name: Overview
    tags:
      - Who is Lob?
      - Web Tools Authentication
      - Postman
      - Address Verification APIs
      - Address
      - City & State
      - ZIP Code
      - Domestic Mail Service
      - Priority Mail
      - StandardB
      - First Class Mail
      - Express Mail Commitment
      - Package Track & Confirm
      - Package Tracking
      - Track & Confirm by Email
      - Proof of Delivery
      - Return Receipt Electronic
      - Track Proof of Delivery
      - Rate Calculation
      - Domestic
paths:
  /ShippingAPI.dll?API=CityStateLookup":
    get:
      summary: 'Lookup City & State'
      operationId: city_state_lookup
      tags:
        - City & State
      parameters:
        - name: API
          in: query
          description: This query parameter defines the resource you are accessing. For city & state lookup your API query param value must equal `CityStateLookup`.
          required: true
          schema:
            type: string
            default: CityStateLookup
        - name: XML
          in: query
          description: This query parameter defines the XML payload and it can not be passed in the body<br><br><div class="code"><p id="isPasted">&lt;CityStateLookupRequest USERID=&quot;XXXXXX&quot;&gt;<br>&nbsp; &nbsp; &lt;ZipCode&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Zip5&gt;94107&lt;/Zip5&gt;<br>&nbsp; &nbsp; &lt;/ZipCode&gt;<br>&lt;/CityStateLookupRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CityStateLookupRequest'
              x-example: '<CityStateLookupRequest USERID="{WEB_TOOLS_USER_NAME}">
                            <ZipCode>
                                <Zip5>94107</Zip5>
                            </ZipCode>
                        </CityStateLookupRequest>'
      responses:
        '200':
          description: response to City State lookup'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CityStateLookupResponse'
              example: '<CityStateLookupResponse>
                            <ZipCode>
                                <Zip5>94556</Zip5>
                                <City>MORAGA</City>
                                <State>CA</State>
                            </ZipCode>
                        </CityStateLookupResponse>'
  /ShippingAPI.dll?API=Verify:
    get:
      summary: 'Verify a US address'
      operationId: verify
      tags:
        - Address
      parameters:
        - name: API
          in: query
          description: This query parameter defines the resource you are accessing. For address verification your API query param value must equal `Verify`.
          required: true
          schema:
            type: string
            default: Verify
        - name: XML
          in: query
          description: This query parameter defines the XML payload and can not be passed in the body<br><br><div class="code">&lt;AddressValidateRequest USERID=&quot;XXXXXX&quot;&gt;<br>&nbsp; &nbsp; &lt;Revision&gt;1&lt;/Revision&gt;<br>&nbsp; &nbsp; &lt;Address&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Address1&gt;Suite 6100&lt;/Address1&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Address2&gt;185 Berry St&lt;/Address2&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;City&gt;San Francisco&lt;/City&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;State&gt;CA&lt;/State&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Zip5&gt;94556&lt;/Zip5&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Zip4&gt;&lt;/Zip4&gt;<br>&nbsp; &nbsp; &lt;/Address&gt;<br>&lt;/AddressValidateRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AddressValidateRequest'
              example: '<AddressValidateRequest USERID="{WEB_TOOLS_USER_NAME}">
                            <Revision>1</Revision>
                            <Address>
                                <Address1>Suite 6100</Address1>
                                <Address2>185 Berry St</Address2>
                                <City>San Francisco</City>
                                <State>CA</State>
                                <Zip5>94556</Zip5>
                                <Zip4></Zip4>
                            </Address>
                        </AddressValidateRequest>'
      responses:
        '200':
          description: response to Address verification'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AddressValidateResponse'
              example: '<AddressValidateResponse>
                            <Address>
                                <Address1>STE 6100</Address1>
                                <Address2>185 BERRY ST</Address2>
                                <City>SAN FRANCISCO</City>
                                <State>CA</State>
                                <Zip5>94107</Zip5>
                                <Zip4>1741</Zip4>
                                <DeliveryPoint>25</DeliveryPoint>
                                <CarrierRoute>C001</CarrierRoute>
                                <Footnotes>AN</Footnotes>
                                <DPVConfirmation>Y</DPVConfirmation>
                                <DPVCMRA>N</DPVCMRA>
                                <DPVFootnotes>AABB</DPVFootnotes>
                                <Business>Y</Business>
                                <CentralDeliveryPoint>N</CentralDeliveryPoint>
                                <Vacant>N</Vacant>
                            </Address>
                        </AddressValidateResponse>'
  /ShippingAPI.dll?API=ZipCodeLookup:
    get:
      summary: 'Lookup a ZIP Code'
      operationId: zipcode_lookup
      tags:
        - ZIP Code
      parameters:
        - name: API
          in: query
          description: This query parameter defines the resource you are accessing. For ZIP Code lookup your API query param value must equal `ZipCodeLookup`.
          required: true
          schema:
            type: string
            default: ZipCodeLookup
        - name: XML
          in: query
          description: This query parameter defines the XML payload. and it can not be passed in the body<br><br><div class="code">&lt;ZipCodeLookupRequest USERID=&quot;XXXXXX&quot;&gt;<br>&nbsp; &nbsp; &lt;Address&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Address1&gt;Suite 6100&lt;/Address1&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Address2&gt;185 Berry St&lt;/Address2&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;City&gt;San Francisco&lt;/City&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;State&gt;CA&lt;/State&gt;<br>&nbsp; &nbsp; &lt;/Address&gt;<br>&lt;/ZipCodeLookupRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ZipCodeLookupRequest'
              example: '<ZipCodeLookupRequest USERID="{WEB_TOOLS_USER_NAME}">
                            <Address>
                                <Address1>Suite 6100</Address1>
                                <Address2>185 Berry St</Address2>
                                <City>San Francisco</City>
                                <State>CA</State>
                            </Address>
                        </ZipCodeLookupRequest>'
      responses:
        '200':
          description: response to ZIP Code lookup'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ZipCodeLookupResponse'
              example: '<ZipCodeLookupResponse>
                            <Address>
                                <Address1>STE 6100</Address1>
                                <Address2>185 BERRY ST</Address2>
                                <City>SAN FRANCISCO</City>
                                <State>CA</State>
                                <Zip5>94107</Zip5>
                                <Zip4>1741</Zip4>
                            </Address>
                        </ZipCodeLookupResponse>'
  /ShippingAPI.dll?API=PriorityMail:
    get:
      summary: 'Priority Mail Service'
      operationId: priority_mail
      tags:
        - Priority Mail
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: PriorityMail
        - name: XML
          in: query
          description: XML payload <br><br><div class="code">&lt;PriorityMailRequest USERID=&rdquo;XXXXXXXXXXXX&rdquo;&gt;<br>&nbsp; &nbsp; &lt;OriginZip&gt;90201&lt;/OriginZip&gt;<br>&nbsp; &nbsp; &lt;DestinationZip&gt;21114&lt;/DestinationZip&gt;<br>&lt;/PriorityMailRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PriorityMailRequest'
              example: '<PriorityMailRequest USERID=”XXXXXXXXXXXX”>
                            <OriginZip>90201</OriginZip>
                            <DestinationZip>21114</DestinationZip>
                        </PriorityMailRequest>'
      responses:
        '200':
          description: response to Priority Mail'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PriorityMailResponse'
              example: '<PriorityMailResponse>
                            <OriginZip>90210</OriginZip>
                            <DestinationZip>94556</DestinationZip>
                            <Days>4</Days>
                            <EffectiveAcceptanceDate>2022-02-24</EffectiveAcceptanceDate>
                            <ScheduledDeliveryDate>2022-02-28</ScheduledDeliveryDate>
                        </PriorityMailResponse>'
  /ShippingAPI.dll?API=StandardB:
    get:
      summary: 'Standard B Service'
      operationId: standardb
      tags:
        - StandardB
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: StandardB
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;StandardBRequest USERID=&rdquo;XXXXXXXXXXXX&rdquo;&gt;<br>&nbsp; &nbsp; &lt;OriginZip&gt;90201&lt;/OriginZip&gt;<br>&nbsp; &nbsp; &lt;DestinationZip&gt;21114&lt;/DestinationZip&gt;<br>&lt;/StandardBRequest&gt;<br></div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/StandardBRequest'
              example: '<StandardBRequest USERID=”XXXXXXXXXXXX”>
                            <OriginZip>90201</OriginZip>
                            <DestinationZip>21114</DestinationZip>
                        </StandardBRequest>'
      responses:
        '200':
          description: response to StandardB mail'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/StandardBResponse'
              example: '<StandardBResponse>
                            <OriginZip>90201</OriginZip>
                            <DestinationZip>21114</DestinationZip>
                            <Days>7</Days>
                        </StandardBResponse>'
  /ShippingAPI.dll?API=FirstClassMail:
    get:
      summary: 'First Class Mail Service'
      operationId: first_class_mail
      tags:
        - First Class Mail
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: FirstClassMail
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;FirstClassMailRequest USERID=&rdquo;XXXXXXXXXXXX&rdquo;&gt;<br>&nbsp; &nbsp; &lt;OriginZip&gt;90201&lt;/OriginZip&gt;<br>&nbsp; &nbsp; &lt;DestinationZip&gt;21114&lt;/DestinationZip&gt;<br>&lt;/FirstClassMailRequest&gt;<br></div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/FirstClassMailRequest'
              example: '<FirstClassMailRequest USERID=”XXXXXXXXXXXX”>
                            <OriginZip>90201</OriginZip>
                            <DestinationZip>21114</DestinationZip>
                        </FirstClassMailRequest>'  
      responses:
        '200':
          description: response to First Class Mail'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/FirstClassMailResponse'
              example: '<FirstClassMailResponse>
                            <OriginZip>90201</OriginZip>
                            <DestinationZip>21114</DestinationZip>
                            <Days>3</Days>
                        </FirstClassMailResponse>'
  /ShippingAPI.dll?API=ExpressMailCommitment:
    get:
      summary: 'Express Mail Commitment Service'
      operationId: express_mail_commitment
      tags:
        - Express Mail Commitment
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: ExpressMailCommitment
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;ExpressMailCommitmentRequest USERID=&quot;XXXXXXXXXXXXX&quot;&gt;<br>&nbsp; &nbsp; &lt;OriginZIP&gt;63123&lt;/OriginZIP&gt;<br>&nbsp; &nbsp; &lt;DestinationZIP&gt;89301&lt;/DestinationZIP&gt;<br>&nbsp; &nbsp; &lt;Date&gt;05-26-2021&lt;/Date&gt;<br>&nbsp; &nbsp; &lt;DropOffTime&gt;09:00&lt;/DropOffTime&gt;<br>&nbsp; &nbsp; &lt;ReturnDates&gt;true&lt;/ReturnDates&gt;<br>&nbsp; &nbsp; &lt;PMGuarantee&gt;Y&lt;/PMGuarantee&gt;<br>&lt;/ExpressMailCommitmentRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                  $ref: '#/components/schemas/ExpressMailCommitmentRequest'
              example: '<ExpressMailCommitmentRequest USERID="{WEB_TOOLS_USER_NAME}">
                            <OriginZIP>63123</OriginZIP>
                            <DestinationZIP>89301</DestinationZIP>
                            <Date>05-26-2021</Date>
                            <DropOffTime>09:00</DropOffTime>
                            <ReturnDates>true</ReturnDates>
                            <PMGuarantee>Y</PMGuarantee>
                        </ExpressMailCommitmentRequest>'
      responses:
        '200':
          description: response to Priority Mail'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ExpressMailCommitmentResponse'
              example: '<ExpressMailCommitmentResponse>
                            <OriginZIP>63123</OriginZIP>
                            <OriginCity>SAINT LOUIS</OriginCity>
                            <OriginState>MO</OriginState>
                            <DestinationZIP>89301</DestinationZIP>
                            <DestinationCity>ELY</DestinationCity>
                            <DestinationState>NV</DestinationState>
                            <Date>26-May-2021</Date>
                            <Time>9:00AM</Time>
                            <EffectiveAcceptanceDate>2021-05-26</EffectiveAcceptanceDate>
                            <Commitment>
                                <CommitmentName>2-Day</CommitmentName>
                                <CommitmentTime>6:00 PM</CommitmentTime>
                                <CommitmentSequence>A0218</CommitmentSequence>
                                <Location>
                                    <ScheduledDeliveryDate>2021-05-28</ScheduledDeliveryDate>
                                    <CutOff>5:30 PM</CutOff>
                                    <Facility>POST OFFICE</Facility>
                                    <Street>55 GRASSO PLZ</Street>
                                    <City>SAINT LOUIS</City>
                                    <State>MO</State>
                                    <Zip>63123</Zip>
                                </Location>
                            </Commitment>
                            <Commitment>
                                <CommitmentName>2-Day</CommitmentName>
                                <CommitmentTime>6:00 PM</CommitmentTime>
                                <CommitmentSequence>B0218</CommitmentSequence>
                                <Location>
                                    <ScheduledDeliveryDate>2021-05-28</ScheduledDeliveryDate>
                                    <CutOff>5:30 PM</CutOff>
                                    <Facility>POST OFFICE</Facility>
                                    <Street>55 GRASSO PLZ</Street>
                                    <City>SAINT LOUIS</City>
                                    <State>MO</State>
                                    <Zip>63123</Zip>
                                </Location>
                            </Commitment>
                        </ExpressMailCommitmentResponse>'
  /ShippingAPI.dll?API=PTSTPod:
    get:
      summary: 'Track Proof of Delivery'
      operationId: track_proof_of_delivery
      tags:
        - Track Proof of Delivery
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: PTSTPod
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;PTSTPodRequest USERID=&quot;XXXXXXXXXXXX&quot;&gt;<br>&nbsp; &nbsp; &lt;TrackId&gt;XXXXXXXXXXX&lt;/TrackId &gt;<br>&nbsp; &nbsp; &lt;MpSuffix&gt;9402&lt;/MpSuffix&gt;<br>&nbsp; &nbsp; &lt;MpDate&gt;2009-07-02 00:42:23.35744&lt;/MpDate&gt;<br>&nbsp; &nbsp; &lt;RequestType&gt;Email&lt;/RequestType&gt;<br>&nbsp; &nbsp; &lt;FirstName&gt;John&lt;/FirstName&gt;<br>&nbsp; &nbsp; &lt;LastName&gt;Doe&lt;/LastName&gt;<br>&nbsp; &nbsp; &lt;Email1&gt;cpapple@email.com &lt;/Email1&gt;<br>&nbsp; &nbsp; &lt;Email2&gt;&lt;/Email2&gt;<br>&nbsp; &nbsp; &lt;Email3&gt;&lt;/Email3&gt;<br>&nbsp; &nbsp; &lt;CustRegID&gt;1234567890&lt;/CustRegID&gt;<br>&nbsp; &nbsp; &lt;TableCode&gt;T&lt;/TableCode&gt;<br>&nbsp; &nbsp; &lt;ClientIp&gt;127.0.0.1&lt;/ClientIp&gt;<br>&nbsp; &nbsp; &lt;SourceId&gt;IVR&lt;/SourceId&gt;<br>&lt;/PTSTPodRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PTSTPodRequest'
              example: '<PTSTPodRequest USERID="{WEB_TOOLS_USER_NAME}">
                          <TrackId>XXXXXXXXXXX</TrackId >
                          <MpSuffix>9402</MpSuffix>
                          <MpDate>2009-07-02 00:42:23.35744</MpDate>
                          <RequestType>Email</RequestType>
                          <FirstName>John</FirstName>
                          <LastName>Doe</LastName>
                          <Email1>cpapple@email.com </Email1>
                          <Email2></Email2>
                          <Email3></Email3>
                          <CustRegID>1234567890</CustRegID>
                          <TableCode>T</TableCode>
                          <ClientIp>127.0.0.1</ClientIp>
                          <SourceId>IVR</SourceId>
                        </PTSTPodRequest>'
      responses:
        '200':
          description: response to package tracking'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PTSTPodResult'
              example: '<PTSTPODRESULT>
                          <ResultText>Your Proof of Delivery record is complete and will be processed shortly.</ResultText>
                          <ReturnCode>0</ReturnCode>
                        </PTSTPODRESULT>'
  /ShippingAPI.dll?API=PTSRre:
    get:
      summary: 'Return Receipt Electronic'
      operationId: return_receipt_electronic
      tags:
        - Return Receipt Electronic
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: PTSRre
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;PTSRreRequest USERID=&quot;XXXXXXXXXXXX&quot;&gt;&nbsp;<br>&nbsp; &nbsp; &lt;TrackId&gt;XXXXXXXXXXX&lt;/TrackId &gt;&nbsp;<br>&nbsp; &nbsp; &lt;ClientIp&gt;127.0.0.1&lt;/ClientIp&gt;<br>&nbsp; &nbsp; &lt;SourceId&gt;XYZ Corp&lt;/SourceId&gt;<br>&nbsp; &nbsp; &lt;MpSuffix&gt;9402&lt;/MpSuffix&gt;<br>&nbsp; &nbsp; &lt;MpDate&gt;2009-07-02 00:42:23.35744&lt;/MpDate&gt;<br>&nbsp; &nbsp; &lt;FirstName&gt;John&lt;/FirstName&gt;<br>&nbsp; &nbsp; &lt;LastName&gt;Doe&lt;/LastName&gt;<br>&nbsp; &nbsp; &lt;Email1&gt;cpapple@email.com&lt;/Email1&gt;<br>&nbsp; &nbsp; &lt;Email2&gt;&lt;/Email2&gt;<br>&nbsp; &nbsp; &lt;Email3&gt;&lt;/Email3&gt;<br>&nbsp; &nbsp; &lt;TableCode&gt;T&lt;/TableCode&gt;<br>&nbsp; &nbsp; &lt;CustRegID&gt;1234567890&lt;/CustRegID&gt;<br>&lt;/PTSRreRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PTSRreRequest'
              example: '<PTSRreRequest USERID="{WEB_TOOLS_USER_NAME}"> 
                          <TrackId>XXXXXXXXXXX</TrackId > 
                          <ClientIp>127.0.0.1</ClientIp>
                          <SourceId>XYZ Corp</SourceId>
                          <MpSuffix>9402</MpSuffix>
                          <MpDate>2009-07-02 00:42:23.35744</MpDate>
                          <FirstName>John</FirstName>
                          <LastName>Doe</LastName>
                          <Email1>cpapple@email.com</Email1>
                          <Email2></Email2>
                          <Email3></Email3>
                          <TableCode>T</TableCode>
                          <CustRegID>1234567890</CustRegID>
                        </PTSRreRequest>'
      responses:
        '200':
          description: response to package tracking'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PTSRreResult'
              example: '<PTSRRERESULT>
                          <ResultText>Your Proof of Delivery record is complete and will be processed shortly</ResultText>
                          <ReturnCode>0</ReturnCode>
                        </PTSRRERESULT>'
  /ShippingAPI.dll?API=PTSPod:
    get:
      summary: 'Proof of Delivery'
      operationId: proof_of_delivery
      tags:
        - Proof of Delivery
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: PTSPod
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;PTSPodRequest USERID=&quot;XXXXXXXXXXXX&quot;&gt;&nbsp;<br>&nbsp; &nbsp; &lt;TrackId&gt;XXXXXXXXXXX&lt;/TrackId &gt;<br>&nbsp; &nbsp; &lt;ClientIp&gt;127.0.0.1&lt;/ClientIp&gt;<br>&nbsp; &nbsp; &lt;SourceId&gt;XXXXXX&lt;/SourceId&gt;<br>&nbsp; &nbsp; &lt;MpSuffix&gt;9402&lt;/MpSuffix&gt;<br>&nbsp; &nbsp; &lt;MpDate&gt;2009-07-02 00:42:23.35744&lt;/MpDate&gt;<br>&nbsp; &nbsp; &lt;RequestType&gt;Email&lt;/RequestType&gt;<br>&nbsp; &nbsp; &lt;FirstName&gt;John&lt;/FirstName&gt;<br>&nbsp; &nbsp; &lt;LastName&gt;Doe&lt;/LastName&gt;<br>&nbsp; &nbsp; &lt;Email1&gt;test@email.com &lt;/Email1&gt;<br>&nbsp; &nbsp; &lt;Email2&gt;&lt;/Email2&gt;<br>&nbsp; &nbsp; &lt;Email3&gt;&lt;/Email3&gt;&nbsp;<br>&nbsp; &nbsp; &lt;TableCode&gt;T&lt;/TableCode&gt;<br>&nbsp; &nbsp; &lt;CustRegID&gt;1234567890&lt;/CustRegID&gt;<br>&lt;/PTSPodRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PTSPodRequest'
              example: '<PTSPodRequest USERID="{WEB_TOOLS_USER_NAME}"> 
                          <TrackId>XXXXXXXXXXX</TrackId >
                          <ClientIp>127.0.0.1</ClientIp>
                          <SourceId>XXXXXX</SourceId>
                          <MpSuffix>9402</MpSuffix>
                          <MpDate>2009-07-02 00:42:23.35744</MpDate>
                          <RequestType>Email</RequestType>
                          <FirstName>John</FirstName>
                          <LastName>Doe</LastName>
                          <Email1>test@email.com </Email1>
                          <Email2></Email2>
                          <Email3></Email3> 
                          <TableCode>T</TableCode>
                          <CustRegID>1234567890</CustRegID>
                        </PTSPodRequest>'
      responses:
        '200':
          description: response to package tracking'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PTSPodResponse'
              example: '<PTSPODRESULT>
                          <ResultText>Your Proof of Delivery record is complete and will be processed shortly.</ResultText> <ReturnCode>0</ReturnCode>
                        </PTSPODRESULT>'
  /ShippingAPI.dll?API=PTSEmail:
    get:
      summary: 'Track & Confirm by Email'
      operationId: track_confirm_by_email
      tags:
        - Track & Confirm by Email
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: PTSEmail
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;PTSEmailRequest USERID=&quot;XXXXXXXXXXXX&quot;&gt;&nbsp;<br>&nbsp; &nbsp; &lt;TrackId&gt;XXXXXXXXXXX&lt;/TrackId &gt;&nbsp;<br>&nbsp; &nbsp; &lt;ClientIp&gt;127.2.0.1&lt;/ClientIp&gt;<br>&nbsp; &nbsp; &lt;SourceId&gt;XYZ Corp&lt;/SourceId&gt;<br>&nbsp; &nbsp; &lt;MpSuffix &gt;9402&lt;/MpSuffix&gt;<br>&nbsp; &nbsp; &lt;MpDate &gt;2021-07-02 00:42:23.35744&lt;/MpDate&gt;&nbsp;<br>&nbsp; &nbsp; &lt;RequestType&gt;EN&lt;/RequestType&gt;&nbsp;<br>&nbsp; &nbsp; &lt;FirstName&gt;John&lt;/FirstName&gt;<br>&nbsp; &nbsp; &lt;LastName &gt;Doe&lt;/LastName&gt;&nbsp;<br>&nbsp; &nbsp; &lt;Email1&gt;test@email.com&lt;/Email1&gt;&nbsp;<br>&nbsp; &nbsp; &lt;Email2&gt;&lt;/Email2&gt;<br>&nbsp; &nbsp; &lt;Email3&gt;&lt;/Email3&gt;<br>&lt;/PTSEmailRequest&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PTSEmailRequest'
              example: '<PTSEmailRequest USERID="{WEB_TOOLS_USER_NAME}"> <TrackId>XXXXXXXXXXX</TrackId > <ClientIp>127.2.0.1</ClientIp>
                          <SourceId>XYZ Corp</SourceId>
                          <MpSuffix >9402</MpSuffix>
                          <MpDate >2009-07-02 00:42:23.35744</MpDate> <RequestType>EN</RequestType> <FirstName>John</FirstName>
                          <LastName >Doe</LastName> <Email1>test@email.com</Email1> <Email2></Email2>
                          <Email3></Email3>
                        </PTSEmailRequest>'
      responses:
        '200':
          description: response to package tracking'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PTSEmailResponse'
              example: '<PTSEMAILRESULT>
                          <ResultText>Your request for all activity to-date will be processed within four hours. Any future activity will be processed whenever there is new delivery related event activity.</ResultText> <ReturnCode>0</ReturnCode>
                        </PTSEMAILRESULT>'
  /ShippingAPI.dll?API=TrackV2:
    get:
      summary: 'Package Tracking'
      operationId: package_tracking
      tags:
        - Package Tracking
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: TrackV2
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;TrackRequest USERID=&quot;XXXXXXXXXXXX&quot;&gt;<br>&nbsp; &nbsp; &lt;TrackID ID=&quot;XXXXXXXXXXX1&quot;&gt;&lt;/TrackID&gt;<br>&nbsp; &nbsp; &lt;TrackID ID=&quot;XXXXXXXXXXX2&quot;&gt;&lt;/TrackID&gt;<br>&lt;/TrackRequest&gt;<br></div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TrackRequest'
              example: '<TrackRequest USERID="{WEB_TOOLS_USER_NAME}">
                            <TrackID ID="XXXXXXXXXXX1"></TrackID>
                            <TrackID ID="XXXXXXXXXXX2"></TrackID>
                        </TrackRequest>'
      responses:
        '200':
          description: response to package tracking'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TrackResponse'
              example: '<TrackResponse>
                            <TrackInfo ID="XXXXXXXXXXX1">
                                <TrackSummary> Your item was delivered at 6:50 am on February 6 in BARTOW FL33830.</TrackSummary>
                                <TrackDetail>February 6 6:49 am NOTICE LEFT BARTOW FL 33830</TrackDetail>
                                <TrackDetail>February 6 6:48 am ARRIVAL AT UNIT BARTOW FL 33830</TrackDetail>
                                <TrackDetail>February 6 3:49 am ARRIVAL AT UNIT LAKELAND FL 33805</TrackDetail>
                                <TrackDetail>February 5 7:28 pm ENROUTE 33699</TrackDetail>
                                <TrackDetail>February 5 7:18 pm ACCEPT OR PICKUP 33699</TrackDetail>
                            </TrackInfo>
                        </TrackResponse>'
    post:
      summary: 'Package Tracking Fields'
      operationId: package_tracking_fields
      tags:
        - Package Tracking
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: TrackV2
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;TrackFieldRequest USERID=&quot;XXXXXXXXXXXX&quot;&gt;<br>&nbsp; &nbsp; &lt;Revision&gt;1&lt;/Revision&gt;&nbsp;<br>&nbsp; &nbsp; &lt;ClientIp&gt;122.3.3&lt;/ClientIp&gt;<br>&nbsp; &nbsp; &lt;SourceId&gt;XYZ Corp&lt;/SourceId&gt;<br>&nbsp; &nbsp; &lt;TrackID ID=&quot;XXXXXXXXXXXXXXXX&quot;/&gt;&nbsp;<br>&lt;/TrackFieldRequest&gt;<br></div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/TrackFieldRequest'
              example: '<TrackFieldRequest USERID="{WEB_TOOLS_USER_NAME}"> 
                            <Revision>1</Revision> 
                            <ClientIp>122.3.3</ClientIp>
                            <SourceId>XYZ Corp</SourceId>
                            <TrackID ID="XXXXXXXXXXXXXXXX"/> 
                        </TrackFieldRequest>'
      responses:
        '200':
          description: response to package tracking fields'
          content:
            text/xml:
              schema:
                type: object
                xml:
                  name: 'TrackResponse'
                required:
                - TrackInfo
                properties:
                  TrackInfo:
                    type: object
                    xml:
                      name: 'TrackInfo'
                    required:
                    - ID
                    - TrackSummary
                    - TrackDetail
                    description: 'Integer value used to return of all available response fields. Set this value to 1 to return all currently documented response fields.'
                    properties:
                      ID:
                        type: string
                        default: 826ADISY3274
                        description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
                        xml:
                          attribute: true
                      GuaranteedDeliveryDate:
                          type: string
                          format: 'date'
                          description: 'Global Express Mail only: certain countries provide a guarantee delivery.'
                          example: 'March 5, 2022'
                      TrackSummary:
                          type: object
                          required:
                          - EventTime
                          - EventDate
                          - Event
                          - EventCity
                          - EventState
                          - EventZIPCode
                          description: 'Tracking Summary Information'
                          properties:
                            EventTime:
                                type: string
                                description: 'The time of the event'
                                example: '12:49 pm'
                            EventDate:
                                type: string
                                description: 'The date of the event'
                                example: 'March 5, 2022'
                            Event:
                                type: string
                                description: 'The event type'
                                example: 'USPS in possession of item'
                            EventCity:
                                type: string
                                description: 'City where the event occurred'
                                example: 'MORAGA'
                            EventState:
                                type: string
                                description: 'State where the event occurred'
                                example: 'CA'
                            EventZIPCode:
                                type: string
                                description: 'ZIP Code of the event.'
                                example: '94556'
                            EventCountry:
                                type: string
                                description: 'Country where the event occurred'
                                example: 'US'
                            FirmName:
                                type: string
                                description: 'Company name if delivered to a company'
                                example: 'ACME corp'
                            Name:
                                type: string
                                description: 'Name of the persons signing for delivery (if available)'
                            AuthorizedAgent:
                              type: boolean
                              description: 'True/False field indicating the person signing as an Authorized Agent'
                              example: 'False'
                            EventCode:
                              type: string
                              description: 'The event code'
                              example: '03'
                            EventStatusCategory:
                              type: string
                              description: 'The status of a posted event on a mail piece.'
                              example: 'CMCXXXX Delivered'
                            ActionCode:
                                type: string
                                description: 'The action code'
                                example: '102'
                            ReasonCode:
                                type: string
                                description: 'The reason code'
                                example: '04B'
                      TrackDetail:
                        type: object
                        required:
                        - EventTime
                        - EventDate
                        - Event
                        - EventCity
                        - EventState
                        - EventZIPCode
                        description: 'Tracking Detail Information. This group is repeatable'
                        properties:
                          DeliveryAttributeCode:
                            type: string
                            enum:
                              - '32'
                            description: 'Used to provide additional information regarding an event posted to a mail piece.'
                            example: '32'
                          EventTime:
                              type: string
                              description: 'The time of the event'
                              example: '12:49 pm'
                          EventDate:
                              type: string
                              description: 'The date of the event'
                              example: 'March 5, 2022'
                          Event:
                              type: string
                              description: 'The event type'
                              example: 'USPS in possession of item'
                          EventCity:
                              type: string
                              description: 'City where the event occurred'
                              example: 'MORAGA'
                          EventState:
                              type: string
                              description: 'State where the event occurred'
                              example: 'CA'
                          EventStatusCategory:
                            type: string
                            description: 'The status of a posted event on a mail piece.'
                            example: 'CA'
                          EventPartner:
                            type: string
                            description: 'Stores the name of the shipping partner associated to a posted shipping partner event (80,81,82)'
                            example: 'CA'
                          EventZIPCode:
                              type: string
                              description: 'ZIP Code of the event.'
                              example: '94556'
                          EventCountry:
                              type: string
                              description: 'Country where the event occurred'
                              example: 'US'
                          FirmName:
                              type: string
                              description: 'The company name if delivered to a company'
                              example: 'ACME corp'
                          Name:
                              type: string
                              description: 'The name of the persons signing for delivery (if available)'
                              example: 'John Doe'
                          AuthorizedAgent:
                              type: boolean
                              description: 'True/False field indicating the person signing as an Authorized Agent'
                              example: 'False'
                          EventCode:
                              type: string
                              description: 'The event code'
                              example: '03'
                          ActionCode:
                              type: string
                              description: 'The action code'
                              example: '03'
                          ReasonCode:
                              type: string
                              description: 'The reason code'
                          GeoCertified:
                            type: boolean
                            description: 'Only eligible to display with delivery'
                            example: 'False'
                      RequestSeqNumber:
                        type: number
                        description: 'A unique identification number for a request. The same number that was provided in the request.'
                        example: '122'
                      AdditionalInfo:
                        type: string
                        description: 'Additional package information'
                      ADPScripting:
                        type: string
                        description: 'Additional ADP scripting specific to the ADP Type code'
                      ArchiveRestoreInfo:
                        type: string
                        description: 'Information regarding availability of Restore service function'
                        example: 'Yes'
                      AssociatedLabel:
                        type: string
                        description: 'Additional Label on the mail piece'
                        example: 'EA123456785US'
                      CarrierRelease:
                        type: boolean
                        description: 'Field indicating the item qualifies for the customer to electronically authorize shipment release.'
                        example: 'False'
                      Class:
                        type: string
                        description: 'Mail Class of the mail piece (human readable). This will also include the service standard message if it exists.'
                        example: 'True'
                      ClassofMailCode:
                        type: string
                        description: 'Mail Class of the mail piece (code).'
                        example: 'CP'
                      DestinationCity:
                        type: string
                        description: 'The destination city.'
                        example: 'NEW ORLEANS'
                      DestinationCountryCode:
                        type: string
                        description: 'The destination country code'
                        example: 'US'
                      DestinationState:
                        type: string
                        description: 'The destination State'
                        example: 'LA'
                      DestinationZip:
                        type: string
                        description: 'The destination ZIP code'
                        example: '70117'
                      EditedLabelID:
                        type: string
                        description: 'Edited Label ID or Full Label ID. Used only when Source ID is IVR'
                        example: 'EA123456795US'
                      EmailEnabled:
                        type: boolean
                        description: 'Signifies if USPS Tracking by Email service is enabled.'
                        example: 'false'
                      EndOfDay:
                        type: string
                        description: 'Populated with the end of day time provided by TRP when TRP API indicates the window is “End of Day” or when the piece is eligible for the PTR default end of day.'
                        example: '5:00pm'
                      eSOFEligible:
                        type: boolean
                        description: 'Signifies if the mailpiece is eSOF eligibile.'
                        example: 'false'
                      ExpectedDeliveryDate:
                        type: string
                        description: 'Expected delivery date.'
                        example: 'December 31, 2022'
                      ExpectedDeliveryTime:
                        type: string
                        description: 'Expected Delivery Time'
                        example: '3:00 PM'
                      ExpectedDeliveryType:
                        type: string
                        description: 'Populates "Expected Delivery by" if there is an EDD.'
                        example: 'Expected Delivery by'
                      GuaranteedDeliveryTime:
                        type: string
                        description: 'Guaranteed Delivery Time provided for Priority Mail Express.'
                        example: '3:00 PM'
                      GuaranteedDeliveryType:
                        type: string
                        description: 'Populates "Scheduled Delivery by" if there is a GDD'
                        example: 'Scheduled Delivery by'
                      GuaranteedDetails:
                        type: string
                        description: 'Special messaging related to the guarantee.'
                        example: 'Loss Only Guarantee'
                      ItemShape:
                        type: string
                        enum:
                            - Letter
                            - Flat
                            - Parcel
                            - Unknown
                        description: 'Indicates the shape of the item.'
                      KahalaIndicator:
                        type: boolean
                        description: 'no description'
                        example: 'False'
                      MailTypeCode:
                        type: string
                        description: 'no description'
                        example: 'DM'
                      MPDATE:
                        type: string
                        description: 'Internal date stamp'
                        example: '2019-08-21 10:44:08.000000'
                      MPSUFFIX:
                        type: string
                        description: 'Internal suffix'
                        example: '999999999'
                      OnTime:
                        type: boolean
                        description: 'Field indicating if the item will be delivered on time as specified in the Expected or Guaranteed delivery date.'
                        example: 'False'
                      OriginCity:
                        type: string
                        description: 'The origin city'
                        example: 'San Francisco'
                      OriginCountryCode:
                        type: string
                        description: 'The origin country code'
                        example: 'US'
                      OriginState:
                        type: string
                        description: 'The origin state'
                        example: 'CA'
                      OriginZip:
                        type: string
                        description: 'The origin ZIP code'
                        example: '94107'
                      PodEnabled:
                        type: boolean
                        description: 'Signifies if Proof of Delivery service is enabled'
                        example: 'True'
                      PredictedDeliveryDate:
                        type: string
                        description: 'Predicted delivery date'
                        example: 'December 30, 2022'
                      PredictedDeliveryTime:
                        type: string
                        description: 'Predicted Delivery Time'
                        example: '3:00 PM'
                      PredictedDeliveryType:
                        type: string 
                        description: 'Populates "Expected Delivery "by or on", if the source of the PDD is TRP API. Populates "Expected Delivery on" if the source of the PDD is a PTR calculated date.'
                        example: 'Expected Delivery on'
                      PredictedDeliverySource:
                        type: string
                        description: 'States which system provided the Predicted Delivery prediction. TRP, AA'
                        example: 'TRP'
                      PDWStart:
                        type: string
                        description: 'Predicted Delivery Window start time in am/pm format. In an EndOfDay scenario, the PDWStart tag is null.'
                        example: '11:00am'
                      PDWEnd:
                        type: string
                        description: 'Predicted Delivery Window end time in am/pm format. In an EndOfDay scenario, the PDWEnd tag is null.'
                        example: '1:00pm'
                      PurgeByDate:
                        type: string
                        format: 'date'
                        description: 'Contains the Purge By Date of the mail piece.'
                        example: 'December 31, 2024'
                      RelatedRRID:
                        type: string
                        description: 'The related label ID between a tracking barcode, the core product, and a PS3811, Green Card Return Reciept. This field can contain either the core product label ID or the Green Card label ID. There is only a one to one relationship. Core Product ID: EA123456795US Or Green Card ID; 9590940112345671234567'
                        example: 'EA123456795US'
                      RedeliveryEnabled:
                        type: boolean
                        description: 'Field indicating if the item qualifies for redelivery.'
                        example: 'False'
                      RestoreEnabled:
                        type: boolean
                        description: 'Signifies if Restore tracking information service is enabled'
                        example: 'False'
                      ReturnDateNotice:
                        type: string
                        description: 'Field indicating the date the item will be Returned to Sender.'
                        example: 'December 1, 2022'
                      TpodEnabled:
                        type: boolean
                        description: 'Signifies if Tracking Proof of Delivery service is enabled'
                        example: 'False'
                      RRAMenabled:
                        type: boolean
                        description: 'Signifies if RRAM service is enabled'
                        example: 'False'
                      RreEnabled:
                        type: boolean
                        description: 'Signifies if Return Receipt Electronic service is enabled'
                        example: 'False'
                      Service:
                        type: string
                        description: 'Additional services purchased'
                        example: 'PO to Addressee'
                      ServiceTypeCode:
                        type: string
                        description: 'Service Type Code of the mail piece M, AD, VI, 03, 70, 716'
                        example: '701'
                      Status:
                        type: string
                        description: 'Package status'
                        example: 'Delivered'
                      StatusCategory:
                        type: string
                        description: 'Package status category'
                        example: 'In Transit'
                      StatusSummary:
                        type: string
                        description: 'Status summary'
                        example: 'Your item was delivered at 12:55 pm on April 05, 2010 in FALMOUTH, MA 02540'
                      TABLECODE:
                        type: string
                        description: 'Internal description of mail piece as it relates to PTR (live, history, or archived piece) T, H, A (CMC830 V3 – T is the only value defined)'
                        example: 'T'
                      ValueofArticle:
                        type: string 
                        description: 'Value of Article for when the Source ID is PIN'
                      Error:
                        type: object
                        description: 'error object returned by the API'
                        properties:
                          Number:
                            type: string
                            description: 'Assigned number for the type of error message.'
                            example: '-2147219283'
                          Description:
                            type: string
                            description: 'Descriptions of error message. Duplicate or 4 items were also tied to your 3849 ID but exceeded the maximum number of tracking number inquiries supported on this site. This 3849 ID was used on a large volume shipment and cannot be used for tracking on this site.'
                            example: 'A status update is not yet available on your Priority Mail Express<SUP>&reg;</SUP> package. It will be available when the shipper provides an update or the package is delivered to USPS. Check back soon. Sign up for Informed Delivery<SUP>&reg;</SUP> to receive notifications for packages addressed to you'
              example: '<TrackResponse>
                            <TrackInfo ID="XXXXXXXXXXXXXXXXXX"> 
                                <TrackSummary>
                                    <EventTime>10:45 pm</EventTime> 
                                    <EventDate>January 6, 2016</EventDate> 
                                    <Event>Arrived at USPS Facility</Event> 
                                    <EventCity>COLUMBUS</EventCity> 
                                    <EventState>OH</EventState> 
                                    <EventZIPCode>43218</EventZIPCode> 
                                    <EventCountry></EventCountry> 
                                    <FirmName></FirmName> 
                                    <Name></Name> 
                                    <AuthorizedAgent>false</AuthorizedAgent> 
                                </TrackSummary>
                                <TrackDetail>
                                        <EventTime>9:10 am</EventTime>
                                        <EventDate>January 6, 2016</EventDate>
                                        <Event>Acceptance</Event>
                                        <EventCity>LAKE CHARLES</EventCity>
                                        <EventState>IL</EventState>
                                        <EventZIPCode>12345</EventZIPCode>
                                        <EventCountry></EventCountry>
                                        <FirmName></FirmName>
                                        <Name></Name>
                                        <AuthorizedAgent>false</AuthorizedAgent>
                                </TrackDetail>
                            </TrackInfo>
                        </TrackResponse>'
  /ShippingAPI.dllAPI=RateV4:
    get:
      summary: 'Rate Calculator'
      operationId: calculate
      tags:
        - Domestic
      parameters:
        - name: API
          in: query
          description: API type
          required: true
          schema:
            type: string
            default: RateV4
        - name: XML
          in: query
          description: XML payload<br><br><div class="code">&lt;RateV4Request USERID=&quot;XXXXXX&quot;&gt;<br>&nbsp; &nbsp; &lt;Revision&gt;2&lt;/Revision&gt;<br>&nbsp; &nbsp; &lt;Package ID=&quot;0&quot;&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Service&gt; PRIORITY &lt;/Service&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;ZipOrigination&gt;2201&lt;/ZipOrigination&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;ZipDestination&gt;26301&lt;/ZipDestination&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Pounds&gt;8&lt;/Pounds&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Ounces&gt;2&lt;/Ounces&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Container&gt;&lt;/Container&gt;<br>&nbsp; &nbsp; &nbsp; &nbsp; &lt;Machinable&gt;TRUE&lt;/Machinable&gt;<br>&nbsp; &nbsp; &lt;/Package&gt;<br>&lt;/RateV4Request&gt;</div>
          required: true
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/RateV4Request'
                example: '<RateV4Request USERID="{WEB_TOOLS_USER_NAME}">
                            <Revision>2</Revision>
                            <Package ID="0">
                                <Service> PRIORITY </Service>
                                <ZipOrigination>2201</ZipOrigination>
                                <ZipDestination>26301</ZipDestination>
                                <Pounds>8</Pounds>
                                <Ounces>2</Ounces>
                                <Container></Container>
                                <Machinable>TRUE</Machinable>
                            </Package>
                        </RateV4Request>'
      responses:
        '200':
          description: response to Domestic Rate Calculator'
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/RateV4Response'
              example: '<RateV4Response>
                            <Package ID="0">
                                <ZipOrigination>22201</ZipOrigination>
                                <ZipDestination>26301</ZipDestination>
                                <Pounds>8</Pounds>
                                <Ounces>2</Ounces>
                                <Container>VARIABLE</Container>
                                <Zone>3</Zone>
                                <Postage CLASSID="1">
                                    <MailService>Priority Mail 3-Day&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt;</MailService>
                                    <Rate>14.10</Rate>
                                    <SpecialServices>
                                        <SpecialService>
                                            <ServiceID>119</ServiceID>
                                            <ServiceName>Adult Signature Required</ServiceName>
                                            <Available>true</Available>
                                            <Price>8.50</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>120</ServiceID>
                                            <ServiceName>Adult Signature Restricted Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>8.75</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>104</ServiceID>
                                            <ServiceName>Certificate of Mailing (Form 3817)</ServiceName>
                                            <Available>true</Available>
                                            <Price>1.65</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>105</ServiceID>
                                            <ServiceName>Certified Mail&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt;</ServiceName>
                                            <Available>true</Available>
                                            <Price>3.75</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>170</ServiceID>
                                            <ServiceName>Certified Mail&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt; Restricted Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>9.75</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>171</ServiceID>
                                            <ServiceName>Certified Mail&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt; Adult Signature Required</ServiceName>
                                            <Available>true</Available>
                                            <Price>9.75</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>172</ServiceID>
                                            <ServiceName>Certified Mail&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt; Adult Signature Restricted Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>9.75</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>103</ServiceID>
                                            <ServiceName>Collect on Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>8.60</Price>
                                            <DeclaredValueRequired>true</DeclaredValueRequired>
                                            <DueSenderRequired>false</DueSenderRequired>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>175</ServiceID>
                                            <ServiceName>Collect on Delivery Restricted Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>14.45</Price>
                                            <DeclaredValueRequired>true</DeclaredValueRequired>
                                            <DueSenderRequired>false</DueSenderRequired>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>125</ServiceID>
                                            <ServiceName>Insurance</ServiceName>
                                            <Available>true</Available>
                                            <Price>0.00</Price>
                                            <DeclaredValueRequired>true</DeclaredValueRequired>
                                            <DueSenderRequired>false</DueSenderRequired>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>179</ServiceID>
                                            <ServiceName>Insurance Restricted Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>0.00</Price>
                                            <DeclaredValueRequired>true</DeclaredValueRequired>
                                            <DueSenderRequired>false</DueSenderRequired>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>109</ServiceID>
                                            <ServiceName>Registered Mail&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt;</ServiceName>
                                            <Available>true</Available>
                                            <Price>13.75</Price>
                                            <DeclaredValueRequired>true</DeclaredValueRequired>
                                            <DueSenderRequired>false</DueSenderRequired>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>176</ServiceID>
                                            <ServiceName>Registered Mail&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt; Restricted Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>19.60</Price>
                                            <DeclaredValueRequired>true</DeclaredValueRequired>
                                            <DueSenderRequired>false</DueSenderRequired>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>181</ServiceID>
                                            <ServiceName>Scan Retention</ServiceName>
                                            <Available>true</Available>
                                            <Price>0.99</Price>
                                            <DeclaredValueRequired>false</DeclaredValueRequired>
                                            <DueSenderRequired>false</DueSenderRequired>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>108</ServiceID>
                                            <ServiceName>Signature Confirmation&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt;</ServiceName>
                                            <Available>true</Available>
                                            <Price>3.45</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>173</ServiceID>
                                            <ServiceName>Signature Confirmation&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt; Restricted Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>9.30</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>156</ServiceID>
                                            <ServiceName>Signature Confirmation&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt; Electronic</ServiceName>
                                            <Available>true</Available>
                                            <Price>2.90</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>174</ServiceID>
                                            <ServiceName>Signature Confirmation&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt; Electronic Restricted Delivery</ServiceName>
                                            <Available>true</Available>
                                            <Price>8.75</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>190</ServiceID>
                                            <ServiceName>Special Handling - Fragile</ServiceName>
                                            <Available>true</Available>
                                            <Price>12.15</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>106</ServiceID>
                                            <ServiceName>USPS Tracking&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt;</ServiceName>
                                            <Available>true</Available>
                                            <Price>0.00</Price>
                                        </SpecialService>
                                        <SpecialService>
                                            <ServiceID>155</ServiceID>
                                            <ServiceName>USPS Tracking&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt; Electronic</ServiceName>
                                            <Available>true</Available>
                                            <Price>0.00</Price>
                                        </SpecialService>
                                    </SpecialServices>
                                </Postage>
                            </Package>
                        </RateV4Response>'
components:
  schemas:
    AddressValidateRequest:
      type: object
      required:
        - USERID
        - Address
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        Revision:
            type: string
            description: 'Integer value used to return all available response fields. Set this value to 1 to return all currently documented response fields.'
            default: 1
            minLength: 0
            pattern: '\d{1}'
        Address:
            type: object
            required:
                - Address1
                - City
                - State
            properties:
                FirmName: 
                    type: string
                    description: a company name
                    example: XYZ Corp
                Address1:
                    type: string
                    description: 'Delivery Address in the destination address. May contain secondary unit designator, such as APT or SUITE'
                    example: 'Suite 6100'
                Address2:
                    type: string
                    description: 'Delivery Address in the destination address. Required for all mail and packages, however 11-digit Destination Delivery Point ZIP+4 Code can be provided as an alternative in the Detail 1 Record.'
                    example: '185 Berry St'
                City:
                    type: string
                    description: 'City name of the destination address.'
                    maxLength: 15
                    example: 'San Francisco'
                State:
                    type: string
                    description: 'Two-character state code of the destination address.'
                    example: 'CA'
                    maxLength: 2
                Zip5:
                    type: string
                    description: 'Destination 5-digit ZIP Code. Numeric values (0-9) only. If International, all zeroes.'
                    example: '94556'
                Zip4:
                    type: string
                    description: 'Destination ZIP+4 Numeric values (0-9) only. If International, all zeroes. Default to spaces if not available.'
                Urbanization:
                    type: string
                    description: 'For Puerto Rico addresses only.'
                    maxLength: 28
      xml:
        name: 'AddressValidateRequest'
    AddressValidateResponse:
      type: object
      properties:
        Address:
            type: object
            properties:
                FirmName: 
                    type: string
                    description: a company name
                    example: XYZ Corp
                Address1:
                    type: string
                    description: 'Delivery Address in the destination address. May contain secondary unit designator, such as APT or SUITE'
                    example: 'Suite 6100'
                Address2:
                    type: string
                    description: 'Delivery Address in the destination address. Required for all mail and packages, however 11-digit Destination Delivery Point ZIP+4 Code can be provided as an alternative in the Detail 1 Record.'
                    example: '185 Berry St'
                Address2Abbreviation:
                    type: string
                    description: 'Address line 2 abbreviation. To return abbreviations you must set <Revision>=1'  
                City:
                    type: string
                    description: 'City name of the destination address.'
                    maxLength: 15
                    example: 'San Francisco'
                CityAbbreviation:
                    type: string
                    description: 'Abbreviated city name of the destination address. To return abbreviations you must set <Revision>=1'
                State:
                    type: string
                    description: 'Two-character state code of the destination address.'
                    example: 'CA'
                    maxLength: 2
                Zip5:
                    type: string
                    description: 'Destination 5-digit ZIP Code. Numeric values (0-9) only. If International, all zeroes.'
                    example: '94556'
                Zip4:
                    type: string
                    description: 'Destination ZIP+4 Numeric values (0-9) only. If International, all zeroes. Default to spaces if not available.'
                Urbanization:
                    type: string
                    description: 'For Puerto Rico addresses only.'
                    maxLength: 28
                DeliveryPoint:
                    type: string
                CarrierRoute:
                    type: string
                    description: 'Carrier Route code.' 
                Footnotes:
                    type: string
                    enum:
                        - A  #Zip Code Corrected
                        - B  #City / State Spelling Corrected
                        - C  #Invalid City /State / Zip
                        - D  #NO ZIP+4 Assigned
                        - E  #Zip Code Assigned for Multiple Response
                        - F  #Address could not be found in the National Directory File Database
                        - G  #Information in Firm Line used for matching
                        - H  #Missing Secondary Number
                        - I  #Insufficient / Incorrect Address Data
                        - J #Dual Address
                        - K  #Multiple Response due to Cardinal Rule
                        - L  #Address component changed 
                        - LI  #Match has been converted via LACS
                        - M  #Street Name changed
                        - N  #Address Standardized
                        - O  #Lowest +4 Tie-Breaker
                        - P  #Better address exists
                        - Q  #Unique Zip Code match
                        - R  #No match due to EWS
                        - S  #Incorrect Secondary Address
                        - T  #Multiple response due to Magnet Street Syndrome
                        - U  #Unofficial Post Office name
                        - V  #Unverifiable City / State
                        - W  #Invalid Delivery Address
                        - X  #No match due to out of range alias
                        - Y  #Military match USPS Web Tools User Guide
                        - Z  #Match made using the ZIPMOVE product data
                DPVConfirmation:
                    type: string
                    description: 'The DPV Confirmation Indicator is the primary method used by the USPS to determine whether an address was considered deliverable or undeliverable.'
                    enum:
                        - Y  #Address was DPV confirmed for both primary and (if present) secondary numbers.
                        - D  #Address was DPV confirmed for the primary number only, and the secondary number information was missing.
                        - S  #Address was DPV confirmed for the primary number only, and the secondary number information was present by not confirmed.
                        - N  #Both primary and (if present) secondary number information failed to DPV confirm.
                DPVCMRA:
                    type: string
                    description: 'CMRA Indicates a private business that acts as a mailreceiving agent for specific clients. “Y” Address was found in the CMRA table. “N” Address was not found in the CMRA table. Blank Address no'
                    enum:
                        - Y
                        - N
                DPVFootnotes:
                    type: string
                    description: 'DPV® Standardized Footnotes - EZ24x7Plus and Mail*STAR are required to express DPV results using USPS standard two character footnotes.'
                    enum:
                        - AA  #Input address matched to the ZIP+4 file.
                        - A1  #Input address not matched to the ZIP+4 file.
                        - BB  #Matched to DPV (all components).
                        - CC  #Secondary number not matched (present but invalid).
                        - N1  #High-rise address missing secondary number.
                        - M1  #Primary number missing.
                        - M3  #Primary number invalid.
                        - P1  #Input Address RR or HC Box number Missing.
                        - P3  #Input Address PO, RR, or HC Box number Invalid.
                        - F1  #Input Address Matched to a Military Address.
                        - G1  #Input Address Matched to a General Delivery Address
                        - U1  #Input Address Matched to a Unique ZIP Code™.
                Business:
                    type: string
                    description: 'Indicates whether address is a business or not'
                    enum:
                        - Y
                        - N
                CentralDeliveryPoint:
                    type: string
                    description: 'Central Delivery is for all business office buildings, office complexes, and/or industrial/professional parks. This may include call windows, horizontal locked mail receptacles, cluster box units.'
                    enum:
                        - Y
                        - N
                Vacant:
                    type: string
                    description: 'Is the location not occupied.'
                    enum:
                        - Y
                        - N
                ReturnText:
                    type: string
                    description: 'data validation error message'
                Error:
                    type: object
                    required:
                        - code
                        - message
                    properties:
                        number:
                            type: integer
                            format: int32
                            example: '2147219401'
                        source:
                            type: string
                            example: 'clsAMS'
                        description:
                            type: string
                            example: 'Address Not Found.'
                        HelpFile:
                            type: string
                        HelpContext:
                            type: string
                            example: '1000440'
    CityStateLookupRequest:
      type: object
      required:
        - USERID
        - Address
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: ' This attribute specifies your Web Tools ID. See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        Address:
          type: object
          required:
            - Zip5
          properties:
            Zip5:
              type: string
              description: 'Destination 5-digit ZIP Code. Numeric values (0-9) only. If International, all zeroes.'
              example: '94556'
      xml:
        name: 'CityStateLookupRequest'
    CityStateLookupResponse:
      type: object
      properties:
        Address:
          type: object
          properties:
            City:
              type: string
              description: 'City name of the destination address.'
              maxLength: 15
              example: 'San Francisco'
            State:
              type: string
              description: 'Two-character state code of the destination address.'
              example: 'CA'
              maxLength: 2
            Zip5:
              type: string
              description: 'Destination 5-digit ZIP Code. Numeric values (0-9) only. If International, all zeroes.'
              example: '94556'
            ReturnText:
              type: string
              example: 'Default address - The address you entered was found but more information is needed (such as an apartment, suite, or box number) to match to a specific address.'
            Error:
                type: object
                required:
                    - code
                    - message
                properties:
                    number:
                        type: integer
                        format: int32
                        example: '2147219401'
                    source:
                        type: string
                        example: 'clsAMS'
                    description:
                        type: string
                        example: 'Address Not Found.'
                    HelpFile:
                        type: string
                    HelpContext:
                        type: string
                        example: '1000440'
    ZipCodeLookupRequest:
      type: object
      required:
        - USERID
        - Address
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: ' This attribute specifies your Web Tools ID. See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        Address:
            type: object
            required:
                - Address1
                - City
                - State
            properties:
                FirmName: 
                    type: string
                    description: a company name
                    example: XYZ Corp
                Address1:
                    type: string
                    description: 'Delivery Address in the destination address. May contain secondary unit designator, such as APT or SUITE'
                    example: 'Suite 6100'
                Address2:
                    type: string
                    description: 'Delivery Address in the destination address. Required for all mail and packages, however 11-digit Destination Delivery Point ZIP+4 Code can be provided as an alternative in the Detail 1 Record.'
                    example: '185 Berry St'
                City:
                    type: string
                    description: 'City name of the destination address.'
                    maxLength: 15
                    example: 'San Francisco'
                State:
                    type: string
                    description: 'Two-character state code of the destination address.'
                    example: 'CA'
                    maxLength: 2
                Zip5:
                    type: string
                    description: 'Destination 5-digit ZIP Code. Numeric values (0-9) only. If International, all zeroes.'
                    example: '94556'
                Zip4:
                    type: string
                    description: 'Destination ZIP+4 Numeric values (0-9) only. If International, all zeroes. Default to spaces if not available.'
      xml:
        name: 'ZipCodeLookupRequest'
    ZipCodeLookupResponse:
      type: object
      properties:
        Address:
            type: object
            properties:
                FirmName: 
                    type: string
                    description: a company name
                    example: XYZ Corp
                Address1:
                    type: string
                    description: 'Delivery Address in the destination address. Required for all mail and packages, however 11-digit Destination Delivery Point ZIP+4 Code can be provided as an alternative in the Detail 1 Record.'
                    example: '210 King St'
                Address2:
                    type: string
                    description: 'Delivery Address in the destination address. May contain secondary unit designator, such as APT or SUITE'
                    example: 'Suite 100'
                City:
                    type: string
                    description: 'City name of the destination address.'
                    maxLength: 15
                    example: 'San Francisco'
                State:
                    type: string
                    description: 'Two-character state code of the destination address.'
                    example: 'CA'
                    maxLength: 2
                Zip5:
                    type: string
                    description: 'Destination 5-digit ZIP Code. Numeric values (0-9) only. If International, all zeroes.'
                    example: '94556'
                Zip4:
                    type: string
                    description: 'Destination ZIP+4 Numeric values (0-9) only. If International, all zeroes. Default to spaces if not available.'
                Urbanization:
                    type: string
                    description: 'For Puerto Rico addresses only.'
                    maxLength: 28
                ReturnText:
                    type: string
                    example: 'Default address - The address you entered was found but more information is needed (such as an apartment, suite, or box number) to match to a specific address.'
                Error:
                    type: object
                    required:
                        - code
                        - message
                    properties:
                        number:
                            type: integer
                            format: int32
                            example: '2147219401'
                        source:
                            type: string
                            example: 'clsAMS'
                        description:
                            type: string
                            example: 'Address Not Found.'
                        HelpFile:
                            type: string
                        HelpContext:
                            type: string
    PriorityMailRequest:
      type: object
      required:
        - USERID
        - OriginZip
        - DestinationZip
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: 'This attribute specifies your Web Tools ID. See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        OriginZip: 
            type: string
            description: 'Origination and destination Zip Codes must be valid. Either the first 3 digits or first 5 digits of the Zip Code are entered between the open tag and close tag.'
            example: '90210'
        DestinationZip:
            type: string
            description: 'Origination and destination Zip Codes must be valid and must be 5 digits.'
            example: '20770'
        DestinationType:
            type: string
            description: 'Destination Type for package.'
            enum:
                - 1  #PO-Addressee – Street (Default Value)
                - 2  #PO-Addressee – PO Box
                - 3  #Hold For Pick-up
            example: '1'
        PMGuarantee:
            type: boolean
            description: 'PriorityMail Guarantee'
            default: 'N'
            example: 'Y'
      xml:
        name: 'PriorityMailRequest'
    PriorityMailResponse:
      type: object
      required:
        - OriginZip
        - DestinationZip
      properties:
        OriginZip: 
            type: string
            description: 'Origination and destination Zip Codes must be valid. Either the first 3 digits or first 5 digits of the Zip Code are entered between the open tag and close tag.'
            example: '90210'
        DestinationZip:
            type: string
            description: 'Origination and destination Zip Codes must be valid and must be 5 digits.'
            example: '20770'
        Days:
            type: string
            description: 'Numbers of days expected to deliver.'
            example: '3'
        IsGuaranteed:
            type: string
            description: 'Is the delivery guaranteed.'
            example: 'Y'
        Msg:
            type: string
            description: 'Service Standards Messaging. Appears when applicable.'
            example: 'Your shipment may be delayed due to transportation issues'
        EffectiveAcceptanceDate:
            type: string
            description: 'Effective Acceptance Date is returned when <DestinationType> is specified in the request.'
            example: '2022-02-23'
        ScheduledDeliveryDate:
            type: string
            description: 'Scheduled Delivery Date is returned when <DestinationType> is specified in the request.'
            example: '2022-02-26'
      xml:
        name: 'PriorityMailResponse'
    StandardBRequest:
      type: object
      required:
        - USERID
        - OriginZip
        - DestinationZip
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: 'This attribute specifies your Web Tools ID. See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        OriginZip: 
            type: string
            description: 'Origination and destination Zip Codes must be valid. Either the first 3 digits or first 5 digits of the Zip Code are entered between the open tag and close tag.'
            example: '90210'
        DestinationZip:
            type: string
            description: 'Origination and destination Zip Codes must be valid and must be 5 digits.'
            example: '20770'
        DestinationType:
            type: string
            description: 'Destination Type for package.'
            enum:
                - 1  #PO-Addressee – Street (Default Value)
                - 2  #PO-Addressee – PO Box
                - 3  #Hold For Pick-up
            example: '1'
        PMGuarantee:
            type: boolean
            description: 'PriorityMail Guarantee'
            default: 'N'
            example: 'Y'
      xml:
        name: 'StandardBRequest'
    StandardBResponse:
      type: object
      required:
        - OriginZip
        - DestinationZip
      properties:
        OriginZip: 
            type: string
            description: 'Origination and destination Zip Codes must be valid. Either the first 3 digits or first 5 digits of the Zip Code are entered between the open tag and close tag.'
            example: '90210'
        DestinationZip:
            type: string
            description: 'Origination and destination Zip Codes must be valid and must be 5 digits.'
            example: '20770'
        Days:
            type: string
            description: 'Numbers of days expected to deliver.'
            example: '3'
        Msg:
            type: string
            description: 'Service Standards Messaging. Appears when applicable.'
            example: 'Your shipment may be delayed due to transportation issues'
        EffectiveAcceptanceDate:
            type: string
            description: 'Effective Acceptance Date is returned when <DestinationType> is specified in the request.'
            example: '2022-02-23'
        ScheduledDeliveryDate:
            type: string
            description: 'Scheduled Delivery Date is returned when <DestinationType> is specified in the request.'
            example: '2022-02-26'
      xml:
        name: 'StandardBResponse'
    FirstClassMailRequest:
      type: object
      required:
        - USERID
        - OriginZip
        - DestinationZip
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: 'This attribute specifies your Web Tools ID. See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        OriginZip: 
            type: string
            description: 'Origination and destination Zip Codes must be valid. Either the first 3 digits or first 5 digits of the Zip Code are entered between the open tag and close tag.'
            example: '90210'
        DestinationZip:
            type: string
            description: 'Origination and destination Zip Codes must be valid and must be 5 digits.'
            example: '20770'
        DestinationType:
            type: string
            description: 'Destination Type for package.'
            enum:
                - 1  #PO-Addressee – Street (Default Value)
                - 2  #PO-Addressee – PO Box
                - 3  #Hold For Pick-up
            example: '1'
      xml:
        name: 'FirstClassMailRequest'
    FirstClassMailResponse:
      type: object
      required:
        - OriginZip
        - DestinationZip
      properties:
        OriginZip: 
            type: string
            description: 'Origination and destination Zip Codes must be valid. Either the first 3 digits or first 5 digits of the Zip Code are entered between the open tag and close tag.'
            example: '90210'
        DestinationZip:
            type: string
            description: 'Origination and destination Zip Codes must be valid and must be 5 digits.'
            example: '20770'
        Days:
            type: string
            description: 'Numbers of days expected to deliver.'
            example: '3'
        Msg:
            type: string
            description: 'Service Standards Messaging. Appears when applicable.'
            example: 'Your shipment may be delayed due to transportation issues'
        EffectiveAcceptanceDate:
            type: string
            description: 'Effective Acceptance Date is returned when <DestinationType> is specified in the request.'
            example: '2022-02-23'
        ScheduledDeliveryDate:
            type: string
            description: 'Scheduled Delivery Date is returned when <DestinationType> is specified in the request.'
            example: '2022-02-26'
      xml:
        name: 'FirstClassMailResponse'
    ExpressMailCommitmentRequest:
      type: object
      required:
        - USERID
        - OriginZip
        - DestinationZip
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: 'This attribute specifies your Web Tools ID. See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        OriginZip: 
            type: string
            description: 'Origination and destination Zip Codes must be valid. Either the first 3 digits or first 5 digits of the Zip Code are entered between the open tag and close tag.'
            example: '90210'
        DestinationZip:
            type: string
            description: 'Origination and destination Zip Codes must be valid and must be 5 digits.'
            example: '20770'
        Date:
            type: string
            format: date
            description: 'Date package is shipped. Can be left blank. Can use formats MM/DD/YYYY or DD-MMM-YYYY.'
            example: '05-May-2014'
        DropOffTime:
            type: string
            description: 'Time package is shipped. This tag can be omitted or left blank. Use format HH:MM such as 13:30.'
            example: '15:00'
        ReturnDates:
            type: boolean
            description: 'Indicates if Scheduled Delivery and Effective Acceptance dates should be returned. Specify ‘true’ or ‘false’.'
            example: 'false'
        PMGuarantee:
            type: boolean
            description: 'PriorityMail Guarantee'
            default: 'N'
            example: 'Y'
      xml:
        name: 'ExpressMailCommitmentRequest'
    ExpressMailCommitmentResponse:
      type: object
      required:
        - OriginZip
        - OriginCity
        - OriginState
        - DestinationZip
        - DestinationCity
        - DestinationState
        - Date
        - Time
      properties:
        OriginZip: 
            type: string
            description: 'Origination and destination Zip Codes must be valid. Either the first 3 digits or first 5 digits of the Zip Code are entered between the open tag and close tag.'
            example: '90210'
        OriginCity: 
            type: string
            description: 'Originating City'
            example: 'San Francisco'
        OriginState: 
            type: string
            description: 'Originating State'
            example: 'CA'
        DestinationCity: 
            type: string
            description: 'Destination city of the mail'
            example: 'San Diego'
        DestinationState: 
            type: string
            description: 'Destination state of the mail'
            example: 'CA'
        DestinationZip:
            type: string
            description: 'Origination and destination Zip Codes must be valid and must be 5 digits.'
            example: '92025'
        Date:
            type: string
            format: date
            description: 'Date package is shipped. Can be left blank. Can use formats MM/DD/YYYY or DD-MMM-YYYY.'
            example: '05-May-2021'
        Time:
            type: string
            description: 'Date package is shipped. Can be left blank. Can use formats MM/DD/YYYY or DD-MMM-YYYY.'
            example: '13:00'
        ExpeditedTransMessage:
            type: string
            description: 'Expedited Transportation Message. Returned when applicable and the request has the ReturnDates set to true.'
            example: '3'
        MsgCode:
            type: string
            enum:
              - TM103
            description: 'Message Code. Returned when applicable and the request has the ReturnDates set to true.'
            example: 'TM103'
        Msg:
            type: string
            description: 'Message Text. Returned when applicable and the request has the ReturnDates set to true.'
            example: 'Your shipment may be delayed due to transportation issues'
        EffectiveAcceptanceDate:
            type: string
            description: 'Effective Acceptance Date is returned when <DestinationType> is specified in the request.'
            example: '2022-02-23'
        Commitment:
          minItems: 0
          maxItems: 5
          type: array
          items:
            type: object
            properties:
                CommitmentName:
                    type: string
                    description: 'Commitment Name'
                    enum:
                      - 1-Day
                      - 2-Day
                      - 3-Day
                      - DPO
                      - Military
                    example: '2-Day'
                CommitmentTime:
                    type: string
                    description: 'Commitment Time. (eg: 6:00 PM)'
                    example: '6:00 PM'
                CommitmentSequence:
                    type: string
                    description: 'Seq # equates to a specific Service Standard. A0118 = 1-Day at 6:00 PM,  B0118 = 1-Day at 6:00 PM, A0218 = 2-Day at 6:00 PM, B0218=2-Day at 6:00 PM'
                    enum:
                      - A0118  # 1-Day at 6:00 PM
                      - B0118  # 1-Day at 6:00 PM
                      - A0218  # 2-Day at 6:00 PM
                      - B0218  # 2-Day at 6:00 PM
                    example: 'A0218'
                Location:
                    type: object
                    description: 'Groups drop off location information.'
                    properties:
                        ScheduledDeliveryDate:
                            type: string
                            description: 'Scheduled Delivery Date. Returned when the request has the ReturnDates set to true.'
                            example: '2021-05-28'
                        CutOff:
                            type: string
                            description: 'Cut-Off Time'
                            example: '6:00 PM'
                        Facility:
                            type: string
                            enum:
                              - POST OFFICE
                              - PRIORITY MAIL EXPRESS COLLECTION BOX
                              - AIR MAIL FACILITY
                            description: 'Facility Type'
                            example: 'POST OFFICE'
                        Street:
                            type: string
                            description: 'Facility Street'
                            example: '55 GRASSO PLZ'
                        City:
                            type: string
                            description: 'Facility City'
                            example: 'SAINT LOUIS'
                        State:
                            type: string
                            description: 'Facility State'
                            example: 'MO'
                        Zip:
                            type: string
                            description: 'Facility Zip Code'
                            example: '63123'
                        IsGuaranteed:
                            type: string
                            enum:
                              - 1  # Guaranteed
                              - 2  # No Guarantee
                              - 3  # Temporary No Guarantee
                            description: 'Indicates if Guaranee is offered. Will only be returned if the PMGuarantee in the request is set to Y.  1 = Guaranteed, 2 = No Guarantee, 3 = Temporary No Guarantee'
                            example: 'Y'
                        Msg:
                            type: string
                            description: 'Service Standards Messaging. Appears when applicable.'
                            example: 'Your shipment may be delayed due to transportation issues'
      xml:
        name: 'ExpressMailCommitmentResponse'
    PTSTPodRequest:
      type: object
      xml:
        name: 'PTSRreRequest'
      required:
        - USERID
        - TrackID
        - MpSuffix
        - MpDate
        - RequestType
        - FirstName
        - LastName
        - CustRegID
        - TableCode
      properties:
        USERID:
          type: string
          example: '826ADISY3274'
          description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        TrackID:
          type: string
          description: 'Must be alphanumeric characters..'
          example: 'EJ123456780US'
        MpSuffix: 
          type: string
          description: 'MPSUFFIX value located in Track/Confirm Fields API response data. Unique to each TrackID'
          example: '9402'
        MpDate:
          type: string
          description: 'MPDATE value located in Track/Confirm Fields API response data. Unique to each TrackId.'
          example: '2021-07-02 00:42:23.35744'
        RequestType:
          type: string 
          description: 'Enter a notification request type from the choices available.'
          example: 'Email'
        FirstName:
          type: string
          description: 'Recipient First Name'
          example: 'John'
        LastName:
          type: string
          description: 'Recipient Last Name'
          example: 'Doe'
        Email1:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'cpapple@email.com'
        Email2:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'acme@email.com'
        Email3:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'cpapple@email.com'
        TableCode:
          type: string
          description: 'TableCode value located in Track/Confirm Fields API response data. Unique to each TrackID.'
          example: 'T'
        CustRegID:
          type: string
          description: "Unique 10-byte numeric value that's associated to each user."
          example: '1234567890'
        ClientIp:
          type: string
          description: 'User IP address'
          example: '127.0.0.0'
        SourceId:
          type: string
          description: 'Internal User Identification.'
          example: 'XYZ Corp'
    PTSTPodResult:
      type: object
      xml:
        name: 'PTSTPodResult'
      properties:
        ResultText:
          type: string
          description: 'Status message'
          example: 'Your request for all activity to-date will be processed within four hours. Any future activity will be processed whenever there is new delivery related event activity.'
        ReturnCode:
          type: string
          description: 'Return code'
          example: '0'
    PTSRreRequest:
      type: object
      xml:
        name: 'PTSRreRequest'
      required:
        - USERID
        - TrackID
        - MpSuffix
        - MpDate
        - FirstName
        - LastName
        - Email1
      properties:
        USERID:
          type: string
          example: '826ADISY3274'
          description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        TrackID:
          type: string
          description: 'Must be alphanumeric characters..'
          example: 'EJ123456780US'
        ClientIp:
          type: string
          description: 'User IP address'
          example: '127.0.0.0'
        SourceId:
          type: string
          description: 'Internal User Identification.'
          example: 'XYZ Corp'
        MpSuffix: 
          type: string
          description: 'MPSUFFIX value located in Track/Confirm Fields API response data. Unique to each TrackID'
          example: '9402'
        MpDate:
          type: string
          description: 'MPDATE value located in Track/Confirm Fields API response data. Unique to each TrackId.'
          example: '2021-07-02 00:42:23.35744'
        FirstName:
          type: string
          description: 'Recipient First Name'
          example: 'John'
        LastName:
          type: string
          description: 'Recipient Last Name'
          example: 'Doe'
        Email1:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'cpapple@email.com'
        Email2:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'acme@email.com'
        Email3:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'cpapple@email.com'
        TableCode:
          type: string
          description: 'TableCode value located in Track/Confirm Fields API response data. Unique to each TrackID.'
          example: 'T'
        CustRegID:
          type: string
          description: "Unique 10-byte numeric value that's associated to each user."
          example: '1234567890'
    PTSRreResult:
      type: object
      xml:
        name: 'PTSRreResult'
      properties:
        ResultText:
          type: string
          description: 'Status message'
          example: 'Your request for all activity to-date will be processed within four hours. Any future activity will be processed whenever there is new delivery related event activity.'
        ReturnCode:
          type: string
          description: 'Return code'
          example: '0'
    PTSPodRequest:
      type: object
      required:
        - USERID
        - TrackID
        - RequestType
        - MpSuffix
        - MpDate
        - FirstName
        - LastName
        - TableCode
      properties:
        USERID:
          type: string
          example: '826ADISY3274'
          description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        TrackID:
          type: string
          description: 'Must be alphanumeric characters.'
          example: 'EJ123456780US'
        ClientIp:
          type: string
          description: 'User IP address'
          example: '127.0.0.0'
        SourceId:
          type: string
          description: 'Internal User Identification.'
          example: 'XYZ Corp'
        MpSuffix: 
          type: string
          description: 'MPSUFFIX value located in Track/Confirm Fields API response data. Unique to each TrackID'
          example: '9402'
        MpDate:
          type: string
          description: 'MPDATE value located in Track/Confirm Fields API response data. Unique to each TrackId.'
          example: '2021-07-02 00:42:23.35744'
        RequestType:
          type: string
          description: 'Enter a notification request type from the choices available.'
          example: 'Email'
        FirstName:
          type: string
          description: 'Recipient First Name'
          example: 'John'
        LastName:
          type: string
          description: 'Recipient Last Name'
          example: 'Doe'
        Email1:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'cpapple@email.com'
        Email2:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'acme@email.com'
        Email3:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'cpapple@email.com'
        FaxNumber:
          type: string
          description: 'Fax Number'
          example: '415-555-1212'
        AddressLine1:
          type: string
          description: 'Address Line 1'
          example: '185 BERRY STREET'
        AddressLine2:
          type: string
          description: 'Address Line 2'
          example: 'SUITE 6100'
        City:
          type: string
          description: 'City'
          example: 'SAN FRANCISCO'
        State:
          type: string
          description: 'State'
          example: 'CA'
        Zip:
          type: string
          description: 'ZIP Code'
          example: '94101'
        VerifyAddress:
          type: boolean
          description: 'Indicates whether or not address should be validated.'
          example: 'True'
        TableCode:
          type: string
          description: 'TableCode value located in Track/Confirm Fields API response data. Unique to each TrackID.'
          example: 'T'
        CustRegID:
          type: string
          description: "Unique 10-byte numeric value that's associated to each user."
          example: '1234567890'
    PTSPodResponse:
      type: object
      properties:
        ResultText:
          type: string
          description: 'Status message'
          example: 'Your request for all activity to-date will be processed within four hours. Any future activity will be processed whenever there is new delivery related event activity.'
        ReturnCode:
          type: string
          description: 'Return code'
          example: '0'
    PTSEmailRequest:
      type: object
      required:
        - USERID
        - TrackID
        - RequestType
        - MpSuffix
        - MpDate
        - Email1
      properties:
        USERID:
          type: string
          example: '826ADISY3274'
          description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        TrackID:
          type: string
          description: 'Must be alphanumeric characters.'
          example: 'EJ123456780US'
        ClientIp:
          type: string
          description: 'User IP address'
          example: '127.0.0.0'
        SourceId:
          type: string
          description: 'Internal User Identification.'
          example: 'XYZ Corp'
        MpSuffix: 
          type: string
          description: 'MPSUFFIX value located in Track/Confirm Fields API response data. Unique to each TrackID'
          example: '9402'
        MpDate:
          type: string
          description: 'MPDATE value located in Track/Confirm Fields API response data. Unique to each TrackId.'
          example: '2021-07-02 00:42:23.35744'
        RequestType:
          type: string
          enum:
            - AL   # E-Mail Alert “FD” E-Mail Future Delivery 
            - ED   # E-Mail Delivery/Non Delivery activity 
            - TD   # E-Mail Today Delivery
            - UP   # E-Mail Available for Pickup 
            - FS   # Package addressed to me/myusps only 
            - OA   # Other Activity
          description: 'Enter a notification request type from the choices available.'
          example: 'ED'
        FirstName:
          type: string
          description: 'Recipient First Name'
          example: 'John'
        LastName:
          type: string
          description: 'Recipient Last Name'
          example: 'Doe'
        Email1:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'cpapple@email.com'
        Email2:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'acme@email.com'
        Email3:
          type: string
          description: 'Complete valid e-mail address is Required if tag is used'
          example: 'cpapple@email.com'
    PTSEmailResponse:
      type: object
      properties:
        ResultText:
          type: string
          description: 'Status message'
          example: 'Your request for all activity to-date will be processed within four hours. Any future activity will be processed whenever there is new delivery related event activity.'
        ReturnCode:
          type: string
          description: 'Return code'
          example: '0'
    TrackRequest:
      type: object
      required:
        - USERID
        - TrackID
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        TrackID:
            type: object
            description: 'Integer value used to return of all available response fields. Set this value to 1 to return all currently documented response fields.'
            properties:
                ID:
                    type: string
                    default: EJ123456780US
                    description: 'Package Tracking ID. Must be alphanumeric characters.'
                    xml:
                        attribute: true
            xml:
                name: 'TrackID'
      xml:
        name: 'TrackRequest'
    TrackResponse:
      type: object
      xml:
        name: 'TrackResponse'
      properties:
        TrackID:
            type: object
            xml:
              name: 'TrackID'
            description: 'Integer value used to return of all available response fields. Set this value to 1 to return all currently documented response fields.'
            properties:
                ID:
                    type: string
                    default: 826ADISY3274
                    description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
                    xml:
                        attribute: true
                TrackSummary:
                  type: string
                  description: ''
                  example: 'Your item was delivered at 6:50am on February 6 in BARTOW FL 33830.'
                TrackDetail:
                  type: string
                  description: ''
                  example: 'February 6 6:49 am NOTICE LEFT BARTOW FL 33830'
    TrackFieldRequest:
      type: object
      required:
        - USERID
        - Revision
        - SourceId
        - TrackID
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: ' This attribute specifies your Web Tools ID. (aka your API KEY) See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        TrackID:
            type: object
            description: 'Integer value used to return of all available response fields. Set this value to 1 to return all currently documented response fields.'
            properties:
                ID:
                    type: string
                    default: EJ123456780US
                    description: 'Package Tracking ID. Must be alphanumeric characters.'
                    xml:
                        attribute: true
                DestinationZipCode:
                    type: string
                    description: '5 digit destination zip code.'
                    example: '12345'
                MailingDate:
                    type: string
                    description: 'Mailing date of package. Format YYYY- MM-DD'
                    example: '2010-01- 01'
            xml:
                name: 'TrackID'
        Revision:
            type: number
            format: integer
            description: "This is for versioning of the API's and for triggering response tags for future versions. In this API use a value of 1 to return all available response tags and trigger new functionality."
            example: '1'
        ClientIp:
            type: string
            description: 'User IP address'
            example: '137.0.0.1'
        SourceId:
            type: string
            description: 'External integrators should pass company name'
            example: 'XYZ Corp'
            pattern: '^[0-9]{5}'
      xml:
        name: 'TrackFieldRequest'
    RateV4Request:
      type: object
      required:
        - USERID
        - Package
      xml:
        name: 'RateV4Request'
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: ' This attribute specifies your Web Tools ID. See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        Revision:
          type: string
          example: 2
          description: 'Set this value to “2” to return all currently documented response fields'
        Package:
          type: array
          items:  
            type: object
            required:
              - Service
              - ZipOrigination
              - ZipDestination
              - Pounds
              - Ounces
              - Container
            properties:
              Service: 
                  type: string
                  description: 'Web Tools validates the entry to one of the service types. For example: <Service>PRIORITY MAIL EXPRESS</Service> Note: Mailable matter not required to be mailed as First-Class Mail is permitted with Retail Ground to Zones 5-9. Zones 1-4 items are limited to mailable hazardous materials, live animals, and other “surface-only” items. Retail Ground can only be used for Zones 5-9 unless the shipment is oversized or contains classes of materials. (e.g. certain HAZMAT) For [more details](http://pe.usps.com/businessmail101/classes/packageServices.htm). Note: The use of <Service> = “BPM” is restricted. If access to this service is needed, please reach out to the following email address: webtools@usps.gov.Note: For users that want to return all eligible products in a single RateV4 API call, please see details below regarding “All” calls:'
                  example: 'Priority Mail Express'
                  enum:
                    - First Class Commercial
                    - First Class
                    - First Class HFP Commercial
                    - First Class Returns
                    - Parcel Select Ground
                    - Parcel Select DE
                    - Parcel Select LW
                    - Priority
                    - Priority Commercial
                    - Priority CPP
                    - Priority HFP Commercial
                    - Priority HFP CPP
                    - Priority Mail Express
                    - Priority Mail Express Commercial
                    - Priority Mail Express CPP
                    - Priority Mail Express Sh
                    - Priority Mail Express Sh Commercial
                    - Priority Mail Express HFP
                    - Priority Mail Express HFP Commercial
                    - Priority Mail Express HFP CPP
                    - Priority Mail Cubic
                    - Priority Mail Cubic Returns
                    - Priority Mail Returns
                    - Retail Ground
                    - Ground Returns
                    - Media
                    - Library
                    - All
                    - Online
                    - Plus
                    - BPM
              FirstClassMailType:
                type: string
                description: 'Required when Service property is FIRST CLASS or FIRST CLASS COMMERCIAL or FIRST CLASS HFP COMMERCIAL. Note: The <FirstClassMailType> tag is returned only if the <ServiceType> submitted is “First Class”. If any other <ServiceType> is returned (Including “First Class Commercial”) the <Container> tag is used. Note: Flats are also known as Large Envelopes'
                example: 'LETTER'
                enum:
                  - LETTER 
                  - FLAT
              ZipOrigination:
                type: string
                description: 'ZIP code must be valid. '
                example: '10101'
              ZipDestination:
                type: string
                description: 'ZIP code must be valid.'
                example: '54324'
              Pounds:
                type: integer
                minimum: 0
                maximum: 70
                description: 'Value must be numeric. Package weight cannot exceed 70 pounds.'
                example: '10'
              Ounces:
                type: number
                format: double
                minimum: 1
                maximum: 1120.32
                description: 'Value must be numeric. Package weight cannot exceed 70 pounds (1120 ounces). '
                example: '8'
              Container:
                type: string
                description: 'Use to specify container attributes that may affect postage; otherwise, leave blank. Note: The <FirstClassMailType> tag is used instead of the <Container> tag only if the <ServiceType> submitted is “First Class”. Note: “Cubic Soft Pack” and “Cubic Parcels” are only valid containers for service “Priority Mail Cubic”. Dimensions Length and Height are required when requesting Cubic Soft Pack. Dimensions Length, Height, and Width are required when requesting Cubic Parcels. Note: “VARIABLE” is used to denote that a customer is using packaging other than a USPS produced Flat Rate Box/Envelope or RegionalRate Box”.'
                example: 'FLAT RATE ENVELOPE'
                enum:
                  - VARIABLE
                  - FLAT RATE ENVELOPE
                  - PADDED FLAT RATE ENVELOPE
                  - LEGAL FLAT RATE ENVELOPE
                  - SM FLAT RATE ENVELOPE
                  - WINDOW FLAT RATE ENVELOPE
                  - GIFT CARD FLAT RATE ENVELOPE
                  - SM FLAT RATE BOX
                  - MD FLAT RATE BOX
                  - LG FLAT RATE BOX
                  - REGIONALRATEBOXA
                  - REGIONALRATEBOXB
                  - CUBIC PARCELS
                  - CUBIC SOFT PACK
              Size:
                type: string
                description: 'Note: This tag has been deprecated. <Size> tag and any values within the <Size> tag will not result in an error response and will not impact rates that are returned.'
              Width:
                type: string
                description: 'Value must be numeric. Units are inches. If partial dimensions are provided, an error response will return. Length, Width, Height are required for accurate pricing of a rectangular package when any dimension of the item exceeds 12 inches. In addition, Girth is required only for a nonrectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for nonrectangular packages. For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm'
              Length:
                type: string
                description: 'Value must be numeric. Units are inches. If partial dimensions are provided, an error response will return. Length, Width, Height are required for accurate pricing of a rectangular package when any dimension of the item exceeds 12 inches. In addition, Girth is required only for a nonrectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for nonrectangular packages. For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm'
              Height:
                type: number
                format: double
                maxLength: 10
                description: 'Units are inches. Setting the height requires Length and Width as be set for accurate pricing of a rectangular package when any dimension of the item exceeds 12 inches. For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm'
              Girth:
                type: number
                format: double
                maxLength: 10
                description: 'Units are inches. Girth is only required for a non rectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for nonrectangular packages. For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm'
              Value:
                type: number
                format: double
                description: 'Package value. Used to determine availability and cost of extra services. Available when Revision="2" is included in the XML request'
                example: "150.00"
              AmountToCollect:
                type: number
                format: double
                maxLength: 10
                description: 'Collect on delivery amount. Used to determine availability and cost of extra services. Available when Revision="2" is included in the XML request'
              SpecialServices:
                $ref: '#/components/schemas/SpecialServices'
              Content:
                type: object
                description: 'Groups the ContentType and ContentDescription elements. Available when Revision="2" is included in the XML request'
                properties:
                  ContentType: 
                    type: string
                    description: 'Defines the type of content of the package'
                    example: 'LIVES'
                    enum:
                      - HAZMAT
                      - CREMATEDREMAINS
                      - FRAGILE
                      - PERISHABLE
                      - PHARMACEUTICALS
                      - MEDICAL SUPPLIES
                      - LIVES
                  ContentDescription:
                    type: string
                    description: 'Describes the content of the package. Optional but required for ContentType LIVES'
                    example: 'BEES'
                    enum:
                      - BEES
                      - DAYOLDPOULTRY
                      - ADULTBIRDS
                      - OTHER
              GroundOnly:
                type: boolean
                description: 'Use “true” when shipment contains mailable hazardous materials, live animals and other "surface-only" items. Available when Revision="2" is included in the XML request and Service array includes Retail Ground'
                example: 'true'
              SortBy:
                type: string
                description: 'Returns all mailing services available based on item shape. When specified, value in <Container> is ignored. Available when Revision="2" and Sevices includes ALL and ONLINE is included in the XML request'
                example: 'LETTER'
                enum:
                  - LETTER
                  - LARGEENVELOPE
                  - PACKAGE
                  - FLATRATE
              Machinable:
                type: boolean
                description: 'Machinable is required when: Service is FIRST CLASS and FirstClassMailType is LETTER OR FirstClassMailType is FLAT and Service is Retail Ground and ALL and ONLINE'
                example: 'true'
              ReturnLocations:
                type: boolean
                description: 'Include Dropoff Locations in Response if available. Requires "ShipDate" tag.'
                example: 'true'
              ReturnServiceInfo:
                type: boolean
                description: 'If a value of “True” is indicated in the request then the response will include the <ServiceInformation> tag containing mail service specific information '
                example: 'false'
              DropOffTime:
                type: string
                description: 'Time Package Will Be Mailed. Enter drop off time in format: HH:mm, such as 13:45. Inclusion of Drop Off Time will result increased accuracy of <CommitmentName> and <CommitmentDate> in the response for Priority Mail and Priority Mail Express variants.'
                example: '13:45'
              ShipDate:
                type: object
                xml:
                  name: 'ShipDate'
                description: 'Date Package Will Be Mailed. Ship date may be today plus 0 to 3 days in advance. Enter the date in format: yyyy-mm-dd, such as 2013-07-28. Inclusion of Ship Date will result in <CommitmentName> and <CommitmentDate> in the response for Priority Mail and Priority Mail Express variants. For example: <ShipDate Option="HFP">2013-07-28</ShipDate>'
                example: '2020-07-28'
                properties:
                  Option:
                    type: "string"
                    example: "HFP"
                    xml:
                      attribute: true
              ReturnDimensionalWeight:
                type: boolean
                description: 'This tag must be explicitly set to “true” for dimensional weight to be returned in the xml response.'
                example: 'true'
              TrackingRetentionPeriod:
                type: string
                description: 'Used to determine period of Retention for tracking data'
    SpecialServices:
        type: array
        xml:
          wrapped : true
          name: SpecialServices
        description: 'Defines extra services in order to determine price and availability of additional services. An initial call without the SpecialService tag specified is recommended to determine base availability of special services for each mail class. Available when Revision="2" is included in the XML request'
        maxItems: 10        
        items:
          type: object
          xml:
            name: 'SpecialService'
          properties:
            SpecialService:
                type: integer
                description: 'Defines individual services.'
                enum:
                    - 100  # Insurance
                    - 101  # Insurance – Priority Mail Express
                    - 102  # Return Receipt
                    - 103  # Collect on Delivery
                    - 104  # Certificate of Mailing (Form 3665)
                    - 105  # Certified Mail
                    - 106  # USPS Tracking
                    - 108  # Signature Confirmation
                    - 109  # Registered Mail
                    - 110  # Return Receipt Electronic
                    - 112  # Registered mail COD collection Charge
                    - 118  # Return Receipt – Priority Mail Express
                    - 119  # Adult Signature Required
                    - 120  # Adult Signature Restricted Delivery
                    - 125  # Insurance – Priority Mail
                    - 155  # USPS Tracking Electronic
                    - 156  # Signature Confirmation Electronic
                    - 160  # Certificate of Mailing (Form 3817)
                    - 170  # Certified Mail Restricted Delivery
                    - 171  # Certified Mail Adult Signature Required
                    - 172  # Certified Mail Adult Signature Restricted Delivery
                    - 173  # Signature Confirm. Restrict. Delivery
                    - 174  # Signature Confirmation Electronic Restricted Delivery
                    - 175  # Collect on Delivery Restricted Delivery
                    - 176  # Registered Mail Restricted Delivery
                    - 177  # Insurance Restricted Delivery
                    - 178  # Insurance Restrict. Delivery – Priority Mail Express
                    - 179  # Insurance Restrict. Delivery – Priority Mail
                    - 180  # Insurance Restrict. Delivery (Bulk Only)
                    - 181  # Scan Retention
                    - 182  # Scan + Signature Retention
                    - 190  # Special Handling - Fragile
    RateV4Response:
      type: object
      xml:
        name: 'RateV4Response'
      required:
        - USERID
        - Package
      properties:
        USERID:
          type: string
          default: 826ADISY3274
          description: ' This attribute specifies your Web Tools ID. See the [Developers Guide]("https://www.usps.com/business/web-tools-apis/documentation-updates.htm") for information on obtaining your USERID.'
          xml:
            attribute: true
        Revision: 
          type: string
          description: 'Set this value to “2” to return all currently documented response fields.'
          example: '2' 
        Package:
          type: array
          items:  
            type: object
            required:
              - Postage
              - ZipOrigination
              - ZipDestination
              - Pounds
              - Ounces
            properties:
                ZipOrigination:
                  type: string
                  description: 'ZIP code must be valid. '
                  example: '10101'
                ZipDestination:
                  type: string
                  description: 'ZIP code must be valid.'
                  example: '54324'
                Pounds:
                  type: integer
                  minimum: 0
                  maximum: 70
                  description: 'Value must be numeric. Package weight cannot exceed 70 pounds.'
                  example: '10'
                Ounces:
                  type: number
                  format: double
                  minimum: 1
                  maximum: 1120
                  description: 'Value must be numeric. Package weight cannot exceed 70 pounds (1120 ounces). '
                  example: '8'
                FirstClassMailType:
                  type: string
                  description: 'Required when Service property is FIRST CLASS or FIRST CLASS COMMERCIAL or FIRST CLASS HFP COMMERCIAL. Note: The <FirstClassMailType> tag is returned only if the <ServiceType> submitted is “First Class”. If any other <ServiceType> is returned (Including “First Class Commercial”) the <Container> tag is used. Note: Flats are also known as Large Envelopes'
                  example: 'LETTER'
                  enum:
                    - LETTER 
                    - FLAT
                Container:
                  type: string
                  description: 'Shipping Container (appears where applicable: Service=ALL or Service=PRIORITY EXPRESS or Service=PRIORITY'
                  example: 'VARIABLE'
                  enum:
                  - VARIABLE
                  - FLAT RATE ENVELOPE
                  - PADDED FLAT RATE ENVELOPE
                  - LEGAL FLAT RATE ENVELOPE
                  - SM FLAT RATE ENVELOPE
                  - WINDOW FLAT RATE ENVELOPE
                  - GIFT CARD FLAT RATE ENVELOPE
                  - SM FLAT RATE BOX
                  - MD FLAT RATE BOX
                  - LG FLAT RATE BOX
                  - REGIONALRATEBOXA
                  - REGIONALRATEBOXB
                  - CUBIC PARCELS
                  - CUBIC SOFT PACK
                Machinable:
                  type: boolean
                  description: 'Machinable is required when: Service is FIRST CLASS and FirstClassMailType is LETTER OR FirstClassMailType is FLAT and Service is Retail Ground and ALL and ONLINE'
                  example: 'true'
                Zone:
                  type: string
                  description: 'USPS defined distance codes assigned to each origin and destination ZIP Code pairing for every ZIP Code number in the nation. These distance codes, referred to as zones, are designated as "1 through 9"'  
                  example: '4'
                Postage:
                  type: array
                  description: 'Postage tag contains a nested postal rate and service description.'
                  items:  
                    type: object
                    required:
                      - CLASSID
                      - MailService
                      - Rate
                    properties:
                      CLASSID:
                        type: integer
                        default: 1234
                        description: ' A mail class identifier for the postage returned. Not necessarily unique within a <Package>.'
                        xml:
                            attribute: true
                      MailService:
                        type: string
                        description: 'Service Type name'
                        example: '10101'
                      Rate:
                        type: number
                        format: double
                        description: 'Retail Rate'
                        example: '1.234'
                      CommercialRate:
                        type: number
                        format: double
                        description: 'Commercial Rate appears only where applicable and only when Service equals one of the following ONLINE, FIRST CLASS COMMERCIAL, FIRST CLASS HFP COMMERCIAL, PRIORITY COMMERCIAL, PRIORITY HFP COMMERCIAL, PRIORITY MAIL EXPRESS COMMERCIAL, PRIORITY MAIL EXPRESS SH COMMERCIAL or PRIORITY MAIL EXPRESS HFP COMMERCIAL.'
                        example: '3.21'
                      CommercialPlusRate:
                        type: number
                        format: double
                        description: 'Commercial Plus Rate appears only where applicable and only when Service equals one of the following PLUS, PRIORITY CPP, PRIORITY HFP CPP, PRIORITY MAIL EXPRESS CPP or PRIORITY MAIL EXPRESS HFP CPP'
                        example: '3.21'
                      MaxDimensions:
                        type: string
                        description: 'Maximum dimensions for a USPS produced product. Appears where applicable SortBy<> CONTAINER'
                        example: ''
                      ServiceInformation:
                        type: string
                        description: 'Maximum dimensions for a USPS produced product. Appears where applicable SortBy<> CONTAINER'
                        example: 'Mail Service Information appears when ReturnServiceInfo equals true'
                      CommitmentDate:
                            type: string
                            format: date
                            description: 'Calculated Date Package Will Be Delivered yyyy-mm-dd, such as 2020-07-28. Only returned for Priority Mail Express Mail variants when "ShipDate" tag is present in the request.'
                            example: '2022-02-02'                      
                      CommitmentName:
                        type: string
                        description: 'Inclusion of Ship Date will result in CommitmentName and CommitmentDate in the response for Priority Mail and Priority Mail Express variants'
                        example: 'Military'
                      Location:
                        type: array
                        description: 'Collection of Dropoff Locations with Cutoff times. Only returned with Express Mail variants, when "ShipDate" 
                                      tag is present in the request, and the "ReturnLocations" tag is not false.'
                        maxItems: 200
                        items:
                          type: object
                          required:
                            - CutOff
                            - Facility
                            - Street
                            - City
                            - State
                            - Zip
                          properties:
                            CutOff:
                              type: string
                              description: 'Local cutoff time for drop-off'
                              example: '8:00 PM'
                            Facility:
                              type: string
                              description: 'Facility Name '
                              example: 'EXPRESS MAIL COLLECTION BOX'
                            Street:
                              type: string
                              description: 'Facility Address'
                              example: '9201 EDGEWORTH DR'
                            City:
                              type: string
                              description: 'Facility City'
                              example: 'CAPITOL HEIGHTS'
                            State:
                              type: string
                              description: 'Facility State '
                              example: 'MD'
                            Zip:
                              type: string
                              description: 'Facility Zip'
                              example: '20790'
                      Commitment:
                        type: object
                        required:
                          - CommitmentName
                          - CommitmentDate
                          - CommitmentTime
                        description: 'his sequence consisting of CommitmentDate and Location nodes is mutually exclusive in a Package'
                        properties:
                          CommitmentName:
                            type: string
                            description: 'Inclusion of Ship Date will result in CommitmentName and CommitmentDate in the response for Priority Mail and Priority Mail Express variants'
                            example: 'Military'
                          CommitmentDate:
                            type: string
                            format: date
                            description: 'Calculated Date Package Will Be Delivered yyyy-mm-dd, such as 2020-07-28. Only returned for Priority Mail Express Mail variants when "ShipDate" tag is present in the request.'
                            example: '2022-02-02'
                          CommitmentTime:
                            type: string
                            description: 'Commitment time of day. Only returned for Priority Mail Express Mail variants when "ShipDate" tag is present in the request. '
                            example: '2022-02-02'
                          Location:
                              type: array
                              description: 'Collection of Dropoff Locations with Cutoff times. Only returned with Express Mail variants, when "ShipDate" 
                                            tag is present in the request, and the "ReturnLocations" tag is not false.'
                              maxItems: 200
                              items:
                                type: object
                                required:
                                  - CutOff
                                  - Facility
                                  - Street
                                  - City
                                  - State
                                  - Zip
                                properties:
                                  CutOff:
                                    type: string
                                    description: 'Local cutoff time for drop-off'
                                    example: '8:00 PM'
                                  Facility:
                                    type: string
                                    description: 'Facility Name '
                                    example: 'EXPRESS MAIL COLLECTION BOX'
                                  Street:
                                    type: string
                                    description: 'Facility Address'
                                    example: '9201 EDGEWORTH DR'
                                  City:
                                    type: string
                                    description: 'Facility City'
                                    example: 'CAPITOL HEIGHTS'
                                  State:
                                    type: string
                                    description: 'Facility State '
                                    example: 'MD'
                                  Zip:
                                    type: string
                                    description: 'Facility Zip'
                                    example: '20790'
                      SpecialServices:
                        type: array
                        xml:
                          wrapped : true
                          name: SpecialServices
                        description: 'Defines extra services in order to determine price and availability of additional services. An initial call without the SpecialService tag specified is recommended to determine base availability of special services for each mail class. Available when Revision="2" is included in the XML request'
                        maxItems: 10        
                        items:
                          type: object
                          required:
                            - SpecialService
                          xml:
                            name: 'SpecialService'
                          properties:
                            SpecialService:
                              type: object
                              required:
                                - ServiceID
                                - ServiceName
                                - Available
                                - AvailableOnline
                                - AvailableCPP
                                - Price
                                - PriceOnline
                                - PriceCPP
                              description: 'Defines individual services.'
                              properties:
                                ServiceID:
                                  type: integer
                                  description: 'Special service ID - returned with revision 2'
                                  example: '104'
                                ServiceName:
                                  type: string
                                  description: 'Special service name - returned with revision 2'
                                  example: 'Certificate of Mailing (Form 3817)'
                                Available:
                                  type: boolean
                                  description: 'Availability of special service. Availability may change depending on special services passed (selected) in request - returned with revision 2'
                                  example: 'true'
                                AvailableOnline:
                                  type: boolean
                                  description: 'Availability of special service for online only rates. Not all special services have online rates - returned with revision 2'
                                  example: 'false'
                                AvailableCPP:
                                  type: boolean
                                  description: 'Availability of special service for Commercial Plus Price only. Not all special services have Commercial Plus Prices - returned with revision 2'
                                  example: 'false'
                                Price:
                                  type: number
                                  description: 'Special service pricing. Pricing may change depending on special services passed (selected) in request - returned with revision 2'
                                  example: '2.00'
                                PriceOnline:
                                  type: number
                                  description: 'Special service pricing. Pricing may change depending on special services passed (selected) in request. Not all special services have online rates - returned with revision 2'
                                  example: '1.50'
                                PriceCPP:
                                  type: number
                                  description: 'Special service Commercial Plus Pricing. Commercial Plus Pricing may change depending on special services passed (selected) in request. Not all special services have Commercial Plus Pricing - returned with revision 2'
                                  example: '1.25'
                                DeclaredValueRequired:
                                  type: boolean
                                  description: 'ndicates if special service requires a declared package value (specified in RateV4Request[Value])to determine correct pricing.'
                                  example: 'true'
                                DueSenderRequired:
                                  type: boolean
                                  description: 'Indicates if special service requires a due sender amount (specified in RateV4Request[AmountToCollect]) to determine correct pricing.'
                                  example: 'false'
                      DimensionalWeightRate:
                        type: string
                        description: 'Dimensional weight retail rate'
                      DimensionalWeightCommercialRate:
                        type: string
                        description: 'Dimensional weight commercial base rate'
                      DimensionalWeightCommercialPlusRate:
                        type: string
                        description: 'Dimensional weight commercial plus rate'
                Restriction:
                  type: object
                  description: 'Defines extra services in order to determine price and availability of additional services. An initial call without the SpecialService tag specified is recommended to determine base availability of special services for each mail class. Available when Revision="2" is included in the XML request'     
                  properties:
                    Restrictions:
                      type: string
                      description: ''
                      example: 'A. Securities, currency, or precious metals, including in their raw, unmanufactured state, are prohibited. Official Mail shipments are exempt from this restriction. B. Other than for PMEMS and the exceptions listed below ... (clip)... S. Synthetic cannabinoids used to stimulate the central nervous system commonly known as "synthetic marijuana," "K2," or "Spice" are prohibited. U. Mail addressed to Retirees (Box R) is limited to 16 ounces and up to a 90-day supply of TRICARE medications. This restriction does not apply to mail endorsed "Free Matter for the Blind or Handicapped."'
                  
                Error:  
                  type: object
                  description: 'Error document (indicates request could not be completed). See the Error Responses section below.'
                  properties:
                    Number:
                      type: number
                      description: 'The error number generated by the Web Tools server'
                      example: '2147219498'
                    Source:
                      type: string
                      description: 'The component and interface that generated the error on the Web Tools server'
                      example: 'DomesticRatesV4;RateEngineV4.ProcessRequest'
                    Description:
                      type: string
                      description: 'The error description'
                      example: 'Please enter a valid ZIP Code for the sender'
                    HelpFile:
                      type: string
                      description: '[reserved for future use]'
                    HelpContext:
                      type: string
                      description: '[reserved for future use]'
                      example: '1000440'
    PackageResponse:
      type: object
      properties:
        Service: 
            type: string
            description: 'Web Tools validates the entry to one of the service types. For example: <Service>PRIORITY MAIL EXPRESS</Service> Note: Mailable matter not required to be mailed as First-Class Mail is permitted with Retail Ground to Zones 5-9. Zones 1-4 items are limited to mailable hazardous materials, live animals, and other “surface-only” items. Retail Ground can only be used for Zones 5-9 unless the shipment is oversized or contains classes of materials. (e.g. certain HAZMAT) For more details, see: http://pe.usps.com/businessmail101/classes/packageServices.htm. Note: The use of <Service> = “BPM” is restricted. If access to this service is needed, please reach out to the following email address: webtools@usps.gov.Note: For users that want to return all eligible products in a single RateV4 API call, please see details below regarding “All” calls:'
            example: 'Priority Mail Express'
            enum:
              - First Class Commercial
              - First Class
              - First Class HFP Commercial
              - First Class Returns
              - Parcel Select Ground
              - Parcel Select DE
              - Parcel Select LW
              - Priority
              - Priority Commercial
              - Priority CPP
              - Priority HFP Commercial
              - Priority HFP CPP
              - Priority Mail Express
              - Priority Mail Express Commercial
              - Priority Mail Express CPP
              - Priority Mail Express Sh
              - Priority Mail Express Sh Commercial
              - Priority Mail Express HFP
              - Priority Mail Express HFP Commercial
              - Priority Mail Express HFP CPP
              - Priority Mail Cubic
              - Priority Mail Cubic Returns
              - Priority Mail Returns
              - Retail Ground
              - Ground Returns
              - Media
              - Library
              - All
              - Online
              - Plus
              - BPM
        FirstClassMailType:
          type: string
          description: 'Required when Service property is FIRST CLASS or FIRST CLASS COMMERCIAL or FIRST CLASS HFP COMMERCIAL. Note: The <FirstClassMailType> tag is returned only if the <ServiceType> submitted is “First Class”. If any other <ServiceType> is returned (Including “First Class Commercial”) the <Container> tag is used. Note: Flats are also known as Large Envelopes'
          example: 'LETTER'
          enum:
            - LETTER 
            - FLAT
        ZipOrigination:
          type: string
          description: 'ZIP code must be valid. '
          example: '10101'
        ZipDestination:
          type: string
          description: 'ZIP code must be valid.'
          example: '54324'
        Pounds:
          type: integer
          minimum: 0
          maximum: 70
          description: 'Value must be numeric. Package weight cannot exceed 70 pounds.'
          example: '10'
        Ounces:
          type: number
          format: double
          minimum: 1
          maximum: 1120
          description: 'Value must be numeric. Package weight cannot exceed 70 pounds (1120 ounces). '
          example: '8'
        Container:
          type: string
          description: 'Use to specify container attributes that may affect postage; otherwise, leave blank. Note: The <FirstClassMailType> tag is used instead of the <Container> tag only if the <ServiceType> submitted is “First Class”. Note: “Cubic Soft Pack” and “Cubic Parcels” are only valid containers for service “Priority Mail Cubic”. Dimensions Length and Height are required when requesting Cubic Soft Pack. Dimensions Length, Height, and Width are required when requesting Cubic Parcels. Note: “VARIABLE” is used to denote that a customer is using packaging other than a USPS produced Flat Rate Box/Envelope or RegionalRate Box”.'
          example: 'FLAT RATE ENVELOPE'
          enum:
            - VARIABLE
            - FLAT RATE ENVELOPE
            - PADDED FLAT RATE ENVELOPE
            - LEGAL FLAT RATE ENVELOPE
            - SM FLAT RATE ENVELOPE
            - WINDOW FLAT RATE ENVELOPE
            - GIFT CARD FLAT RATE ENVELOPE
            - SM FLAT RATE BOX
            - MD FLAT RATE BOX
            - LG FLAT RATE BOX
            - REGIONALRATEBOXA
            - REGIONALRATEBOXB
            - CUBIC PARCELS
            - CUBIC SOFT PACK
        Size:
          type: string
          description: 'Note: This tag has been deprecated. <Size> tag and any values within the <Size> tag will not result in an error response and will not impact rates that are returned.'
        Width:
          type: string
          description: 'Value must be numeric. Units are inches. If partial dimensions are provided, an error response will return. Length, Width, Height are required for accurate pricing of a rectangular package when any dimension of the item exceeds 12 inches. In addition, Girth is required only for a nonrectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for nonrectangular packages. For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm'
        Length:
          type: string
          description: 'Value must be numeric. Units are inches. If partial dimensions are provided, an error response will return. Length, Width, Height are required for accurate pricing of a rectangular package when any dimension of the item exceeds 12 inches. In addition, Girth is required only for a nonrectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for nonrectangular packages. For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm'
        Height:
          type: number
          format: double
          maxLength: 10
          description: 'Units are inches. Setting the height requires Length and Width as be set for accurate pricing of a rectangular package when any dimension of the item exceeds 12 inches. For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm'
        Girth:
          type: number
          format: double
          maxLength: 10
          description: 'Units are inches. Girth is only required for a non rectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for nonrectangular packages. For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm'
        Value:
          type: number
          format: double
          description: 'Package value. Used to determine availability and cost of extra services. Available when Revision="2" is included in the XML request'
          example: "150.00"
        AmountToCollect:
          type: number
          format: double
          maxLength: 10
          description: 'Collect on delivery amount. Used to determine availability and cost of extra services. Available when Revision="2" is included in the XML request'
        SpecialServices:
          $ref: '#/components/schemas/SpecialServices'
        Content:
          type: object
          description: 'Groups the ContentType and ContentDescription elements. Available when Revision="2" is included in the XML request'
          properties:
            ContentType: 
              type: string
              description: 'Defines the type of content of the package'
              example: 'LIVES'
              enum:
                - HAZMAT
                - CREMATEDREMAINS
                - FRAGILE
                - PERISHABLE
                - PHARMACEUTICALS
                - MEDICAL SUPPLIES
                - LIVES
            ContentDescription:
              type: string
              description: 'Describes the content of the package. Optional but required for ContentType LIVES'
              example: 'BEES'
              enum:
                - BEES
                - DAYOLDPOULTRY
                - ADULTBIRDS
                - OTHER
        GroundOnly:
          type: boolean
          description: 'Use “true” when shipment contains mailable hazardous materials, live animals and other "surface-only" items. Available when Revision="2" is included in the XML request and Service array includes Retail Ground'
          example: 'true'
        SortBy:
          type: string
          description: 'Returns all mailing services available based on item shape. When specified, value in <Container> is ignored. Available when Revision="2" and Sevices includes ALL and ONLINE is included in the XML request'
          example: 'LETTER'
          enum:
            - LETTER
            - LARGEENVELOPE
            - PACKAGE
            - FLATRATE
        Machinable:
          type: boolean
          description: 'Machinable is required when: Service is FIRST CLASS and FirstClassMailType is LETTER OR FirstClassMailType is FLAT and Service is Retail Ground and ALL and ONLINE'
          example: 'true'
        ReturnLocations:
          type: boolean
          description: 'Include Dropoff Locations in Response if available. Requires "ShipDate" tag.'
          example: 'true'
        ReturnServiceInfo:
          type: boolean
          description: 'If a value of “True” is indicated in the request then the response will include the <ServiceInformation> tag containing mail service specific information '
          example: 'false'
        DropOffTime:
          type: string
          description: 'Time Package Will Be Mailed. Enter drop off time in format: HH:mm, such as 13:45. Inclusion of Drop Off Time will result increased accuracy of <CommitmentName> and <CommitmentDate> in the response for Priority Mail and Priority Mail Express variants.'
          example: '13:45'
        ShipDate:
          type: string
          format: date
          description: 'Date Package Will Be Mailed. Ship date may be today plus 0 to 3 days in advance. Enter the date in format: yyyy-mm-dd, such as 2013-07-28. Inclusion of Ship Date will result in <CommitmentName> and <CommitmentDate> in the response for Priority Mail and Priority Mail Express variants. For example: <ShipDate Option="HFP">2013-07-28</ShipDate>'
          example: '2020-07-28'
        # ShipDate:
        #   type: "object"
        #   description: 'Date Package Will Be Mailed. Ship date may be today plus 0 to 3 days in advance. Enter the date in format: yyyy-mm-dd, such as 2013-07-28. Inclusion of Ship Date will result in <CommitmentName> and <CommitmentDate> in the response for Priority Mail and Priority Mail Express variants'
        #   title: "Person"
        #   properties:
        #     content: 
        #       type: "object"
        #       example: '2020-07-28'
        #     Option:
        #       type: "string"
        #       example: "HFP"
        #       xml:
        #         attribute: true
        ReturnDimensionalWeight:
          type: boolean
          description: 'This tag must be explicitly set to “true” for dimensional weight to be returned in the xml response.'
          example: 'true'
        TrackingRetentionPeriod:
          type: string
          description: 'Used to determine period of Retention for tracking data'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        number:
          type: integer
          format: int32
          example: '2147219401'
        source:
          type: string
          example: 'clsAMS'
        description:
          type: string
          example: 'Address Not Found.'
        HelpFile:
          type: string
        HelpContext:
          type: string