openapi: 3.1.0
info:
  title: Delivery Intercept® API v2
  description: |
    With the UPS Delivery Intercept® API, a shipper can cancel or reroute a shipment they have sent, prior to delivery.

    ## Key Business Values
    - Elimination of manually processing customer requests
    - Acceptance of requests later in the delivery process

    For more information on the Delivery Intercept® API, please visit the <a href="https://developer.ups.com/api/reference/deliveryintercept/product-info" target="_blank" rel="noopener">Product Info</a> page.
    
    ## Reference
    - <a href="https://developer.ups.com/api/reference/deliveryintercept/errors" target="_blank" rel="noopener">Errors</a>
    
    <br/><p>Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our <a href="https://developer.ups.com/api/reference/postman/guide"
    target="_blank" rel="noopener">Postman Guide</a>. Explore API documentation and sample applications through GitHub.</p>

    <a href="https://god.gw.postman.com/run-collection/29542085-f2409ef1-39c9-4f4a-a509-a3f860068ff4?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-f2409ef1-39c9-4f4a-a509-a3f860068ff4%26entityType%3Dcollection%26workspaceId%3D7e7595f0-4829-4f9a-aee1-75c126b9d417" target="_blank" rel="noopener noreferrer">
      <img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;"></a>
    <a href="https://github.com/UPS-API" target="_blank" rel="noopener noreferrer">
      <img src="https://www.ups.com/assets/resources/webcontent/images/gitHubButton.svg" alt="Open in GitHub" style="width: 128px; height: 32px;">
    </a>

    ## CIE Behavior

    The Delivery Intercept API will return a stubbed success response if the correct data is used for a given endpoint. The static data that is valid for each of the endpoints is in the table below:
    
    | Endpoint | transId | trackingNumber                                                                                                                                                                                              |
    |------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    | /charges     | SIICharges         | 1Z4096YY0316914058
    | /eligibility/intercept | SUPER14 | 1Z6568YY1200043419
    | /willcall     | SIIWillcall        | 1Z4096YY0316914058
    | /return     | SIIReturn         | 1Z4096YY0316914058
    | /reschedule     | SIIReschedule         | 1Z4096YY0316914058
    | /redirect/address     | SIIRedirect         | 1Z4096YY0316914058
    | /cancel     | SIICancel         | 1Z4096YY0316914058
  version: "1.0"
servers:
  - url: https://onlinetools.ups.com/api/deliveryintercept/{version}
    description: Production
    variables:
      version:
        default: v2
        enum:
          - v2
  - url: https://wwwcie.ups.com/api/deliveryintercept/{version}
    description: Customer Integration Environment
    variables:
      version:
        default: v2
        enum:
          - v2
paths:
  /charges/{tracking_number}:
    post:
      summary: Get charges by inquiry type
      description: Obtains intercept charges specified by the inquiry type and tracking number passed in the interface.
      operationId: getCharges
      tags: 
        - Delivery Intercept
      security:
        - OAuth2: []
      parameters:
        - $ref: "#/components/parameters/transId"
        - $ref: "#/components/parameters/PlatformType"
        - $ref: "#/components/parameters/Content-Type"
        - $ref: "#/components/parameters/InquiryType"
        - $ref: "#/components/parameters/tracking_number"
        - $ref: "#/components/parameters/Loc"
        - name: version
          in: path
          description: version
          required: true
          schema:
            type: string
            default: v2
            enum:
                - v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryInterceptChargesRequestV2'
            example:
              clientIP: 10.9.100.220
              ratingRequest:
                - redirectAddress: 
                    addressNickName: John's work address
                    addressInfo:
                      addressLine1: "1899" 
                      city: Baltimore
                      state: MD
                      postalCode: 21230-3410
                      countryCode: US
                      buildingFloor: "2"
                      publicLocationId: "62200"
                      firstName: Robert
                      lastName: Willams
                      fullName: Trk 7702 Paramus Ward
                      phoneNumber: "+1987654324"
                    nameOrCompanyName: ACME Inc.
                    contactName: Robert
                    phoneNumber: "+1987654324"
                    phoneExt: "+123"
                    emailAddress: aups@ups.com
                  fromAddress: 
                    addressLine1: "1899" 
                    city: Baltimore
                    state: MD
                    postalCode: 21230-3410
                    countryCode: US
                    buildingFloor: "2"
                    publicLocationId: "62200"
                    firstName: Robert
                    lastName: Willams
                    fullName: Trk 7702 Paramus Ward
                    phoneNumber: "+1987654324"
                  toAddress:
                    addressLine1: "12911 FORK RD"
                    city: BALDWIN
                    state: MD
                    postalCode: "21013"
                    countryCode: US
                    buildingFloor: "2"
                    publicLocationId: "7002"
                    firstName: Sam
                    lastName: carren
                    fullName: RICA80 CDW80
                    phoneNumber: "+1987654324"
                  trackInfo: 
                    interceptOption: AL
      responses:
        '200':
          description: Success
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptChargesResponseV2'
              examples:
                ALL INTERCEPT:
                  summary: ALL Intercept Response
                  value: 
                    response:
                      transactionId: ASR1212
                      statusCode: "000"
                      statusMsg: Success
                      success: true
                      addrToken: "2"
                      errors: null
                      warnings: null
                      chargeInfo:
                        - trackingNumber: 1ZA2F8810719086435
                          accessorialCharge: "0.00"
                          interceptCharge: "0.00"
                          transportationCharge: "0.00"
                          totalCharge: "0.00"
                          chargeCurrency: USD
                          estDeliveryDate: "20250220"
                          residentialIndicator: false
                          additionalHandlingIndicator: false
                          downgradeServiceCode: null
                          oversizeCode: null
                          serviceCode: "012"
                          serviceDesc: UPS 3 Day Select
                          packageWeight: "5"
                          packageWeightUOM: LBS
                          packagingType: "03"
                          interceptChargeDetail:
                            - accessorialCharge: "21.00"
                              interceptCharge: "21.00"
                              transportationCharge: "0.00"
                              totalCharge: "21.00"
                              interceptOption: AA
                              displayShipperPaidInterceptCharges: false
                              shipperPaidInterceptCharges: false
                              successful: true
                              currencyCode: USD
                            - accessorialCharge: "21.00"
                              interceptCharge: "21.00"
                              transportationCharge: "0.00"
                              totalCharge: "21.00"
                              interceptOption: FD
                              displayShipperPaidInterceptCharges: false
                              shipperPaidInterceptCharges: false
                              successful: true
                              currencyCode: USD
                            - accessorialCharge: "21.00"
                              interceptCharge: "21.00"
                              transportationCharge: "0.00"
                              totalCharge: "21.00"
                              interceptOption: RS
                              displayShipperPaidInterceptCharges: false
                              shipperPaidInterceptCharges: false
                              successful: true
                              currencyCode: USD
                          shipperName: ACME Inc.
                          preTaxTotalCharge: "25.00"
                          taxDisclaimerIndicator: NTA
                          displayShipperPaidInterceptCharges: false
                          shipperPaidInterceptCharges: false
                          shipperPaidTransportationCharges: false
                          displayShipperPaidTransportationCharges: false
                          chargesPaidByThirdPartyShipper: false
                          taxes:
                            - tax: City
                              taxAmount: "5.00"
                            - tax: State
                              taxAmount: "2.00"
                          totalTax: "7.00"                      
                      accessorialGrandTotal: ""
                      interceptGrandTotal: ""
                      transportationGrandTotal: ""
                      grandTotalCharge: ""
                      taxesGrandTotal: ""
                      preTaxGrandTotal: ""
                SINGLE INTERCEPT:
                  summary: Single Intercept Response
                  value: 
                    response:
                      transactionId: ASR1212
                      statusCode: "000"
                      statusMsg: Success
                      success: true
                      addrToken: "2"
                      errors: null
                      warnings: null
                      chargeInfo:
                        - trackingNumber: 1ZA2F8810719086435
                          accessorialCharge: "10.00"
                          interceptCharge: "5.00"
                          transportationCharge: "25.00"
                          totalCharge: "40.00"
                          chargeCurrency: USD
                          estDeliveryDate: "20250220"
                          residentialIndicator: false
                          additionalHandlingIndicator: false
                          downgradeServiceCode: null
                          oversizeCode: null
                          serviceCode: "012"
                          serviceDesc: UPS 3 Day Select
                          packageWeight: "5"
                          packageWeightUOM: LBS
                          packagingType: "03"
                          shipperName: ACME Inc.
                          preTaxTotalCharge: "25.00"
                          taxDisclaimerIndicator: NTA
                          displayShipperPaidInterceptCharges: false
                          shipperPaidInterceptCharges: false
                          shipperPaidTransportationCharges: false
                          displayShipperPaidTransportationCharges: false
                          chargesPaidByThirdPartyShipper: false
                          taxes:
                            - tax: City
                              taxAmount: "5.00"
                            - tax: State
                              taxAmount: "2.00"
                          totalTax: "7.00"                      
                      accessorialGrandTotal: ""
                      interceptGrandTotal: ""
                      transportationGrandTotal: ""
                      grandTotalCharge: ""
                      taxesGrandTotal: ""
                      preTaxGrandTotal: ""
        '400':
          description: Bad Request
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "400"
                  errors:
                    - code: "710"
                      message: Failure due to input validation error
        '401':
          description: Unauthorized
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "401"
                  errors:
                    - code: "605"
                      message: Package address token does not match any tokens in the user's profile.
  /eligibility/intercept/{tracking_number}:
    get:
      summary: Get eligibility options
      description: Retrieves the delivery change eligibility information for the tracking number passed in the interface.
      operationId: getEligibilityOptions
      tags:
        - Delivery Intercept
      security:
        - OAuth2: []
      parameters:
        - $ref: "#/components/parameters/transId"
        - $ref: "#/components/parameters/PlatformType"
        - $ref: "#/components/parameters/Content-Type"
        - $ref: "#/components/parameters/InquiryType"
        - $ref: "#/components/parameters/tracking_number"
        - $ref: "#/components/parameters/Loc"
        - name: version
          in: path
          description: version
          required: true
          schema:
            type: string
            default: v2
            enum:
                - v2
      responses:
        '200':
          description: Success
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeliveryInterceptEligibilityOptionsResponseV2"
              examples: 
                SUCCESS:
                  summary: Success Response
                  value:
                    response: 
                      transactionId: b2e514fc8a2
                      statusCode: "000"
                      statusMsg: SUCCESS
                      success: true
                      errors: null
                      warnings: null
                      commonEligibilityMap: 
                        - interceptFeature: FD
                          eligibilityValue:
                            createEligibility: ELIGIBLE
                            modifyEligibility: NOT_ELIGIBLE
                            cancelEligibility: NOT_ELIGIBLE
                            dateOptionsforFutureDelivery: 
                              - date: 20250110
                                dayOfWeekText: Friday
                                dayOfWeekNumber: 06
                              - date: 20250115
                                dayOfWeekText: Wednesday
                                dayOfWeekNumber: 04
                        - interceptFeature: WC
                          eligibilityValue:
                            createEligibility: ELIGIBLE
                            modifyEligibility: NOT_ELIGIBLE
                            cancelEligibility: NOT_ELIGIBLE
                        - interceptFeature: SDWC
                          eligibilityValue:
                            createEligibility: ELIGIBLE
                            modifyEligibility: NOT_ELIGIBLE
                            cancelEligibility: NOT_ELIGIBLE
                        - interceptFeature: RD
                          eligibilityValue:
                            createEligibility: ELIGIBLE
                            modifyEligibility: NOT_ELIGIBLE
                            cancelEligibility: NOT_ELIGIBLE
                        - interceptFeature: RTS
                          eligibilityValue:
                            createEligibility: ELIGIBLE
                            modifyEligibility: NOT_ELIGIBLE
                            cancelEligibility: NOT_ELIGIBLE
                            reasonOptionsForRTS: 
                            - id: AN
                              value: Duplicate Order
                            - id: AS
                ERROR:
                  summary: Error Response
                  value:
                    response: 
                      transactionId: b2e514fc8a2
                      statusCode: "500"
                      statusMsg: ERROR
                      success: false
                      errors: 
                        - errorCode: "500"
                          errorMessage: System Error
                      commonEligibilityMap: null
        '400':
          description: Bad Request
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: b2e514fc8a2
                  statusCode: "400"
                  errors:
                    - code: "710"
                      message: Failure due to input validation error
        '401':
          description: Unauthorized
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "401"
                  errors:
                    - code: "605"
                      message: Package address token does not match any tokens in the user's profile.
  /redirect/address/{tracking_number}:
    post:
      summary: Submit a non access point redirect request
      description: Submits a deliver to another address delivery change for the tracking number passed in the interface.
      operationId: getRedirectInterceptOptions
      tags:
        - Delivery Intercept
      security:
        - OAuth2: []
      parameters:
        - $ref: "#/components/parameters/transId"
        - $ref: "#/components/parameters/PlatformType"
        - $ref: "#/components/parameters/Content-Type"
        - $ref: "#/components/parameters/InquiryType"
        - $ref: "#/components/parameters/tracking_number"
        - $ref: "#/components/parameters/Loc"
        - name: version
          in: path
          description: version
          required: true
          schema:
            type: string
            default: v2
            enum:
                - v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryInterceptRequestV2'
            example:
              requestType: AA
              specialInstructions: Handle With Care
              requesterContactInfo: 
                name: andreas
                telephone: "+12010000000"
                phoneExt: "+123"
                emailAddress: aups@ups.com
                altTelephone: "+12345678"
                altPhoneExt: "+1"
                displayPhoneNumber: false
              newDeliveryAddress: 
                addressNickName: John's new address
                addressInfo: 
                  addressLine1: 12911 FORK RD
                  addressLine2: Washington
                  addressLine3: Washington
                  city: BALDWIN
                  state: MD
                  postalCode: "21013"
                  countryCode: US
                  buildingFloor: "2"
                  publicLocationId: "800"
                  firstName: "sam"
                  lastName: "curren"
                  fullName: "sam curren"
                  phoneNumber: "+1988676185"
                nameOrCompanyName: KRISTINA LEO
                contactName: Andrea
                phoneNumber: "+2019909098"
                phoneExt: "+2"
                emailAddress: aups@ups.com
      responses:
        '200':
          description: Successful response
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptResponseV2'
              examples:
                SUCCESS:
                  summary: Success Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: true
                    errors: null
                    subStatusCode: ""
                ERROR:
                  summary: Error Response
                  value: 
                    transactionId: ASR1212
                    statusCode: "500"
                    statusMsg: System Error
                    success: false
                    errors: 
                      - errorCode: "500"
                        errorMessage: System Error
                    subStatusCode: ""
        '400':
          description: Validation error occurred
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "400"
                  errors:
                    - code: "710"
                      message: Failure due to input validation error
        '401':
          description: Authentication required
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "401"
                  errors:
                    - code: "605"
                      message: Package address token does not match any tokens in the user's profile.       
  /willcall/{tracking_number}:
    post:
      summary: Request to hold the package at a UPS facility for pickup
      description: Request your package to be held at or returned to a UPS facility where the receiver may claim the same-day.
      operationId: willcallInterceptOption
      tags:
        - Delivery Intercept
      security:
        - OAuth2: []
      parameters:
        - $ref: "#/components/parameters/transId"
        - $ref: "#/components/parameters/PlatformType"
        - $ref: "#/components/parameters/Content-Type"
        - $ref: "#/components/parameters/InquiryType"
        - $ref: "#/components/parameters/tracking_number"
        - $ref: "#/components/parameters/Loc"
        - name: version
          in: path
          description: version
          required: true
          schema:
            type: string
            default: v2
            enum:
                - v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryInterceptRequestV2'
            example:
              requestType: WC
              specialInstructions: Handle With Care
              requesterContactInfo: 
                name: John
                telephone: "+3522098238"
                phoneExt: "+123"
                emailAddress: aups@ups.com
                altTelephone: "+3522098238"
                altPhoneExt: "+3"
                displayPhoneNumber: false
      responses:
        '200':
          description: Successful response
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptResponseV2'
              examples:
                SUCCESS:
                  summary: Success Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: true
                    errors: null
                    subStatusCode: ""
                ERROR:
                  summary: Error Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: false
                    errors: 
                      - errorCode: "500"
                        errorMessage: System Error
                    subStatusCode: ""
        '400':
          description: Validation error occurred
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "400"
                  errors:
                    - code: "710"
                      message: Failure due to input validation error
        '401':
          description: Authentication required
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "401"
                  errors:
                    - code: "605"
                      message: Package address token does not match any tokens in the user's profile.
  /return/{tracking_number}:
    post:
      summary: Submit a return to sender request
      description: Return a package to the original shipper prior to delivery.
      operationId: returnInterceptOption
      tags:
        - Delivery Intercept
      security:
        - OAuth2: []
      parameters:
        - $ref: "#/components/parameters/transId"
        - $ref: "#/components/parameters/PlatformType"
        - $ref: "#/components/parameters/Content-Type"
        - $ref: "#/components/parameters/InquiryType"
        - $ref: "#/components/parameters/tracking_number"
        - $ref: "#/components/parameters/Loc"
        - name: version
          in: path
          description: version
          required: true
          schema:
            type: string
            default: v2
            enum:
                - v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryInterceptRequestV2'
            example:
              requestType: RS
              specialInstructions: Handle With Care
              requesterContactInfo: 
                name: andreas
                telephone: "+112010000000"
                phoneExt: "+123"
                emailAddress: aups@ups.com
                altTelephone: "+19887654321"
                altPhoneExt: "+12"
                displayPhoneNumber: false
              reasonForReturn: AM
      responses:
        '200':
          description: Successful response
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptResponseV2'
              examples:
                SUCCESS:
                  summary: Success Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: true
                    errors: null
                    subStatusCode: ""
                ERROR:
                  summary: Error Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: false
                    errors: 
                      - errorCode: "500"
                        errorMessage: System Error
                    subStatusCode: ""
        '400':
          description: Validation error occurred
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "400"
                  errors:
                    - code: "710"
                      message: Failure due to input validation error
        '401':
          description: Authentication required
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "401"
                  errors:
                    - code: "605"
                      message: Package address token does not match any tokens in the user's profile.
  /reschedule/{tracking_number}:
    post:
      summary: Request for a new delivery date
      description: Have the package delivered to the original address but on a different day in the future.
      operationId: rescheduleInterceptOption
      tags:
        - Delivery Intercept
      security:
        - OAuth2: []
      parameters:
        - $ref: "#/components/parameters/transId"
        - $ref: "#/components/parameters/PlatformType"
        - $ref: "#/components/parameters/Content-Type"
        - $ref: "#/components/parameters/InquiryType"
        - $ref: "#/components/parameters/tracking_number"
        - $ref: "#/components/parameters/Loc"
        - name: version
          in: path
          description: version
          required: true
          schema:
            type: string
            default: v2
            enum:
                - v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryInterceptRequestV2'
            example:
              requestType: FD
              specialInstructions:
              requesterContactInfo: 
                name: andreas
                telephone: "+112010000000"
                phoneExt: "+1"
                emailAddress: aups@ups.com
                altTelephone: "+19887654321"
                altPhoneExt: "+12"
                displayPhoneNumber: false
              deliveryDate: "20240904"
      responses:
        '200':
          description: Successful response
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptResponseV2'
              examples:
                SUCCESS:
                  summary: Success Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: true
                    errors: null
                    subStatusCode: ""
                ERROR:
                  summary: Error Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: false
                    errors: 
                      - errorCode: "500"
                        errorMessage: System Error
                    subStatusCode: ""
        '400':
          description: Validation error occurred
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "400"
                  errors:
                    - code: "710"
                      message: Failure due to input validation error
        '401':
          description: Authentication required
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "401"
                  errors:
                    - code: "605"
                      message: Package address token does not match any tokens in the user's profile.
  /cancel/{tracking_number}:
    post:
      summary: Request cancellation of a prior intercept request
      description: Cancel a previously applied intercept on the package.
      operationId: cancelInterceptOption
      tags:
        - Delivery Intercept
      security:
        - OAuth2: []
      parameters:
        - $ref: "#/components/parameters/transId"
        - $ref: "#/components/parameters/PlatformType"
        - $ref: "#/components/parameters/Content-Type"
        - $ref: "#/components/parameters/InquiryType"
        - $ref: "#/components/parameters/tracking_number"
        - $ref: "#/components/parameters/Loc"
        - name: version
          in: path
          description: version
          required: true
          schema:
            type: string
            default: v2
            enum:
                - v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryInterceptRequestV2'
            example:
              requestType: FD
              specialInstructions:
              requesterContactInfo:
                name: John A
                telephone: "+19881234567"
                phoneExt: "+1"
                emailAddress: aups@ups.com
                altTelephone: "+19881234567"
                altPhoneExt: "+12"
                displayPhoneNumber: true
      responses:
        '200':
          description: Successful response
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptResponseV2'
              examples:
                SUCCESS:
                  summary: Success Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: true
                    errors: null
                    subStatusCode: ""
                ERROR:
                  summary: Error Response
                  value:
                    transactionId: ASR1212
                    statusCode: "000"
                    statusMsg: Success
                    success: false
                    errors: 
                      - errorCode: "500"
                        errorMessage: System Error
                    subStatusCode: ""
        '400':
          description: Validation error occurred
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "400"
                  errors:
                    - code: "710"
                      message: Failure due to input validation error
        '401':
          description: Authentication required
          headers:
            BkndTransId:
              $ref: "#/components/headers/BkndTransId"
            transId:
              $ref: "#/components/headers/transId"
            transactionSrc:
              $ref: "#/components/headers/transactionSrc"
            Content-Type:
              $ref: "#/components/headers/Content-Type"
            APIErrorCode:
              $ref: "#/components/headers/APIErrorCode"
            APIErrorMessage:
              $ref: "#/components/headers/APIErrorMsg"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryInterceptErrorResponseV2'
              example:
                response:
                  transactionId: ASR1212
                  statusCode: "401"
                  errors:
                    - code: "605"
                      message: Package address token does not match any tokens in the user's profile.
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      description: |
        Find your Client ID and Secret on your app info page. 
          1. Select "Try It" 
          2. In the Security section enter your Client ID and Secret 
          3. Select "Request Token"
          4. Enter any additional information in the Body and Parameters sections
          5. Select "Send" to execute your API request"
      flows:
        clientCredentials:
          x-tokenEndpointAuthMethod: client_secret_basic
          tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token
          scopes: {}
  parameters:
    transId:
      name: transId
      in: header
      description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes
      required: true
      schema:
        type: string 
        pattern: ^[a-zA-Z0-9-.]{3,14}$
        minLength: 3
        maxLength: 14
        example: 0a1b9c2d8e3f43
    PlatformType:
      name: platformType
      in: header
      description: Identifies the client/source application that is calling.
      required: true
      schema:
        type: string
        enum:
          - XOLT
    Content-Type:
      name: Content-Type
      description: describes the content type to expect
      in: header
      required: true
      schema:
        type: string
        example: application/json
    InquiryType:
      name: inquiryType
      description: describes the content type to expect
      in: header
      required: true
      schema:
        type: string
        description: indicator for UPS Shipper Initiated Intercepts
        enum: 
          - U
    tracking_number:
      name: tracking_number
      description: The number being tracked.  Each method defines if required.
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
        minLength: 18
        maxLength: 18
        pattern: '^(1Z)[A-Z0-9]{16}$'
        example: 1ZA2F8810719086435
    Loc:
      name: loc
      in: query
      required: false
      description: >-
        The locale of the client application to ensure that translations on
        the response are in the proper language.
      style: form
      explode: true
      schema:
        type: string
        maxLength: 5
        pattern: '^[a-z]+[_]+[A-Z]+$'
        example: en_US
  headers:
    BkndTransId:
      description: The backend transaction id.
      schema:
        type: string
        example: 383f7d397a48
    transId:
      description: An identifier unique to the request.
      schema:
        type: string 
        pattern: ^[a-zA-Z0-9-.]{3,36}$
        minLength: 3
        maxLength: 36
        example: 0a1b9c2d8e3f7g4h6i5
    transactionSrc:
      description: Identifies the client/source application that is calling.
      schema:
        type: string
        pattern: ^[a-zA-Z0-9-.]{1,36}$
        minLength: 1
        maxLength: 36
        example: UPS.com
    Content-Type:
      description: The Content-Type header provides the client with the actual content/media type of the returned content.
      schema:
        type: string
        example: application/json
    APIErrorCode:
      description: The API error code.
      schema:
        type: string
        example: UJ0001
    APIErrorMsg:
      description: The API error message.
      schema:
        type: string
        example: Invalid token or token is not present.
  schemas:
    DeliveryInterceptChargesRequestV2:
      type: object
      description: Request schema for Delivery Change Charges retrieval
      properties:
        clientIP:
          type: string
          description: IP address of the requesting device
          example: 10.9.100.220
        ratingRequest:
          type: array
          description: |
            List of rating request data. If you want to find out the accessory and transportation charges of a "redirect" request
            for a specified Tracking number then this array list must contain one rating request. This array is unbounded.
          items:
            type: object
            description: Container for each rating request object
            properties:
              redirectAddress:
                type: object
                properties:
                  addressNickName:
                    type: string
                    description: The nickname string assigned to the address entry. 
                    minLength: 2
                    maxLength: 20
                    example: John's woek address
                  addressInfo:
                    description: Address object, include line1, line2, line 3 state, postal code and country code. Required when processing a request if imsAddressIdentifier is not present.
                    $ref: '#/components/schemas/DeliveryInterceptAddressV2'
                  nameOrCompanyName:
                    type: string
                    description: The name of the company or person customer address.(Required When calling submitAddress() API  Empty String  can be passed)          
                    example: ACME Inc.
                  contactName:
                    type: string
                    description: The contact name at the customer address.
                    example: Robert
                  phoneNumber:
                    type: string
                    description: The contact phone number at the customer address.(Required When calling submitAddress() API  Empty String  can be passed)
                    maxLength: 14
                    pattern: '^(\+)[0-9]{1,13}$'
                    example: "+19886222523"
                  phoneExt:
                    type: string
                    description: The phone extension number at the customer address.(Required When calling submitAddress() API  Empty String  can be passed)
                    pattern: '^(\+)[0-9]{1,3}$'
                    example: "+244"
                  emailAddress:
                    type: string
                    description: Email Address at the customer address.
                    pattern: '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$'
                    example: aups@ups.com
                additionalProperties: false
                required:
                  - addressNickName
                  - addressInfo
                  - nameOrCompanyName
                  - contactName
                  - phoneNumber
              fromAddress:
                allOf:
                  - $ref: '#/components/schemas/DeliveryInterceptAddressV2'
                  - $ref: '#/components/schemas/DeliveryInterceptAdditionalAddressV2'
              toAddress:
                allOf:
                  - $ref: '#/components/schemas/DeliveryInterceptAddressV2'
                  - $ref: '#/components/schemas/DeliveryInterceptAdditionalAddressV2'
              trackInfo:
                type: object
                properties:
                  interceptOption:
                    type: string
                    description: Intercept option to be mentioned to find the charges 
                    minLength: 2
                    maxLength: 2
                    oneOf:
                      - const: WC
                        title: WILL CALL
                      - const: SC
                        title: SAME DAY WILL CALL
                      - const: FD
                        title: FUTURE DELIVERY 
                      - const: AA
                        title: ALTERNATE ADDRES
                      - const: RS
                        title: RETURN TO SENDER
                      - const: AL
                        title: ALL INTERCEPT
                additionalProperties: false
                required: 
                  - interceptOption
            additionalProperties: false
            required:
              - fromAddress
              - toAddress
              - trackInfo
      additionalProperties: true
      required: 
        - ratingRequest
    DeliveryInterceptChargesResponseV2:
      type: object
      description: Response schema for Delivery Change Charge request
      properties:
        response:
          allOf:
            - $ref: "#/components/schemas/DeliveryInterceptCommonResponseV2"
            - type: object
              properties:
                chargeInfo:
                  type: array
                  description: For each 1z there will exist a ChargeInfo object. These are the charges that were applied. This array is unbounded.                  
                  minItems: 1
                  items:
                    type: object
                    properties:
                      trackingNumber:
                        $ref: "#/components/schemas/DeliveryInterceptTrackingNumberV2"
                      accessorialCharge:
                        description: The sum of all accessorial charges (i.e. including addition handling, intercept)
                        $ref: "#/components/schemas/DeliveryInterceptChargeV2"
                      interceptCharge:
                        description: The flat rate charge specific for the intercept
                        $ref: "#/components/schemas/DeliveryInterceptChargeV2"
                      transportationCharge:
                        description: The sum of all AlternateAddress transportation Charges (Redirect,deliver to another address)
                        $ref: "#/components/schemas/DeliveryInterceptChargeV2"
                      totalCharge:
                        description: Total of all accessorial, intercept and transportation charges
                        $ref: "#/components/schemas/DeliveryInterceptChargeV2"
                      chargeCurrency:
                        type: string
                        description: The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> currency code
                        maxLength: 3
                        minLength: 3
                        pattern: ^[A-Z]{3}$
                        example: USD
                      estDeliveryDate:
                        description: Estimate Delivery Date (YYYYMMDD).
                        $ref: "#/components/schemas/DeliveryInterceptDateV2"
                      residentialIndicator:
                        description: Ship to residential indicator.
                        type: boolean
                        default: false
                      additionalHandlingIndicator:
                        description: Additional handling indicator. May be set by NRF during rating.
                        type: boolean
                        default: false
                      downgradeServiceCode:
                        type: 
                          - string
                          - "null"
                        description: Downgraded service code.
                        minLength: 3
                        maxLength: 3
                        example: "003"
                      oversizeCode:
                        type: 
                          - string
                          - "null"
                        description: Oversize indicator. May be set by NRF during rating LPK.
                        minLength: 3
                        maxLength: 3
                      serviceCode:
                        type: string
                        description: Original service code. Refer to the Service Codes document for more details.
                        minLength: 3
                        maxLength: 3
                        example: "012"
                      serviceDesc:
                        type: string
                        description: Original service description. Refer to the Service Codes document for more details.
                        example: "UPS 3 DAY SELECT"
                      packageWeight:
                        type: string
                        description: Package weight. May also be changed by NRF during rating to billable weight.
                        maxLength: 10
                        example: "4.0"
                      packageWeightUOM:
                        type: string
                        description: Package weight unit of measure
                        maxLength: 3
                        minLength: 3
                        anyOf:
                          - const: LBS
                            title: Pounds
                          - const: KGS
                          - title: Kilograms
                      packagingType:
                        description: Packaging Type code. Refer to the Packaging Types document for more details.
                        type: string
                        maxLength: 3
                        example: "03"
                      shipperName:
                        type: string
                        description: Name of the shipper Applicable for  Intercept options FD,AA,UR etc.
                        example: ACME Inc.
                      displayShipperPaidInterceptCharges:
                        type: boolean
                        description: Indicates if a message should be displayed that the shipper has paid for the charges related to the intercept
                        default: false
                      shipperPaidInterceptCharges:
                        type: boolean
                        description: Indicates if charges related to the intercept are paid by the shipper.
                        default: false
                      shipperPaidTransportationCharges:
                        type: boolean
                        description: Indicates if charges related to transportation are paid by the shipper. Applicable only for Redirect to Another Address.
                        default: false
                      displayShipperPaidTransportationCharges:
                        type: boolean
                        description: |
                          Indicates if a message should be displayed that the shipper has paid for the charges related to transportation. 
                          Applicable only for Redirect to Another Address and Redirect to UPS Location intercepts. TRUE - display a message
                          that the shipper has paid the transportation charges.
                        default: false
                      chargesPaidByThirdPartyShipper:
                        type: boolean
                        description: |
                          Indicates if the charges were paid by a third-party shipper and must be supplied by trusted end clients only.

                          | CODE  | DESCRIPTION                                     |
                          | :--:  | :--                                             |
                          | TRUE  | the charges were paid by a third-party shipper. |
                          | FALSE | the charges were paid by the original shipper.  |
                        default: false
                      taxes:
                        type: array
                        minItems: 1
                        description: Taxes for EU/Mexico/Canada  country  movement. This array is unbounded.
                        items:
                          type: object
                          properties:
                            tax:
                              type: string
                              description: Identifies the tax type
                            taxAmount:
                              description: Identifies the tax amount for a particular tax type
                              $ref: "#/components/schemas/DeliveryInterceptChargeV2"
                      totalTax:
                        description: Taxes for EU/Mexico/Canada country movement . sum of tax amounts present in the taxes field.
                        $ref: "#/components/schemas/DeliveryInterceptChargeV2"
                      preTaxTotalCharge:
                        description: Pre-tax total Charge. Sum of accessorial charges and transportation charges  excluding taxes.
                        $ref: "#/components/schemas/DeliveryInterceptChargeV2"
                      taxDisclaimerIndicator:
                        type: string
                        description: Indicates if a tax disclaimer message should be displayed.
                        oneOf:
                          - const: NTC
                            title: NO Tax calculation
                          - const: NTA
                            title: NO Tax applicable
                          - const: TA
                            title: Taxes applicable
                          - const: TE
                            title: Taxes Exempt
                          - const: TU
                            title: Taxes Undetermined
                      interceptChargeDetail:
                        type: array
                        description: Unbounded array of intercept charges details, available only for intercept option AL
                        items:
                          $ref: "#/components/schemas/DeliveryInterceptChargeDetailV2"
                    additionalProperties: false
                    required:
                      - trackingNumber
                      - accessorialCharge
                      - interceptCharge
                      - transportationCharge
                      - totalCharge
                      - chargeCurrency
                      - estDeliveryDate
                      - serviceCode
                      - serviceDesc
                      - packageWeight
                      - packageWeightUOM
                      - packagingType
                      - shipperName
                      - preTaxTotalCharge
                      - taxDisclaimerIndicator
              additionalProperties: true
              required: 
                - chargeInfo
      additionalProperties: false
      required:
        - response
    DeliveryInterceptChargeDetailV2:
      type: object
      properties:
        accessorialCharge:
          type: string
          description: Includes sum of all accessorial charges (i.e. including addition handling, intercept)
          minLength: 4
          maxLength: 20
          example: "20.00"
        interceptCharge:
          type: string
          description: The flat rate charge specific for the intercept
          minLength: 4
          maxLength: 20
          example: "20.00"
        transportationCharge:
          type: string
          description: Transportation Charge Only for Alternate Address (Redirect, Deliver to Another Address)
          minLength: 4
          maxLength: 20
          example: "20.00"
        totalCharge:
          type: string
          description: totalCharge
          minLength: 4
          maxLength: 20
          example: "20.00"
        interceptOption:
          type: string
          description: Intercept name of the charges
          example: AA
        displayShipperPaidInterceptCharges:
          type: boolean
          description: Indicates if a message should be displayed that the shipper has paid for the charges related to the intercept.
          default: false
        shipperPaidInterceptCharges:
          type: boolean
          description: Indicates if charges related to the intercept are paid by the shipper.
          default: false
          example: false
        successful: 
          type: boolean
        currencyCode:
          type: string
          description: This will be used when authorizing  credit cards or PayPal accounts
          minLength: 3
          maxLength: 3
          example: USD
      required:
       - currencyCode
    DeliveryInterceptEligibilityOptionsResponseV2:
      type: object
      description: Response schema for Delivery Change Eligibility request
      properties:
        response:
          allOf:
            - $ref: "#/components/schemas/DeliveryInterceptCommonResponseV2"
            - type: object
              properties:
                commonEligibilityMap:
                  description: Object that contains eligibility values for each intercept feature
                  properties:
                    interceptFeature:
                      type: string
                      description: The specific delivery change options eligibilty is being returned for
                      oneOf: 
                        - const: SDWC
                          title: Same Day Will Call
                        - const: RTS
                          title: Return To Sender
                        - const: WC
                          title: Will Call
                        - const: FD
                          title: Future Delivery
                        - const: RD
                          title: Reschedule Delivery
                    eligibilityValue:
                      type: object
                      description: Object that holds the eligibility values for a particular delivery change
                      properties:
                        createEligibility:
                          $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2'
                        modifyEligibility:
                          $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2'
                        cancelEligibility:
                          $ref: '#/components/schemas/DeliveryInterceptEligibilityValueV2'
                        dateOptionsforFutureDelivery:
                          type: array
                          description: Unbounded array of future delivery dates. Available only for future delivery intercept option
                          minItems: 1
                          items: 
                            type: object
                            description: Object that holds the future delivery dates user is eligible for
                            properties:
                              date:
                                $ref: "#/components/schemas/DeliveryInterceptDateV2"
                              dayOfWeekText:
                                type: string
                                description: Provides the day of the week 
                                enum:
                                  - Sunday
                                  - Monday
                                  - Tuesday
                                  - Wednesday
                                  - Thursday
                                  - Friday
                              dayOfWeekNumber:
                                type: string
                                description: Provides the number of the day of the week
                                oneOf:
                                  - const: "01"
                                    title: Sunday
                                  - const: "02"
                                    title: Monday
                                  - const: "03"
                                    title: Tuesday
                                  - const: "04"
                                    title: Wednesday
                                  - const: "05"
                                    title: Thursday
                                  - const: "06"
                                    title: Friday
                                  - const: "07"
                                    title: Saturday
                        reasonOptionsForRTS:
                          type: array
                          description: Array of reasons why the item is being returned. Available only for RTS intercept option
                          minItems: 1
                          maxItems: 9
                          items: 
                            type: object
                            description: Object that holds the return to sender reasons the user is eligible for
                            properties:
                              id: 
                                type: string
                                description: Provides the reason code for RTS
                                oneOf:
                                  - const: AM
                                    title: CANCELLED
                                    description: RECEIVER REFUSED, CANCELLED ORDER
                                  - const: AN
                                    title: DUPLICATE
                                    description: RECEIVER REFUSED, DUPLICATE ORDER
                                  - const: AQ
                                    title: NO C.O.D.'S
                                    description: RECEIVER REFUSED, NO C.O.D.'S ACCEPTED
                                  - const: AR
                                    title: EXPENSIVE
                                    description: RECEIVER REFUSED, TOO EXPENSIVE
                                  - const: AS
                                    title: LATE
                                    description: RECEIVER REFUSED, SHIPPED TOO LATE
                                  - const: FA
                                    title: BAD ADDRESS
                                    description: UNABLE TO RESOLVE INCORRECT ADDRESS
                                  - const: KR
                                    title: REFUSED
                                    description: RECEIVER DID NOT WANT, REFUSED DELIVERY
                                  - const: KS
                                    title: NOT ORDERED
                                    description: RECEIVER DID NOT ORDER, REFUSED
                                  - const: KV
                                    title: OTHER
                                    description: OTHER NON-DELIVERY
                              value: 
                                type: string
                                description: Provides the reason text for RTS
                                example: COD Will Not Be Accepted
                            additionalProperties: false
                            required:
                              - id
                              - value
                      additionalProperties: false
                      required:
                        - createEligibility
                        - modifyEligibility
                        - cancelEligibility
              additionalProperties: true
              required:
                - commonEligibilityMap
      additionalProperties: false
      required:
        - response
    DeliveryInterceptRequestV2:
      type: object
      properties:
        requestType:
          description: The request type of the intercept being performed
          type: string
          minLength: 2
          maxLength: 3
          oneOf:
            - const: WC
              title: WILL CALL
            - const: SC
              title: SAME DAY WILL CALL
            - const: FD
              title: FUTURE DELIVERY 
            - const: AA
              title: ALTERNATE ADDRES
            - const: RS
              title: RETURN TO SENDER
        requesterContactInfo:
          type: object
          properties:
            name:
              type: string
              description: Contact Name
              minLength: 1
              maxLength: 30
              example: The UPS Store
            telephone:
              type: string
              description: Contact phone number
              minLength: 1
              maxLength: 14
              pattern: ^(\+)[0-9]{1,13}$
              example: "+14107495070"
            phoneExt:
              type: string
              description: Contact phone extension
              minLength: 2
              maxLength: 4
              pattern: ^(\+)[0-9]{1,3}$
              example: "+12"
            emailAddress:
              type: string
              description: Contact email address
              minLength: 1
              maxLength: 50
              pattern: ^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$
              example: aups@ups.com
            altTelephone:
              type: string
              description: Alternate Contact phone number
              minLength: 1
              maxLength: 14
              pattern: ^(\+)[0-9]{1,13}$
              example: "+19886432748"
            altPhoneExt:
              type: string
              description: Alternate Contact phone extension
              minLength: 2
              maxLength: 4
              pattern: ^(\+)[0-9]{1,3}$
              example: "+12"
            displayPhoneNumber:
              type: boolean
              description: Indicates if the phone number of a UAP can be displayed to external clients.
              default: false
          additionalProperties: true
          required: 
            - name
            - telephone
        reasonForReturn:
          type: string
          description: Reason for return code. Required only for RS intercept type.
          oneOf:
            - const: AM
              title: CANCELLED
              description: RECEIVER REFUSED, CANCELLED ORDER
            - const: AN
              title: DUPLICATE
              description: RECEIVER REFUSED, DUPLICATE ORDER
            - const: AQ
              title: NO C.O.D.'S
              description: RECEIVER REFUSED, NO C.O.D.'S ACCEPTED
            - const: AR
              title: EXPENSIVE
              description: RECEIVER REFUSED, TOO EXPENSIVE
            - const: AS
              title: LATE
              description: RECEIVER REFUSED, SHIPPED TOO LATE
            - const: FA
              title: BAD ADDRESS
              description: UNABLE TO RESOLVE INCORRECT ADDRESS
            - const: KR
              title: REFUSED
              description: RECEIVER DID NOT WANT, REFUSED DELIVERY
            - const: KS
              title: NOT ORDERED
              description: RECEIVER DID NOT ORDER, REFUSED
            - const: KV
              title: OTHER
              description: OTHER NON-DELIVERY
        deliveryDate:
          type: string
          description: Original scheduled date of delivery. Required olny for FD intercept type.
          minLength: 8
          maxLength: 8
          pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$
          example: "20190223"
        specialInstructions:
          type:
            - string
            - "null"
          description: Special Instructions sent to the driver. Available only to AA intercept type
          minLength: 1
          maxLength: 254
          example: Handle With Care
        newDeliveryAddress:
          type: object
          description: New delivery address. Required olny for AA intercept type.
          properties:
            addressNickName:
              type: string
              description: The nickname string assigned to the address entry. Required only for AA intercept type.
              minLength: 2
              maxLength: 20
              example: John's woek address
            addressInfo:
              type: object
              description: Address object, include line1, line2, line 3 state, postal code and country code. Required when processing a request if imsAddressIdentifier is not present.  
              properties:
                addressLine1:
                  type: string
                  description: Line 1 of the street address. Required if streetAddressParsedIndicator is FALSE; Required when setting Billing Address.
                  minLength: 1
                  maxLength: 50
                  example: 12911 FORK RD
                addressLine2:
                  type: string
                  description: Line 2 of the street address
                  minLength: 1
                  maxLength: 35
                  example: Ste 8
                addressLine3:
                  description: Line 3 of the street
                  minLength: 1
                  maxLength: 35
                  type: string
                city:
                  type: string
                  description: The city name of the address
                  minLength: 1
                  maxLength: 30
                  example: Baldwin
                state:
                  type: string
                  description: The state code of the address
                  minLength: 2
                  maxLength: 2
                  pattern: ^[A-Z]{2}$
                  example: MD
                postalCode:
                  type: string
                  description: The postal code of the address (should be provided for postal countries)
                  minLength: 5
                  maxLength: 16
                  pattern: ^\d{5}(?:[-\s]\d{4})?$
                  examples:
                    - "21013"
                    - "21093-1234"
                countryCode:
                  type: string
                  description: The ISO country code of the address
                  maxLength: 2
                  minLength: 2
                  pattern: ^[A-Z]{2}$
                  example: US
              additionalProperties: true
              required: 
                - addressLine1
                - city
                - state
                - postalCode
                - countryCode
            nameOrCompanyName:
              type: string
              description: The name of the company or person customer address.(Required When calling submitAddress() API  Empty String  can be passed)          
              example: ACME Inc.
            contactName:
              type: string
              description: The contact name at the customer address.
              example: Robert
            phoneNumber:
              type: string
              description: The contact phone number at the customer address.(Required When calling submitAddress() API  Empty String  can be passed)
              maxLength: 14
              pattern: '^(\+)[0-9]{1,13}$'
              example: "+19886222523"
            phoneExt:
              type: string
              description: The phone extension number at the customer address.(Required When calling submitAddress() API  Empty String  can be passed)
              pattern: '^(\+)[0-9]{1,3}$'
              example: "+244"
            emailAddress:
              type: string
              description: Email Address at the customer address.
              pattern: '^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}$'
              example: aups@ups.com
      additionalProperties: false
      required: 
        - requesterContactInfo
        - specialInstructions
    DeliveryInterceptResponseV2:
      type: object
      description: ""
      properties:
        transactionId:
          type: string
          description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes.
          minLength: 1
          maxLength: 14
          example: "ASR1212"
        statusCode:
          type: string
          description: API response status code, Internal code regarding the success or failure of the operation
          minLength: 3
          maxLength: 3
          example: "000"
        statusMsg:
          type: string
          description: API response status message, Internal message regarding the success or failure of the operation
          minLength: 1
          maxLength: 80
          example: "Success"
        subStatusCode:
          type: string
          description: A new status code for adding granularity to the existing status code structure
          example: "7103"
        success:
          type: boolean
          description: Indicates if the transaction is considered successful.
          default: false
        errors:
          type: 
            - array
            - "null"
          description: Unbounded array of error objects
          items:
            $ref: "#/components/schemas/DeliveryInterceptSuccessErrorV2"
        warnings:
          type: object
          description: A map containing warning codes and descriptions as key/value pairs.
          additionalProperties:
            type: string
      additionalProperties: false
      required: 
        - transactionId
        - statusCode
        - success
    DeliveryInterceptCommonResponseV2:
      type: object
      description: Object to contain properties common to all responses
      properties:
        transactionId:
          type: string
          description: A unique value that will be used to identify the transaction for logging and troubleshooting purposes
          minLength: 1
          maxLength: 14
          example: ASR1212
        statusCode:
          description: API response status code, Internal code regarding the success or failure of the operation
          maxLength: 3
          minLength: 3
          example: "000"
          type: string
        statusMsg:
          type: string
          description: API response status message, Internal message regarding the success or failure of the operation
          minLength: 1
          maxLength: 80
          example: Success
        subStatusCode:
          type: string
          description: A new status code for adding granularity to the existing status code structure
          example: "7103"
        success:
          type: boolean
          description: Indicates if the transaction is considered successful.
          default: false
        warnings:
          type: 
            - object
            - "null"
          description: A map containing warning codes and descriptions as key/value pairs
        errors:
          type: 
            - array
            - "null"
          description: Unbounded array of error objects
          items:
            $ref: "#/components/schemas/DeliveryInterceptSuccessErrorV2"
      additionalProperties: true
      required:
        - transactionId
        - statusCode
    DeliveryInterceptAddressV2:
      type: object
      properties:
        addressLine1:
          type: string
          description: Line 1 of the street address. Required if streetAddressParsedIndicator is FALSE; Required when setting Billing Address.
          minLength: 1
          maxLength: 50
          example: 12911 FORK RD
        addressLine2:
          type: string
          description: Line 2 of the street address
          minLength: 1
          maxLength: 35
          example: Ste 8
        addressLine3:
          description: Line 3 of the street
          minLength: 1
          maxLength: 35
          type: string
        city:
          type: string
          description: The city name of the address
          minLength: 1
          maxLength: 30
          example: Baldwin
        state:
          type: string
          description: The state code of the address
          minLength: 2
          maxLength: 2
          pattern: ^[A-Z]{2}$
          example: MD
        postalCode:
          type: string
          description: The postal code of the address (should be provided for postal countries)
          minLength: 5
          maxLength: 16
          pattern: ^\d{5}(?:[-\s]\d{4})?$
          examples:
            - "21013"
            - "21093-1234"
        countryCode:
          type: string
          description: The ISO country code of the address
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          example: US
      additionalProperties: true
      required: 
        - addressLine1
        - city
        - state
        - postalCode
        - countryCode
    DeliveryInterceptAdditionalAddressV2:
      type: object
      properties:
        buildingFloor:
          type: string
          example: "2"
        publicLocationId:
          type: string
          example: U88498244
        firstName:
          type: string
          description: Required when the user choses to enter a new card providing the Billing address in CreditCardInformation .
          example: HUNTLY
        lastName:
          type: string
          description: Required when the user choses to enter a new card providing the Billing address in CreditCardInformation object.
          example: OAK
        fullName:
          type: string
          description: Full person name
          example: HUNTLY OAK
        phoneNumber:
          type: string
          maxLength: 17
          pattern: '^(\+)[0-9]{1,16}$'
          example: "+19886222564"
      additionalProperties: true
      required:
        - firstName
        - phoneNumber
    DeliveryInterceptChargeV2:
      type: string
      maxLength: 20
      pattern: ^\d{1,17}?\.\d{2}?$
      format: currency
      example: "5.00"
    DeliveryInterceptDateV2:
      type: string
      description: Provides the future dates available for delivery
      pattern: ^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$
      example: "20250110"
    DeliveryInterceptEligibilityValueV2:
      type: string
      enum: 
        - ELIGIBLE
        - NOT_ELIGIBLE
        - UNKNOWN
    DeliveryInterceptTrackingNumberV2:
      type: string
      minLength: 18
      maxLength: 18
      pattern: ^(1Z)[A-Z0-9]{16}$
      example: 1ZA2F8810719086435
    DeliveryInterceptErrorResponseV2:
      type: object
      required: 
        - response
      properties:
        response:
          type: object
          required: 
            - statusCode
            - errors
          properties:
            transactionId:
              description: |-
                A unique value that will be used to identify the transaction for logging and troubleshooting purposes.
              maxLength: 14
              minLength: 1
              example: "ASR1212"
              type: string
            statusCode:
              description: |-
                API response status code, Internal code regarding the success or failure of the operation
              maxLength: 4
              minLength: 1
              example: "0006"
              type: string
            subStatusCode:
              description: |-
                A new status code for adding granularity to the existing status code structure
              type: string
            success:
              description: Indicates if the transaction is considered successful.
              default: false
              type: boolean
            errors:
              type: array
              description: |
                Will only be returned if the HTTP statusCode isn't '200'(success). A list of one or more validation errors. On the API version
                v3 the first element of the errors array contains the statusCode and scoring statusMessage field. This array is unbounded.
              items:
                type: object
                properties:
                  code:
                    description: |-
                      the code of the error
                    maxLength: 4
                    minLength: 1
                    example: "0006"
                    type: string
                  message:
                    description: |-
                      the message of the error
                    maxLength: 120
                    minLength: 1
                    example: "Failure to check eligibility through Tracking service"
                    type: string
    DeliveryInterceptSuccessErrorV2:
      type: object
      description: | 
        Container to hold details related to an individual error. Will only be returned if the HTTP statusCode isn't '200'(success).
        On the API version v3 the first element of the errors array contains the statusCode and scoring statusMessage field. 
      properties:
        errorCode:
          type: string
          description: The code of the error
          minLength: 1
          maxLength: 4
          example: "1201"
        errorMessage:
          type: string
          description: The message of the error
          minLength: 1
          maxLength: 120
          example: TransactionSrc
        errorSource:
          type: string
          description: The source of the error
      additionalProperties: false
      required: 
        - errorCode
        - errorMessage