openapi: 3.0.3
info:
  title: Locator
  version: ''
  description: |
  
    The Locator API allows you to find UPS locations - such as drop-off points, retail locations, and UPS access points (third-party retail locations that offer UPS package drop-off, or delivery services). The API provides capabilities to search by location, services offered, program types, and related criteria. You can also retrieve hours of operation, location details, and additional UPS services offered at specific locations.
    # Reference
    - <a href="https://developer.ups.com/api/reference/locator/business-rules" target="_blank" rel="noopener">Business Rules</a>
    - <a href="https://developer.ups.com/api/reference/locator/appendix" target="_blank" rel="noopener">Appendix</a>
    - <a href="https://developer.ups.com/api/reference/locator/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-8637d9f1-5e40-4a1e-aa95-82376e268638?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-8637d9f1-5e40-4a1e-aa95-82376e268638%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>
servers:
  - url: https://wwwcie.ups.com/api
    description: Customer Integration Environment
  - url: https://onlinetools.ups.com/api
    description: Production
paths:
  "/locations/{version}/search/availabilities/{reqOption}":
    post:
      summary: Locator
      tags:
        - Locator
      security:
        - OAuth2: []
      description: The Locator API allows you to find UPS locations - such as drop-off points, retail locations, and UPS access points (third-party retail locations that offer UPS package drop-off, or delivery services). The API provides capabilities to search by location, services offered, program types, and related criteria. You can also retrieve hours of operation, location details, and additional UPS services offered at specific locations.
      operationId: Locator
      parameters:
      - in: header
        name: transId
        schema:
          type: string
        description: An identifier unique to the request. Length 32
      - in: header
        name: transactionSrc
        schema:
          type: string
          default: testing
        description: An identifier of the client/source application that is making
          the request.Length 512
      - in: path
        name: version
        schema:
          type: string
          default: v3
        description: |
            Version of API

            Valid values:
            - v3
        required: true
      - in: path
        name: reqOption
        schema:
          type: string
          minLength: 1
          maxLength: 4
        description: "Indicates the type of request.\nValid values:\n1-Locations (Drop
          Locations and Will call locations)\n8-All available Additional Services\n16-All
          available Program Types\n24-All available Additional Services and Program
          types\n32-All available Retail Locations\n40-All available Retail Locations
          and Additional Services \n48-All available Retail Locations and Program
          Types \n56-All available Retail Locations, Additional Services and Program
          Types \n64-Search for UPS Access Point Locations.  "
        required: true
      - in: query
        name: Locale
        schema:
          type: string
          default: en_US
        description: Locale of request
      requestBody:
        description: Generate sample code for popular API requests by selecting an
          example below. To view a full sample request and response, first click "Authorize"
          and enter your application credentials, then populate the required parameters
          above and click "Try it out".
        required: true
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LOCATORRequestWrapper"
            examples:
              json:
                summary: A sample JSON request (Standard Example)
                value:
                  LocatorRequest:
                    Request:
                      TransactionReference:
                        CustomerContext: ''
                      RequestAction: Locator
                    OriginAddress:
                      AddressKeyFormat:
                        AddressLine: 123 Fork rd
                        PoliticalDivision2: Atlanta
                        PoliticalDivision1: PE
                        PostcodePrimaryLow: '30005'
                        PostcodeExtendedLow: '30005'
                        CountryCode: US
                      MaximumListSize: '10'
                    Translate:
                      LanguageCode: ENG
                      Locale: en_US
                    UnitOfMeasurement:
                      Code: MI
                    LocationSearchCriteria:
                      SearchOption:
                      - OptionType:
                          Code: '01'
                        OptionCode:
                          Code: '001'
                        Relation:
                          Code: '01'
                      - OptionType:
                          Code: '01'
                        OptionCode:
                        - Code: '001'
                        - Code: '001'
                        Relation:
                          Code: '01'
                      MaximumListSize: '10'
                      SearchRadius: '75'
                      ServiceSearch:
                        Time: '1030'
                        ServiceCode:
                          Code: '01'
                    SortCriteria:
                      SortType: '01'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/LOCATORResponseWrapper"
        '400':
            description: Invalid Request
            content:
                application/json:
                  schema:
                    "$ref": "#/components/schemas/ErrorResponse"
        '401':
            description: Unauthorized Request
            content:
                application/json:
                  schema:
                    "$ref": "#/components/schemas/ErrorResponse"
        '403':
            description: Blocked Merchant
            content:
                application/json:
                  schema:
                    "$ref": "#/components/schemas/ErrorResponse"
        '429':
            description: Rate Limit Exceeded
            content:
                application/json:
                  schema:
                    "$ref": "#/components/schemas/ErrorResponse"
  "/locations/{deprecatedVersion}/search/availabilities/{reqOption}":
    post:
      deprecated: true
      summary: Locator
      tags:
        - Locator
      security:
        - OAuth2: []
      description: The Locator API allows you to find UPS locations - such as drop-off points, retail locations, and UPS access points (third-party retail locations that offer UPS package drop-off, or delivery services). The API provides capabilities to search by location, services offered, program types, and related criteria. You can also retrieve hours of operation, location details, and additional UPS services offered at specific locations.
      operationId: Deprecated Locator
      parameters:
      - in: header
        name: transId
        schema:
          type: string
        description: An identifier unique to the request. Length 32
      - in: header
        name: transactionSrc
        schema:
          type: string
          default: testing
        description: An identifier of the client/source application that is making
          the request.Length 512
      - in: path
        name: deprecatedVersion
        schema:
          type: string
          default: v1
        description: |
            Version of API

            Valid values:
            - v1
        required: true
      - in: path
        name: reqOption
        schema:
          type: string
          minLength: 1
          maxLength: 4
        description: "Indicates the type of request.\nValid values:\n1-Locations (Drop
          Locations and Will call locations)\n8-All available Additional Services\n16-All
          available Program Types\n24-All available Additional Services and Program
          types\n32-All available Retail Locations\n40-All available Retail Locations
          and Additional Services \n48-All available Retail Locations and Program
          Types \n56-All available Retail Locations, Additional Services and Program
          Types \n64-Search for UPS Access Point Locations.  "
        required: true
      - in: query
        name: Locale
        schema:
          type: string
          default: en_US
        description: Locale of request
      requestBody:
        description: Generate sample code for popular API requests by selecting an
          example below. To view a full sample request and response, first click "Authorize"
          and enter your application credentials, then populate the required parameters
          above and click "Try it out".
        required: true
        content:
          application/json:
            schema:
              "$ref": "#/components/schemas/LOCATORRequestWrapper"
            examples:
              json:
                summary: A sample JSON request (Standard Example)
                value:
                  LocatorRequest:
                    Request:
                      TransactionReference:
                        CustomerContext: ''
                      RequestAction: Locator
                    OriginAddress:
                      AddressKeyFormat:
                        AddressLine: 123 Fork rd
                        PoliticalDivision2: Atlanta
                        PoliticalDivision1: PE
                        PostcodePrimaryLow: '30005'
                        PostcodeExtendedLow: '30005'
                        CountryCode: US
                      MaximumListSize: '10'
                    Translate:
                      LanguageCode: ENG
                      Locale: en_US
                    UnitOfMeasurement:
                      Code: MI
                    LocationSearchCriteria:
                      SearchOption:
                      - OptionType:
                          Code: '01'
                        OptionCode:
                          Code: '001'
                        Relation:
                          Code: '01'
                      - OptionType:
                          Code: '01'
                        OptionCode:
                        - Code: '001'
                        - Code: '001'
                        Relation:
                          Code: '01'
                      MaximumListSize: '10'
                      SearchRadius: '75'
                      ServiceSearch:
                        Time: '1030'
                        ServiceCode:
                          Code: '01'
                    SortCriteria:
                      SortType: '01'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                "$ref": "#/components/schemas/LOCATORResponseWrapper"
        '400':
            description: Invalid Request
            content:
                application/json:
                  schema:
                    "$ref": "#/components/schemas/ErrorResponse"
        '401':
            description: Unauthorized Request
            content:
                application/json:
                  schema:
                    "$ref": "#/components/schemas/ErrorResponse"
        '403':
            description: Blocked Merchant
            content:
                application/json:
                  schema:
                    "$ref": "#/components/schemas/ErrorResponse"
        '429':
            description: Rate Limit Exceeded
            content:
                application/json:
                  schema:
                    "$ref": "#/components/schemas/ErrorResponse"
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://wwwcie.ups.com/security/v1/oauth/token
          scopes: {}
  schemas:
    LOCATORRequestWrapper:
      xml:
        name: LocatorRequest
      description: 'N/A  '
      maximum: 1
      type: object
      required:
      - LocatorRequest
      properties:
        LocatorRequest:
          "$ref": "#/components/schemas/LocatorRequest"
    LOCATORResponseWrapper:
      xml:
        name: LocatorResponse
      description: 'N/A  '
      maximum: 1
      type: object
      required:
      - LocatorResponse
      properties:
        LocatorResponse:
          "$ref": "#/components/schemas/LocatorResponse"
    LocatorRequest:
      type: object
      required:
      - Request
      - OriginAddress
      - Translate
      properties:
        Request:
          "$ref": "#/components/schemas/LocatorRequest_Request"
        OriginAddress:
          "$ref": "#/components/schemas/LocatorRequest_OriginAddress"
        Translate:
          "$ref": "#/components/schemas/LocatorRequest_Translate"
        UnitOfMeasurement:
          "$ref": "#/components/schemas/LocatorRequest_UnitOfMeasurement"
        LocationID:
          description: Location ID is the identification number of the UPS affiliated
            location.
          type: array
          items:
            type: string
          minLength: 1
          maxLength: 10
        LocationSearchCriteria:
          "$ref": "#/components/schemas/LocatorRequest_LocationSearchCriteria"
        SortCriteria:
          "$ref": "#/components/schemas/LocatorRequest_SortCriteria"
        AllowAllConfidenceLevels:
          description: Indicator to allow confidence level in search.
          type: string
          maximum: 1
        SearchOptionCode:
          description: "Valid values: \n01-Proximity Search Details\n02-Address Search
            Details\n03-Proximity Search Summary\n04-Address Search Summary\n05-Freight
            Will Call Search. \nEither OptionType 03 or 04 is required."
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        ServiceGeoUnit:
          "$ref": "#/components/schemas/LocatorRequest_ServiceGeoUnit"
        FreightIndicator:
          description: FreightIndicator. Required for Freight Location Search.
          type: string
          maximum: 1
      xml:
        name: LocatorRequest
      maximum: 1
      description: N/A
    LocatorRequest_Request:
      type: object
      properties:
        TransactionReference:
          "$ref": "#/components/schemas/Request_TransactionReference"
        RequestAction:
          description: "Indicates the action to be taken by the XML service. \nThe
            only valid value is 'Locator'."
          maximum: 1
          type: string
          minLength: 13
          maxLength: 13
      xml:
        name: Request
      maximum: 1
      required:
      - RequestAction
      description: N/A
    Request_TransactionReference:
      type: object
      maximum: 1
      minLength: 1
      maxLength: 512
      properties:
        CustomerContext:
          description: The client uses CustomerContext to synchronize request/response
            pairs. The client establishes CustomerContext, which can contain any information
            client want, as long as it is valid XML; it is echoed back by the server
          type: string
      xml:
        name: TransactionReference
      description: TransactionReference identifies transactions between client and
        server.
    LocatorRequest_OriginAddress:
      type: object
      properties:
        Geocode:
          "$ref": "#/components/schemas/OriginAddress_Geocode"
        AddressKeyFormat:
          "$ref": "#/components/schemas/OriginAddress_AddressKeyFormat"
        MaximumListSize:
          description: "If present, indicates the maximum number of locations the
            client wishes to receive in an address candidate response where the provided
            origin information is insufficient to accurately establish location. \n\nValid
            values: 1-50, default 10"
          maximum: 1
          type: string
          minLength: 1
          maxLength: 2
      xml:
        name: OriginAddress
      required:
      - AddressKeyFormat
      maximum: 1
      description: Container for origin address information.
    OriginAddress_Geocode:
      type: object
      maximum: 1
      required:
      - Latitude
      - Longitude
      properties:
        Latitude:
          description: The latitude of the origin address or the center point of the area code.
          maximum: 1
          type: string
          minLength: 15
          maxLength: 15
        Longitude:
          description: The longitude of the origin address or the center point of the area code.
          maximum: 1
          type: string
          minLength: 15
          maxLength: 15
      xml:
        name: Geocode
      description: Geocode is the latitude and longitude of the origin address.
    OriginAddress_AddressKeyFormat:
      type: object
      maximum: 1
      properties:
        ConsigneeName:
          description: Name. Not relevant for this tool
          type: string
          minLength: 1
          maxLength: 40
          maximum: 1
        AddressLine:
          description: Address Line Information. The user may submit street level address information or provide Intersection information.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 100
        AddressLine2:
          description: Additional Address Line Information.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 64
        AddressLine3:
          description: Additional Address Line Information.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 64
        PoliticalDivision3:
          description: Barrio or other sub-division of City
          maximum: 1
          type: string
          minLength: 1
          maxLength: 35
        PoliticalDivision2:
          description: City or Town.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        PoliticalDivision1:
          description: State or province
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        PostcodePrimaryLow:
          description: Main postal code. Required if the user does not submit the City, State/Province address combination.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 10
        PostcodeExtendedLow:
          description: 4 Digit postal code extension. Valid for US only.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 10
        CountryCode:
          description: Two-character country or territory abbreviation
          maximum: 1
          type: string
          minLength: 1
          maxLength: 2
        SingleLineAddress:
          description: |
            Single line search information. Can contain values of origin address in a single line. Will override other origin address information.

            Conditionally Required for Non-Postal Code Countries. Applicable Country Ireland (IE)

            SingleLineAddress used for the lookup

            SingleLineAddress (Format - CSV) (\"Values:\" + postalCode + city + state + address + landmark	+ phoneNumber)
          type: string
          maximum: 1
      xml:
        name: AddressKeyFormat
      required:
      - PoliticalDivision1
      - AddressLine
      - PostcodePrimaryLow
      - PoliticalDivision2
      - CountryCode
      description: "Contains all of the basic information about the origin such as:
        Address Lines, City, State/Province, Postal Code and Country or Territory
        Code. \nThe element CountryCode is required."
    LocatorRequest_Translate:
      type: object
      maximum: 1
      properties:
        Locale:
          description: "Locale is the 5 digit combination of 2 character language
            code and 2 character country or territory code separated by an underscore
            ('_') character. Will be used to determine what language the response
            will be sent in. \nDefault value is: en_US. \nExamples are: fr_CA, es_MX."
          maximum: 1
          type: string
          minLength: 5
          maxLength: 5
      xml:
        name: Translate
      description: Contains the locale information for the request.
    LocatorRequest_UnitOfMeasurement:
      type: object
      maximum: 1
      required:
      - Code
      properties:
        Code:
          description: |
            Valid values are:

            - MI-Miles
            - KM-Kilometers
          type: string
      xml:
        name: UnitOfMeasurement
      description: Distance unit of measurement. This is required for location requests
        (request option 1).
    LocatorRequest_LocationSearchCriteria:
      type: object
      properties:
        SearchOption:
          type: array
          items:
            "$ref": "#/components/schemas/LocationSearchCriteria_SearchOption"
        MaximumListSize:
          description: If present, indicates the maximum number of locations the client
            wishes to receive in response; ranges from 1 to 50 with a default value
            of 5.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 2
        SearchRadius:
          description: "Defines the maximum radius the user wishes to search for a
            UPS location. If the user does not specify, the default value is 100 miles.
            Whole numbers only. \n\nValid values are:\n5-100 for UnitOfMeasure MI\n5-150
            for UnitOfMesaure KM"
          maximum: 1
          type: string
          minLength: 1
          maxLength: 3
        ServiceSearch:
          "$ref": "#/components/schemas/LocationSearchCriteria_ServiceSearch"
        FreightWillCallSearch:
          "$ref": "#/components/schemas/LocationSearchCriteria_FreightWillCallSearch"
        AccessPointSearch:
          "$ref": "#/components/schemas/LocationSearchCriteria_AccessPointSearch"
        OpenTimeCriteria:
          "$ref": "#/components/schemas/LocationSearchCriteria_OpenTimeCriteria"
        BrexitFilter:
          description: Brexit Filter. Applicable for country code GB; Pass the PostalCode
            for the address in the location search if Brexit functionality is desired.
            UAPs with postal code starts with BT returned when brexit filter starts
            with BT, else UAPs returned with non BT postal code. Applicable for UAP
            and Proximal building search.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 10
      xml:
        name: LocationSearchCriteria
      maximum: 1
      description: "The Location search criteria container allows the user to further
        define the basis to which they wish to receive the UPS locations. \nOnly relevant
        when the user requests a Location search (request option 1)."
    LocationSearchCriteria_SearchOption:
      type: object
      required:
      - OptionCode
      - OptionType
      properties:
        OptionType:
          "$ref": "#/components/schemas/SearchOption_OptionType"
        OptionCode:
          type: array
          items:
            "$ref": "#/components/schemas/SearchOption_OptionCode"
        Relation:
          "$ref": "#/components/schemas/SearchOption_Relation"
      xml:
        name: SearchOption
      description: |
        SearchOption contains the information that forms the basis of the location search, It contains the criteria for search by Locations, Retail Locations, Additional Services, or Program Types.

        There should be one container for each type of search the user may wish to do. The user can specify either search by Locations or Retail Locations, but not both.

        If this container is missing, the default search would be for The UPS Store, UPS Center, UPS Drop Box, and Authorized Shipping Outlet location types.
    SearchOption_OptionType:
      type: object
      maximum: 1
      required:
      - Code
      properties:
        Code:
          description: |
            Code for Option type valid values are:

            - 01-Location
            - 02-Retail Location
            - 03-Additional Services
            - 04-Program Type
            - 05-Service Level Option.
            - 06-End Point Service Offering
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
      xml:
        name: OptionType
      description: "OptionType is a container that indicates the type of search for
        locations. There are 5 types of search. They are search by: Location, Retail
        Location, Additional Services, Program Type, and a Service Level Option. \nIf
        search criteria by Location or Retail Location is not provided the default
        search of The UPS Store, UPS Center, UPS Drop Box, and Authorized Shipping
        Outlet location types will be performed."
    SearchOption_OptionCode:
      type: object
      maximum: 1
      required:
      - Code
      properties:
        Code:
          description: |
            These codes vary by country. It is strongly recommended that clients contact UPS to retrieve the primary search indicator and the valid Location Types and Service Level Options for each country or territory.

            Refer to Location Search Option Codes in the Appendix for additional information.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 10
      xml:
        name: OptionCode
      description: "Option code contains the information of a particular Location,
        Retail Location, Additional Service, Program Type or End Point Service Offering
        depending on the option type. \nThe SearchOptions can contain one or more
        OptionCodes which forms the criteria for the location search."
    SearchOption_Relation:
      type: object
      maximum: 1
      required:
      - Code
      properties:
        Code:
          description: |
            Applicable for Additional Services and Program Types.

            Valid values:

            - 01 - And (Default)
            - 02 - Or
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
      xml:
        name: Relation
      description: "The relation container will contain the relation parameter (And/Or)
        that has to be used among multiple option codes in the location search. \n\nThis
        is only applicable to option type Additional Services and Program Types. If
        this container is not present for Additional Services and Program Types, the
        default relation of And is used."
    LocationSearchCriteria_ServiceSearch:
      type: object
      maximum: 1
      properties:
        Time:
          description: 'Scheduled Local Drop-off Time. Format: HHMM'
          maximum: 1
          type: string
          minLength: 4
          maxLength: 6
        ServiceCode:
          type: array
          items:
            "$ref": "#/components/schemas/ServiceSearch_ServiceCode"
        ServiceOptionCode:
          type: array
          items:
            "$ref": "#/components/schemas/ServiceSearch_ServiceOptionCode"
      xml:
        name: ServiceSearch
      description: Allows for users to further define the search criteria. Refer to
        the rules specified in Service Search section.
    ServiceSearch_ServiceCode:
      type: object
      maximum: 1
      required:
      - Code
      properties:
        Code:
          description: |-
            Code indicating the different services. Valid values are:
            01-Ground.
            02-Air.
            03-Express
            04-Standard
            05-International (Only avialable July 17)
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
      xml:
        name: ServiceCode
      description: |-
        Container that contains the service information such as Ground/Air.
        Required if the customer provides ServiceSearch Time.
    ServiceSearch_ServiceOptionCode:
      type: object
      maximum: 1
      required:
      - Code
      properties:
        Code:
          description: |
            Code that defines the optional service.

            Valid values:
            - 01 - Saturday pickup.

            Only valid for air service.
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
      xml:
        name: ServiceOptionCode
      description: Container for the optional service information such as Saturday
        Pick up.
    LocationSearchCriteria_FreightWillCallSearch:
      type: object
      maximum: 1
      required:
      - FreightWillCallRequestType
      - OriginOrDestination
      - FormatPostalCode
      - FacilityAddress
      properties:
        FreightWillCallRequestType:
          description: "Valid values are: \n1 - Postal Code\n2 - Delivery SLIC\n3
            - Delivery City/State.\n1: Freight Will Call Search based on Postal Code,
            this search is valid for Postal code countries. 2: Freight Will Call Search
            based on SLIC. 3: Freight Will Call Search based on City and/or State.
            This Search is valid for non-postal code Countries"
          maximum: 1
          type: string
          minLength: 1
          maxLength: 1
        FacilityAddress:
          type: array
          items:
            "$ref": "#/components/schemas/FreightWillCallSearch_FacilityAddress"
        OriginOrDestination:
          description: |-
            OriginOrDestination is required for FreightWillCallRequestType 1 and type 3 . Valid values:
            01-Origin facilities
            02-Destination facilities.
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        FormatPostalCode:
          description: |-
            FormatPostalCode would be required in the request when FreightWillCallRequestType is 1. Valid values are:
            NFR-No format requested
            FR-format requested
            FS-format and search
            NVR-No validation requested.
          maximum: 1
          type: string
          minLength: 2
          maxLength: 3
        DayOfWeekCode:
          description: "Day Of week Code. Valid Values are 1 to 7. \n1-Sunday\n2-Monday
            \n3-Tuesday \n4-Wednesday\n5-Thursday\n6-Friday\n7-Saturday."
          maximum: 1
          type: string
          minLength: 1
          maxLength: 1
      xml:
        name: FreightWillCallSearch
      description: Freight Will Call Search Container. Required if SearchOption is
        '05-Freight Will Call Search'
    FreightWillCallSearch_FacilityAddress:
      type: object
      maximum: 1
      properties:
        SLIC:
          description: Facility SLIC. Required for Freight Will call search if FreightWillCallRequestType
            is 2.
          maximum: 1
          type: string
          minLength: 5
          maxLength: 5
        AddressLine:
          description: Address line
          type: array
          items:
            type: string
          maxItems: 2
          minLength: 1
          maxLength: 64
        City:
          description: City. Required for Freight Will call search if FreightWillCallRequestType
            is 3.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        PostalCodePrimaryLow:
          description: Postal code. Required for Freight Will call search if FreightWillCallRequestType
            is 1.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 8
        PostalCodeExtendedLow:
          description: 4 Digit postal code extension. Valid for US only.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 8
        State:
          description: State. Required if FrieghtWillCallRequestType is 3 if State
            is available.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        CountryCode:
          description: Country or territory code.
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
      xml:
        name: FacilityAddress
      required:
      - CountryCode
      description: Facility Address Container
    LocationSearchCriteria_AccessPointSearch:
      type: object
      maximum: 1
      properties:
        PublicAccessPointID:
          description: The Public Access Point ID to use for UPS Access Point Search.
            Once this parameter is present , address or geocode search is ignored.
            It cannot be combined with AccountNumber search parameter.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 15
        AccessPointStatus:
          description: "Status of UPS Access Point. Valid values are: \n01-Active-available\n07-Active-unavailable."
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        AccountNumber:
          description: The account number to use for UPS Access Point Search in the
            country or territory. Used to locate a private network for the account.
            Once this parameter is present any access point address or geocode search
            is ignored. It cannot be combined with PublicAccessPointID search parameter.
          maximum: 1
          type: string
          minLength: 6
          maxLength: 10
        IncludeCriteria:
          "$ref": "#/components/schemas/AccessPointSearch_IncludeCriteria"
        ExcludeFromResult:
          "$ref": "#/components/schemas/AccessPointSearch_ExcludeFromResult"
        ExactMatchIndicator:
          description: Presence of this tag represents that "AccessPointSearchByAddress"
            service is requested. The value of this tag is ignored.
          type: string
          maximum: 1
        ExistIndicator:
          description: Presence of this tag represents that "AccessPointAvailability"
            service is requested. The value of this tag is ignored.
          type: string
          maximum: 1
      xml:
        name: AccessPointSearch
      description: Applicable for request option 64 only. This contains inclusion
        and exclusion criteria for address search. It also contains Account Number
        and Access Point Public ID search elements.
    AccessPointSearch_IncludeCriteria:
      type: object
      properties:
        MerchantAccountNumberList:
          "$ref": "#/components/schemas/IncludeCriteria_MerchantAccountNumberList"
        SearchFilter:
          "$ref": "#/components/schemas/IncludeCriteria_SearchFilter"
        ServiceOfferingList:
          "$ref": "#/components/schemas/IncludeCriteria_ServiceOfferingList"
      xml:
        name: IncludeCriteria
      description: This contains elements to refine (include) UPS Access point address
        or geocode Search.
      maximum: 1
    IncludeCriteria_MerchantAccountNumberList:
      type: object
      required:
      - MerchantAccountNumber
      properties:
        MerchantAccountNumber:
          description: Account number to be used for a private network access point
            search where a UPS access point candidate list is obtained in search by
            address or geocode search.
          type: array
          items:
            type: string
            minLength: 6
            maxLength: 10
      xml:
        name: MerchantAccountNumberList
      description: This contains the list of Merchant Account numbers to be used for
        finding private network access points.
      maximum: 1
    IncludeCriteria_SearchFilter:
      type: object
      maximum: 1
      properties:
        DCRIndicator:
          description: DCR/DCO Availability indicator for UPS Access Point. Either
            this indicator is present or not present. Presence indicates a search
            for access points with DCR. Any data in the element is ignored.
          type: string
          maximum: 1
        ShippingAvailabilityIndicator:
          description: Shipping Availability indicator for UPS Access Point. Either
            this indicator is present or not present. Presence indicates a search
            of access points with shipping availability. Any data in it is ignored.
          type: string
          maximum: 1
        ShipperPreparationDelay:
          description: Value for the number of days to check for shipping availability from the current day. When this value is present, ShippingAvailabilityIndicator is implied implicitly.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 1
        ClickAndCollectSortWithDistance:
          description: This contains the distance (in given UnitOfMeasurement) wherin to sort the click and collect access point locations above other access point locations when a UPS Access Point candidate list is obtained in search by address or geocode search.
          maximum: 1
          type: string
          maxLength: 3
      xml:
        name: SearchFilter
      description: Container to hold one or more search criteria for UPS Access Points
        that allow DCR, Shipping and ClickAndCollect access. Only applicable when
        the UPS access point candidate list is obtained in search by address or geocode
        search.
    IncludeCriteria_ServiceOfferingList:
      type: object
      required:
      - ServiceOffering
      properties:
        ServiceOffering:
          type: array
          items:
            "$ref": "#/components/schemas/ServiceOfferingList_ServiceOffering"
      xml:
        name: ServiceOfferingList
      description: Container to hold end point service offering List for UPS Access
        point. Applicable only when a UPS Access Point candidate list is obtained
        in search by address or geocode search.
      maximum: 1
    ServiceOfferingList_ServiceOffering:
      type: object
      maximum: 1
      required:
      - Description
      - Code
      properties:
        Code:
          description: "The valid values are: \n001-Direct To Retail\n002-Not In One
            ADL\n003-Click and Collect\n004-Retail to Retail\n005-Pickup\n006-Drop
            Off\n007-PUDO\n008-Early Pickup Delivery Time\n009-Accept prepaid drop
            offs\n010-DCO DCR intercept accepted \n011-Accepts Payments \n012-Pay
            At Store\n013-Accepts Restricted Articles"
          maximum: 1
          type: string
          minLength: 3
          maxLength: 3
        Description:
          description: Description of the service offering. Text will be displayed
            in the locale requested.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 35
      xml:
        name: ServiceOffering
    AccessPointSearch_ExcludeFromResult:
      type: object
      maximum: 1
      properties:
        BusinessClassificationCode:
          description: This contains the business classification code to exclude from
            UPS Access Point Search by address or geocode. Multiple codes can are
            possible in separate elements. Please refer to Appendix D for detailed
            business codes.
          type: array
          items:
            type: string
            minLength: 3
            maxLength: 3
          maximum: 1
        BusinessName:
          description: This contains the business name to exclude from UPS Access
            Point Search by address or geocode. Partial names are accepted.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 15
        Radius:
          description: Public Access points within Radius (in specified Unit of Measure)
            of any included private access points will be excluded from the results.
            Valid only if at least one IncludeCriteria/MerchantAccountNumber is provided.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 3
        PostalCodeList:
          "$ref": "#/components/schemas/ExcludeFromResult_PostalCodeList"
      xml:
        name: ExcludeFromResult
      description: This contains elements to exclude from UPS Access Point address
        or geocode search.
    ExcludeFromResult_PostalCodeList:
      type: object
      required:
      - PostalCode
      properties:
        PostalCode:
          type: array
          items:
            "$ref": "#/components/schemas/PostalCodeList_PostalCode"
      xml:
        name: PostalCodeList
      description: Container to hold a list of postal codes to exclude from the access
        point address or geocode search.
      maximum: 1
    PostalCodeList_PostalCode:
      type: object
      maximum: 1
      required:
      - PrimaryPostalCode
      properties:
        PrimaryPostalCode:
          description: Primary postal code.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 10
        SecondaryPostalCode:
          description: Secondary postal code.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 10
      xml:
        name: PostalCode
      description: Container to hold the postal code .
    LocationSearchCriteria_OpenTimeCriteria:
      type: object
      maximum: 1
      properties:
        DayOfWeekCode:
          description: |-
            Day Of week Code.
            Valid values:
            1-Sunday
            2-Monday
            3-Tuesday
            4-Wednesday
            5-Thursday
            6-Friday
            7-Saturday
          maximum: 1
          type: string
          minLength: 1
          maxLength: 1
        FromTime:
          description: From time. Time Format HHMM.
          maximum: 1
          type: string
          minLength: 4
          maxLength: 4
        ToTime:
          description: To Time. Time Format HHMM
          maximum: 1
          type: string
          minLength: 4
          maxLength: 4
      xml:
        name: OpenTimeCriteria
      description: Container to hold open times of the Location.
    LocatorRequest_SortCriteria:
      type: object
      maximum: 1
      properties:
        SortType:
          description: |-
            For different sort type. Valid values:
            01-Closest Location
            02-Deadline for Drop-off by Air/Express
            03-Deadline for Drop-off by Ground/Standard
            04-Latest Close Time
            05-Earliest Open Time.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 2
      xml:
        name: SortCriteria
      description: Container for Sort Criteria
    LocatorRequest_ServiceGeoUnit:
      type: object
      maximum: 1
      required:
      - ServiceCode
      - GeoPoliticalUnit
      properties:
        ServiceCode:
          description: "Service Code. Required if ServiceGeoUnit Container present.
            \nValid value is '096' ."
          maximum: 1
          type: string
          minLength: 3
          maxLength: 3
        GeoPoliticalUnit:
          description: |-
            GeoPoliticalUnit. Required if ServiceGeoUnit container present.
            Valid value is '002' .
          maximum: 1
          type: string
          minLength: 3
          maxLength: 3
      xml:
        name: ServiceGeoUnit
      description: ServiceGeoUnit Container. Required to search for the freight facility
        information
    LocatorResponse:
      type: object
      required:
      - Response
      - AllowAllConfidenceLevels
      - SearchResults
      properties:
        Response:
          "$ref": "#/components/schemas/LocatorResponse_Response"
        Geocode:
          "$ref": "#/components/schemas/LocatorResponse_Geocode"
        SearchResults:
          "$ref": "#/components/schemas/LocatorResponse_SearchResults"
        AllowAllConfidenceLevels:
          description: |-
            Confidence level.
            Valid values: True or False
          maximum: 1
          type: string
          minLength: 4
          maxLength: 5
      xml:
        name: LocatorResponse
      maximum: 1
      description: Container for LocatorResponse.
    LocatorResponse_Response:
      type: object
      properties:
        TransactionReference:
          "$ref": "#/components/schemas/Response_TransactionReference"
        ResponseStatusCode:
          description: "Identifies the success or failure of the interchange. \n1-Success\n0-Failure"
          maximum: 1
          type: string
          minLength: 1
          maxLength: 1
        ResponseStatusDescription:
          description: Describes the Response Status Code.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 15
        Error:
          "$ref": "#/components/schemas/Response_Error"
      xml:
        name: Response
      maximum: 1
      required:
      - ResponseStatusCode
      description: Container for Response.
    Response_TransactionReference:
      type: object
      maximum: 1
      properties:
        CustomerContext:
          description: Customer provided data. If this data is present in the request, it is echoed back to the customer.
          maximum: 1
          type: string
          maxLength: 512
        XpciVersion:
          description: "Identifies the version of the message. \nCurrent version is
            1.0014"
          maximum: 1
          type: string
          minLength: 6
          maxLength: 6
      xml:
        name: TransactionReference
      description: Container for customer provided data and the XPCI Version.
    Response_Error:
      type: object
      maximum: 1
      required:
      - ErrorSeverity
      - ErrorCode
      properties:
        ErrorSeverity:
          description: "Describes the severity of the error. \nFor additional information,
            refer to Locator Error Codes in the Appendix."
          maximum: 1
          type: string
          minLength: 1
          maxLength: 15
        ErrorCode:
          description: "A numeric value that describes the error. Each tool defines
            a range of error codes. \nFor additional information, refer to Locator
            Error Codes in the Appendix."
          maximum: 1
          type: string
          minLength: 1
          maxLength: 15
        ErrorDescription:
          description: Describes the error code.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        MinimumRetrySeconds:
          description: "Number of seconds to wait until retry. \n\nThis field is populated
            on special conditions of the Transient Error only, as defined by the service.\n\nA
            number between 1 and 86400 (24 hours)"
          maximum: 1
          type: string
          minLength: 1
          maxLength: 5
        ErrorLocation:
          description: |
              Identifies the element in error.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/Error_ErrorLocation"
        ErrorDigest:
          description: |
              The contents of the element in error.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            type: string
      xml:
        name: Error
      description: If an error is encountered during the interchange, the Response
        contains an error. If the error is present, then the ErrorSeverity and ErrorCode
        are required.
    Error_ErrorLocation:
      type: object
      maximum: 1
      properties:
        ErrorLocationElementName:
          description: The Xpath name of the element in error. This is a valid Xpath
            pointing to an element in the request document.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 512
        ErrorLocationAttributeName:
          description: The name of the attribute in error. This is the name of the
            attribute contained by the Error Location element.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
      xml:
        name: ErrorLocation
    LocatorResponse_Geocode:
      type: object
      maximum: 1
      required:
      - Latitude
      - Longitude
      properties:
        Latitude:
          description: The latitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city.
          type: string
        Longitude:
          description: The longitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city.
          type: string
      xml:
        name: Geocode
      description: Geocode is the latitude and longitude of the origin address. The
        Geocode is provided in the first successful response. Required to be returned
        when the origin address or phone number is submitted in the request.Will not
        be returned when the  requestoption =64
    LocatorResponse_SearchResults:
      type: object
      properties:
        GeocodeCandidate:
          description: |
              If the origin address provided in the location request document does not have a match, a list of candidate addresses, geocodes and optionally a landmark will be returned.

              **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/SearchResults_GeocodeCandidate"
        Disclaimer:
          type: string
          description: "Disclaimer. In the event the user requested Ground and Air
            service types and the maximum UPS locations list size has not been met,
            the list of locations will continue with locations that provide either
            ground or air within the search radius. \n\nThe disclaimer will note this
            deviation from the requested search criteria. The disclaimer is also the
            location where the user will receive information regarding a one-time
            pickup option if the first location is greater than 20 miles from the
            origin."
        DropLocation:
          description: |
              When a location request is submitted with a valid origin address, UPS locations will be returned.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/SearchResults_DropLocation"
        AvailableLocationAttributes:
          description: |
              This container contains the information about the currently existing Retail Locations or Additional Services or Program types.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/SearchResults_AvailableLocationAttributes"
        ActiveAvailableAccessPointIndicator:
          description: "Indicates whether the country or territory has AccessPoints
            or not. \n\nThis tag is populated in the Response only if tag \"ExistIndicator\"
            was present in the Locator request."
          type: string
          maximum: 1
      xml:
        name: SearchResults
      maximum: 1
      description: Container for search results.
    SearchResults_GeocodeCandidate:
      type: object
      required:
      - Geocode
      - AddressKeyFormat
      properties:
        AddressKeyFormat:
          "$ref": "#/components/schemas/GeocodeCandidate_AddressKeyFormat"
        Geocode:
          "$ref": "#/components/schemas/GeocodeCandidate_Geocode"
        LandmarkName:
          description: If a Landmark code was provided in the request, a candidate
            list of Landmark Names will be returned along with the corresponding address
            and Geocode.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
      xml:
        name: GeocodeCandidate
      maximum: 1
    GeocodeCandidate_AddressKeyFormat:
      type: object
      maximum: 1
      properties:
        ConsigneeName:
          description: Name. Not relevant for candidate list.
          type: string
        AddressLine:
          description: Address Line Information. The address level or Intersection information must be returned if provided in the request. The AddressLine will be a combination of up to 3 separate address lines, each separated by a new line character.
          type: string
        PoliticalDivision3:
          description: Subdivision within a City. e.g., a Barrio.
          type: string
        PoliticalDivision2:
          description: City.
          type: string
        PoliticalDivision1:
          description: State/Province.
          type: string
        PostcodePrimaryLow:
          description: Postal Code.
          type: string
        PostcodeExtendedLow:
          description: 4 Digit postal code extension. Valid for US only.
          type: string
        CountryCode:
          description: "A country or territory code. Valid values for candidates to be returned are: US-United States (meaning US 50)"
          type: string
      xml:
        name: AddressKeyFormat
      required:
      - PoliticalDivision1
      - AddressLine
      - PostcodePrimaryLow
      - PoliticalDivision2
      - CountryCode
      description: Contains all of the basic information about candidate address.
    GeocodeCandidate_Geocode:
      type: object
      maximum: 1
      required:
      - Latitude
      - Longitude
      properties:
        Latitude:
          description: The latitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city.
          type: string
        Longitude:
          description: The longitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city.
          type: string
      xml:
        name: Geocode
      description: Geocode is the latitude and longitude of the origin candidate.
    SearchResults_DropLocation:
      type: object
      maximum: 1
      required:
      - Geocode
      - Timezone
      - IVR
      - AddressKeyFormat
      - LocationID
      - OriginOrDestination
      - PhoneNumber
      - LocationAttribute
      - Distance
      properties:
        LocationID:
          description: The location ID that corresponds to the UPS location. Do not
            expose the Location ID.
          type: string
          minLength: 1
          maxLength: 10
        OriginOrDestination:
          description: "OriginOrDestination will returned for FreightWillCallRequestType
            1 Postal based and 3 City and/or State based search. \n\nOriginOrDestination
            will be 01 for origin facilities and 02 for Destination facilities"
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        IVR:
          "$ref": "#/components/schemas/DropLocation_IVR"
        Geocode:
          "$ref": "#/components/schemas/DropLocation_Geocode"
        AddressKeyFormat:
          "$ref": "#/components/schemas/DropLocation_AddressKeyFormat"
        PhoneNumber:
          description: |
              The UPS locations Phone number. A phone number of the location will be returned.

              10 digits allowed for US, otherwise 1..15 digits allowed.

              The phone number will be returned as a string.

              **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 15
        FaxNumber:
          description: "The UPS location's Fax number. A fax number of the location
            will be returned when available. \n10 digits allowed for US, otherwise
            1..15 digits allowed.\nThe fax number will be returned as string."
          maximum: 1
          type: string
          minLength: 1
          maxLength: 15
        EMailAddress:
          description: Email address of the UPS location. Returned when available.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        LocationAttribute:
          description: |
              OptionType is a container that indicates the type of the location attribute.

              There are 4 types of attributes.

              They are: Location, Retail Location, Additional Services and Program Type.

              **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/DropLocation_LocationAttribute"
        Distance:
          "$ref": "#/components/schemas/DropLocation_Distance"
        SpecialInstructions:
          description: |
              Walking directions.

              **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/DropLocation_SpecialInstructions"
        LatestGroundDropOffTime:
          description: |
              The latest ground time the users can Drop-off the package at the location to be picked up. The time information is based on the time at the UPS location.

              When a user specifies a Drop-off Time and Ground as the Service Type, the locations that have latest Drop-off times equal to or later than the specified Drop-off time and service type are returned.

              **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            minLength: 4
            maxLength: 6
            type: string
        LatestAirDropOffTime:
          description: |
              The latest airtime the users can Drop-off the package at the location to be picked up. The time information is based on the time at the UPS location.

              When a user specifies a Drop-off Time and Air as the Service Type, the locations that have latest Drop-off times equal to or later than the specified Drop-off time and service type are returned.

              **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            minLength: 4
            maxLength: 6
            type: string
        AdditionalChargeIndicator:
          description: Presence or Absence Indicator. If present, Indicates if the
            UPS location would have an additional charge. ASO locations will require
            an additional charge.
          type: string
          maximum: 1
        StandardHoursOfOperation:
          description: The standard hours of operation of the drop location will be
            returned when available. The location's time may differ because of holidays.
          type: string
          maximum: 1
        NonStandardHoursOfOperation:
          description: The non-standard hours of operation of the drop location. The
            location's time may differ because of holidays, weekends, or other factors
            that are beyond the locations control. Seven days preceding a given holiday
            the Non Standard Hours Of Operation will be returned along with the standard
            hours of operation if available.
          type: string
          maximum: 1
        WillCallHoursOfOperation:
          description: The will call hours of operation of the drop location will
            be returned when available. The location's time may differ because of
            holidays.
          type: string
          maximum: 1
        Number:
          description: The center number of the drop location if it is The UPS store.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 6
        HomePageURL:
          description: The home page URL of the drop location if it is The UPS store.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 255
        Comments:
          description: "Comments returned about the location. Text will be displayed in English or the locale given in the request. If Country Code is FR, and locale passed in the request is \"fr_FR\" then text will be displayed in French language, else comment will be displayed in English language."
          maximum: 1
          type: string
          minLength: 1
          maxLength: 255
        AdditionalComments:
          "$ref": "#/components/schemas/DropLocation_AdditionalComments"
        Disclaimer:
          description: |
              Textual disclaimer about the drop location.

              **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            type: string
        SLIC:
          description: SLIC.
          maximum: 1
          type: string
          minLength: 5
          maxLength: 5
        Timezone:
          description: TimeZone.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        FacilityType:
          description: PKG/FRT.
          maximum: 1
          type: string
          minLength: 3
          maxLength: 3
        OperatingHours:
          "$ref": "#/components/schemas/DropLocation_OperatingHours"
        LocalizedInstruction:
          description: |
              LocalizedInstruction container. Applicable for SearchOptionCode 01, 02, 03.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/DropLocation_LocalizedInstruction"
        PromotionInformation:
          description: |
              Container to hold any promotion text for the location. Text will be displayed in English or the locale given in the request.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/DropLocation_PromotionInformation"
        SortCode:
          "$ref": "#/components/schemas/DropLocation_SortCode"
        ServiceOfferingList:
          "$ref": "#/components/schemas/DropLocation_ServiceOfferingList"
        DisplayPhoneNumberIndicator:
          description: "Valid Values: \n0-Do not display phone number\n1-Display phone
            number. \nThis indicator will be returned only for the contact type Telephone
            number. This indicator is used by the clients to determine whether to
            display the telephone number to the end user."
          maximum: 1
          type: string
          minLength: 1
          maxLength: 1
        AccessPointInformation:
          "$ref": "#/components/schemas/DropLocation_AccessPointInformation"
        LocationImage:
          "$ref": "#/components/schemas/DropLocation_LocationImage"
        LocationNewIndicator:
          description: Indicator for new location.
          type: string
          maximum: 1
        PromotionalLinkURL:
          description: Promotional link URL for specific location.
          type: string
          maximum: 1
        FeaturedRank:
          description: "Feature Ranking values:\nNull or blank - Location is not featured.
            \n1 - Featured Location ranked number 1.\n2 - Featured Location ranked
            number 2."
          maximum: 1
          type: string
          maxLength: 1
        WillCallLocationIndicator:
          description: |
            Will Call Location Indicator values:
            - Y – Signifies a Will Call location that serves the customers address.
            - N - Signifies it is not a Will Call location.

            Will Call locations are only returned with a \"Y\" indicator if the request included EnhancedSearchOption code 10.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 1
      xml:
        name: DropLocation
    DropLocation_IVR:
      type: object
      maximum: 1
      required:
      - PhraseID
      properties:
        PhraseID:
          description: |-
            Contains the name of the IVR file that relates to this drop location. The file is an audio recording of information related to the location.
            ONLY FOR IVR.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 30
        TextToSpeechIndicator:
          description: "Indicates to the response recipient that the information has
            changed, and a new audio file should be produced. \nONLY FOR IVR."
          type: string
          maximum: 1
      xml:
        name: IVR
      description: "Integrated Voice Response information. \nONLY FOR IVR."
    DropLocation_Geocode:
      type: object
      maximum: 1
      required:
      - Latitude
      - Longitude
      properties:
        Latitude:
          description: The latitude of the location address or the center point of
            the area code.
          type: string
        Longitude:
          description: The longitude of the location address or the center point of
            the area code.
          type: string
      xml:
        name: Geocode
      description: Geocode is the latitude and longitude of the location address.
        The Geocode for the location address will be returned when Location is requested
        in the Request Option.
    DropLocation_AddressKeyFormat:
      type: object
      maximum: 1
      properties:
        ConsigneeName:
          description: Name. (Also includes the building name)Return if available.
          type: string
        AddressLine:
          description: Address Line Information of the UPS location The address level
            or Intersection information. Only two address lines will be returned.
            The second line may contain such information as the building name, the
            suite, and room.
          type: string
        PoliticalDivision3:
          description: Subdivision within a City. e.g., a Barrio.
          type: string
        PoliticalDivision2:
          description: City.
          type: string
        PoliticalDivision1:
          description: State/Province.
          type: string
        PostcodePrimaryLow:
          description: Postal Code.
          type: string
        PostcodeExtendedLow:
          description: 4 Digit postal code extension. Valid for US only.
          type: string
        CountryCode:
          description: 'A country or territory code. Valid values to be returned are:
            US-United States (meaning US 50).'
          type: string
      xml:
        name: AddressKeyFormat
      required:
      - PoliticalDivision1
      - AddressLine
      - PostcodePrimaryLow
      - PoliticalDivision2
      - CountryCode
      description: Contains all of the basic information about a location, Consignee
        Name, Building Name, Address Lines, City, State/Province, Postal Code and
        Country or Terriotry Code.
    DropLocation_LocationAttribute:
      type: object
      required:
      - OptionCode
      - OptionType
      properties:
        OptionType:
          "$ref": "#/components/schemas/LocationAttribute_OptionType"
        OptionCode:
           description: |
               Option code is a container that contains the information of a particular type of Location or retail location or additional service or program type that the drop location contains.

               If the OptionType is Location or Retail Location Type there will be one code since each location has only one location type or retail location type.

               If the Option type is additional services or program types there can be one or more option codes.

               **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
           type: array
           items:
             "$ref": "#/components/schemas/LocationAttribute_OptionCode"
      xml:
        name: LocationAttribute
      description: LocationAttribute is a container that contains the information
        about the location's Location Type, Retail Location Type, Additional Services,
        or Program Type.
      maximum: 1
    LocationAttribute_OptionType:
      type: object
      maximum: 1
      required:
      - Description
      - Code
      properties:
        Code:
          description: |
            Code for Option type. Valid values:
            - 01 - Location
            - 02 - Retail Location
            - 03 - Additional Services
            - 04 - Program Type
          type: string
        Description:
          description: Description for Option type such as Location, RetailLocation, AdditionalServices and ProgramType.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
      xml:
        name: OptionType
    LocationAttribute_OptionCode:
      type: object
      properties:
        Category:
          description: |
            Only applicabe for OptionType = 03 (Additional Services). Valid values:
            - 06 - Non transportation
            - 07 - Transportation
          type: string
        Code:
          description: These codes vary by country or territory. It is strongly recommended that clients contact UPS to retrieve the primary search indicator and the valid Location Types and Service Level Options for each country. Refer to Location Search Option Codes in the Appendix for additional information.
          type: string
        Description:
          description: |
            Description is only applicable for Location and Retail Location. The description for Program types and additional service is not provided with Location detail.

            It is only provided when the request is for 8, 24, 40, 56-All available additional services or 16, 24, 48, 56-all available Program types.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        Name:
          description: Name will indicate the name of any Additional Services/ Program Types depending on the option code. Text will be displayed in the locale selected.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
        TransportationPickUpSchedule:
          "$ref": "#/components/schemas/OptionCode_TransportationPickUpSchedule"
      xml:
        name: OptionCode
      maximum: 1
      required:
      - Description
      - Code
    OptionCode_TransportationPickUpSchedule:
      type: object
      required:
      - PickUp
      properties:
        PickUp:
          description: |
              PickUp container contains details of day of week and corresponding pickup times for that service.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/TransportationPickUpSchedule_PickUp"
      xml:
        name: TransportationPickUpSchedule
      description: TransportationPickUpSchedule container contains details of Latest Drop Off time/Pickup Time for the transportation services (Ground/Air/Standard/Express/International) of the location.
      maximum: 1
    TransportationPickUpSchedule_PickUp:
      type: object
      required:
      - DayOfWeek
      - PickUpDetails
      properties:
        DayOfWeek:
          description: |
            Day of week.
            - 1 - Sunday
            - 2 - Monday
            - 3 - Tuesday
            - 4 - Wednesday
            - 5 - Thursday
            - 6 - Friday
            - 7 - Saturday.
          type: string
          minLength: 1
          maxLength: 1
        PickUpDetails:
          "$ref": "#/components/schemas/PickUp_PickUpDetails"
      xml:
        name: PickUp
    PickUp_PickUpDetails:
      type: object
      properties:
        PickUpTime:
          description: Pickup time of transportation service for a location in military format (HHMM) e.g. 0930, 1700, 1845 etc. with exception for midnight. For midnight the time will be returned as 0.
          type: string
          minLength: 4
          maxLength: 4
        NoPickUpIndicator:
          description: Presence or Absence Indicator. If present, Indicates that there is no pickup time for the day.
          type: string
      xml:
        name: PickUpDetails
      required:
      - NoPickUpIndicator
      description: PickUpDetails container contains either pickup time or NoPickupIndicator. Either PickUpTime or NoPickupIndicator
      maximum: 1
    DropLocation_Distance:
      type: object
      maximum: 1
      required:
      - UnitOfMeasurement
      - Value
      properties:
        Value:
          description: The straight line distance from the origin to the UPS location.
            Distance value may include one decimal and followed by one decimal place.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 4
        UnitOfMeasurement:
          "$ref": "#/components/schemas/Distance_UnitOfMeasurement"
      xml:
        name: Distance
      description: Container for the straight line distance from the origin to the
        UPS location.
    Distance_UnitOfMeasurement:
      type: object
      maximum: 1
      required:
      - Code
      properties:
        Code:
          description: "The distance unit of measurement code. The unit of measurement
            used in the search request is returned. \n\nValid values: MI-Miles or
            KM-Kilometers"
          type: string
        Description:
          description: May return the description of the unit of measure specified
            in the request.
          maximum: 1
          type: string
          minLength: 5
          maxLength: 10
      xml:
        name: UnitOfMeasurement
      description: The unit of measurement the user will see for the distance is based
        on the user input provided in the search request.
    DropLocation_SpecialInstructions:
      type: object
      maximum: 1
      required:
      - Segment
      properties:
        Segment:
          description: Walking directions, last 50 feet. 
                       **NOTE:** For versions >= v3, this element will always be returned as an array. For requests using version = v1 and v2, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            type: string
      xml:
        name: SpecialInstructions
    DropLocation_AdditionalComments:
      type: object
      required:
      - CommentType
      properties:
        CommentType:
          description: |
              Container for CommentType Code and Text.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/AdditionalComments_CommentType"
      xml:
        name: AdditionalComments
      description: Container for Additional Comments about Location.Text will be displayed
        in the Locale requested.
      maximum: 1
    AdditionalComments_CommentType:
      type: object
      maximum: 1
      required:
      - Text
      - Code
      properties:
        Code:
          description: Comment code is 01 for AccessPoint LCO pickup time comment.
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        Text:
          description: Access point LCO pickup time comment
          maximum: 1
          type: string
          minLength: 1
          maxLength: 255
      xml:
        name: CommentType
    DropLocation_OperatingHours:
      type: object
      properties:
        StandardHours:
          description: |
              StandardHours Container.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/OperatingHours_StandardHours"
      xml:
        name: OperatingHours
      description: Operating Hours.
      maximum: 1
    OperatingHours_StandardHours:
      type: object
      maximum: 1
      required:
      - DayOfWeek
      - HoursType
      properties:
        HoursType:
          description: "Hours Type. \n\nValid values: \n10-Regular Operating Hours
            \n11-Will Call Hours\n12-Same Day Will Call Hours\n14-Customer PickUp\n50-Drop
            Off Hours \n51-Prep Hours"
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        DayOfWeek:
          description: |
              Container for the Day of Week.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/StandardHours_DayOfWeek"
      xml:
        name: StandardHours
    StandardHours_DayOfWeek:
      type: object
      maximum: 1
      required:
      - Day
      properties:
        Day:
          description: "Day of week. \nValid values: \n1-Sunday\n2-Monday\n3-Tuesday\n4-Wednesday\n5-Thursday\n6-Friday\n7-Saturday."
          maximum: 1
          type: string
          minLength: 1
          maxLength: 1
        OpenHours:
          description: Open time of a location in military format (HHMM) e.g. 930,
            1700, 1845 etc. with exception for midnight. For midnight the time will
            be returned as 0.
          maximum: 1
          type: string
          minLength: 4
          maxLength: 4
        CloseHours:
          description: Close time of a location in military format (HHMM) e.g. 930,
            1700, 1845 etc. with exception for midnight. For midnight the time will
            be returned as 0.
          maximum: 1
          type: string
          minLength: 4
          maxLength: 4
        LatestDropOffHours:
          description: LatestDropOffHours for Hour Type 50. Latest Drop Off time of
            a location in military format (HHMM) e.g. 930, 1700, 1845 etc. with exception
            for midnight. For midnight the time will be returned as 0.
          maximum: 1
          type: string
          minLength: 4
          maxLength: 4
        PrepHours:
          description: PrepHours for Hour Type 51. Prep Hours of a location in military
            format (HHMM) e.g. 930, 1700, 1845 etc. with exception for midnight. For
            midnight the time will be returned as 0.
          maximum: 1
          type: string
          minLength: 4
          maxLength: 4
        ClosedIndicator:
          description: Presence absence Indicator. Indicator present means location
            is closed.
          maximum: 1
          type: string
        Open24HoursIndicator:
          description: Presence/ Absence Indicator. Presence denotes  for the given
            day, if the location is open 24 hours. Absence denotes the location is
            not open for 24 hours on the given day.
          maximum: 1
          type: string
          minLength: 4
          maxLength: 5
      xml:
        name: DayOfWeek
    DropLocation_LocalizedInstruction:
      type: object
      maximum: 1
      required:
      - Locale
      - Last50ftInstruction
      properties:
        Locale:
          description: Locale
          maximum: 1
          type: string
          minLength: 5
          maxLength: 5
        Last50ftInstruction:
          description: Holds the additional instructions. Text will be displayed in
            English or the locale given in the request. The max length of the additional
            instruction text is 750 characters.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 750
      xml:
        name: LocalizedInstruction
    DropLocation_PromotionInformation:
      type: object
      maximum: 1
      required:
      - Locale
      - Promotion
      properties:
        Locale:
          description: Locale (language/ dialect) for the promotion code.
          maximum: 1
          type: string
          minLength: 5
          maxLength: 5
        Promotion:
          description: Promotion text for the given location.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 100
      xml:
        name: PromotionInformation
    DropLocation_SortCode:
      type: object
      maximum: 1
      properties:
        HubSortCode:
          description: Holds the value of the hub sort code or airport code
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        FreightSortFacilityCode:
          description: Holds the value of the facility location code.
          maximum: 1
          type: string
          minLength: 3
          maxLength: 3
      xml:
        name: SortCode
      description: This container is only for Freight Will call Search.
    DropLocation_ServiceOfferingList:
      type: object
      required:
      - ServiceOffering
      properties:
        ServiceOffering:
          description: |
              Container for Service offering code.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/ServiceOfferingList_ServiceOffering"
      xml:
        name: ServiceOfferingList
      description: Container to hold the list of service offerings at the end point.
      maximum: 1
    DropLocation_AccessPointInformation:
      type: object
      maximum: 1
      properties:
        PublicAccessPointID:
          description: The Public Access Point ID associated with UPS access point.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 15
        ImageURL:
          description: Image URL associated with UPS access point.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 255
        BusinessClassificationList:
          "$ref": "#/components/schemas/AccessPointInformation_BusinessClassificationList"
        AccessPointStatus:
          "$ref": "#/components/schemas/AccessPointInformation_AccessPointStatus"
        FacilitySLIC:
          description: Holds the value of facility SLIC of Access Point Location.
            Not implemented currently. For future use.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 10
        PrivateNetworkList:
          "$ref": "#/components/schemas/AccessPointInformation_PrivateNetworkList"
        Availability:
          "$ref": "#/components/schemas/AccessPointInformation_Availability"
      xml:
        name: AccessPointInformation
      description: Container for UPS Access Point specific parameters.
    AccessPointInformation_BusinessClassificationList:
      type: object
      required:
      - BusinessClassification
      properties:
        BusinessClassification:
          description: |
              Container to hold Business classification of UPS access point.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/BusinessClassificationList_BusinessClassification"
      xml:
        name: BusinessClassificationList
      description: Container to hold list for business classification.
      maximum: 1
    BusinessClassificationList_BusinessClassification:
      type: object
      maximum: 1
      required:
      - Description
      - Code
      properties:
        Code:
          description: Business Classification code of UPS Access Point. Please refer
            to appendix D for a list of business classification.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 3
        Description:
          description: Description of business classification.
          maximum: 1
          type: string
          maxLength: 35
      xml:
        name: BusinessClassification
    AccessPointInformation_AccessPointStatus:
      type: object
      maximum: 1
      required:
      - Description
      - Code
      properties:
        Code:
          description: "Valid status values are: \n01-Active-available\n06-Suspended\n07-Active-unavailable\n08-Terminated"
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        Description:
          description: Description of status code.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 35
      xml:
        name: AccessPointStatus
      description: Container for UPS AccessPoint status.
    AccessPointInformation_PrivateNetworkList:
      type: object
      required:
      - PrivateNetwork
      properties:
        PrivateNetwork:
          description: |
              Container to hold the private network details.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/PrivateNetworkList_PrivateNetwork"
      xml:
        name: PrivateNetworkList
      description: Container to hold the list of private networks.
      maximum: 1
    PrivateNetworkList_PrivateNetwork:
      type: object
      maximum: 1
      required:
      - NetworkID
      - NetworkDescription
      properties:
        NetworkID:
          description: Value of networkID.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 10
        NetworkDescription:
          description: Description of the Network.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 50
      xml:
        name: PrivateNetwork
    AccessPointInformation_Availability:
      type: object
      properties:
        ShippingAvailability:
          "$ref": "#/components/schemas/Availability_ShippingAvailability"
        DCRAvailability:
          "$ref": "#/components/schemas/Availability_DCRAvailability"
      xml:
        name: Availability
      description: Container to hold the status of shipping or DRC/DCO availability
        of a UPS Access Point.
      maximum: 1
    Availability_ShippingAvailability:
      type: object
      maximum: 1
      properties:
        AvailableIndicator:
          description: Presence or absence indicator. Presence means the location
            is available for shipping.
          type: string
          maximum: 1
        UnavailableReason:
          "$ref": "#/components/schemas/ShippingAvailability_UnavailableReason"
      xml:
        name: ShippingAvailability
      description: Holds status of shipping availability.
    ShippingAvailability_UnavailableReason:
      type: object
      maximum: 1
      required:
      - Description
      - Code
      properties:
        Code:
          description: |
            Code for shipping unavailability. Code for DCR/DCO unavailability.

            Valid values:
            - 01 - Temporarily Unavailable
            - 02 - Location Full
            - 03 - Unavailable
            - 04 - Weather
          maximum: 1
          type: string
          minLength: 2
          maxLength: 2
        Description:
          description: Description for shipping unavailability.
          maximum: 1
          type: string
          minLength: 1
          maxLength: 35
      xml:
        name: UnavailableReason
      description: Container to hold shipping unavailable reason.
    Availability_DCRAvailability:
      type: object
      maximum: 1
      properties:
        AvailableIndicator:
          description: Presence or absence indicator. Presence means the location
            is available for DCR/DCO.
          type: string
          maximum: 1
        UnavailableReason:
          "$ref": "#/components/schemas/DCRAvailability_UnavailableReason"
      xml:
        name: DCRAvailability
      description: Holds status of DCR/DCO availability.
    DCRAvailability_UnavailableReason:
      type: object
      maximum: 1
      required:
      - Description
      - Code
      properties:
        Code:
          description: "Code for DCR/DCO unavailability. Valid values: \n01-Temporarily
            Unavailable \n02-Location Full\n03-Unavailable\n04-Weather"
          type: string
        Description:
          description: Description for DCR/ DCO unavailability.
          type: string
      xml:
        name: UnavailableReason
      description: Container to hold shipping unavailable reason.
    DropLocation_LocationImage:
      type: object
      maximum: 1
      properties:
        SecureURL:
          description: Secure URL for Location Image.
          type: string
          maximum: 1
        NonSecureURL:
          description: Non Secure URL for Location Image.
          type: string
          maximum: 1
      xml:
        name: LocationImage
      description: Location Image container.
    SearchResults_AvailableLocationAttributes:
      type: object
      required:
      - OptionCode
      - OptionType
      properties:
        OptionType:
          "$ref": "#/components/schemas/AvailableLocationAttributes_OptionType"
        OptionCode:
          "$ref": "#/components/schemas/AvailableLocationAttributes_OptionCode"
      xml:
        name: AvailableLocationAttributes
    AvailableLocationAttributes_OptionType:
      type: object
      maximum: 1
      required:
      - Description
      - Code
      properties:
        Code:
          description: Code for Option type.
          type: string
        Description:
          description: Description for Option type such as RetailLocation, AdditionalServices
            and ProgramType.
          type: string
      xml:
        name: OptionType
      description: OptionType is a container that indicates the type of the location
        attribute that are available. For example if the Option Type is RetailLocation
        the list of all available retail locations will be returned in 1 or many corresponding
        OptionCodes.
    AvailableLocationAttributes_OptionCode:
          description: |
              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/AvailableLocationAttributes_OptionCodeElement"
    AvailableLocationAttributes_OptionCodeElement:
      type: object
      maximum: 1
      required:
      - Description
      - Code
      properties:
        Code:
          description: The valid list of codes and description for Retail Locations
            or Additional Services or Pro-gram Types that are currently available
            in the database. This can be obtained by a separate type of request (Request
            Option 8, 16, 24, 32, 40, 48 and 56).
          type: string
        Description:
          description: Description is only applicable for Program types and Additional
            Services. It is not provided with Location detail. It is only provided
            when the request is for All available additional ser-vices or all available
            Program types. Text will be displayed in the locale requested.
          type: string
        Name:
          description: Name will indicate the name of Location/Retail Location or
            Additional Services or Program Types depending on the option code. Text
            will be displayed in the locale requested.
          type: string
        Category:
          description: N/A
          type: string
        TransportationPickUpSchedule:
          "$ref": "#/components/schemas/AvailableLocationAttributesOptionCode_TransportationPickUpSchedule"
      xml:
        name: OptionCode
      description: Option code is a container that contains the information of a particular
        retail location type or additional service or program type that is available
        currently. One or more of this container will be returned to give all the
        available codes for Retail Type or Additional Services or Program Type.
    AvailableLocationAttributesOptionCode_TransportationPickUpSchedule:
      type: object
      required:
      - PickUp
      properties:
        PickUp:
          description: |
              Container to hold information regarding pickup day of the week and details.

              **NOTE:** For versions >= v2, this element will always be returned as an array. For requests using version = v1, this element will be returned as an array if there is more than one object and a single object if there is only 1.
          type: array
          items:
            "$ref": "#/components/schemas/AvailableLocationAttributes_TransportationPickUpSchedule_PickUp"
      xml:
        name: TransportationPickUpSchedule
      description: Container to hold information regarding pickup details for each day of the week.
      maximum: 1
    AvailableLocationAttributes_TransportationPickUpSchedule_PickUp:
      type: object
      required:
      - DayOfWeek
      - PickUpDetails
      properties:
        DayOfWeek:
          description: |
            Day of the week for scheduled pickup. Valid values are:
            - 1 - Sunday
            - 2 - Monday
            - 3 - Tuesday
            - 4 - Wednesday
            - 5 - Thursday
            - 6 - Friday
            - 7 - Saturday.
          type: string
          minLength: 1
          maxLength: 1
        PickUpDetails:
          "$ref": "#/components/schemas/AvailableLocationAttributes_PickUp_PickUpDetails"
      xml:
        name: PickUp
    AvailableLocationAttributes_PickUp_PickUpDetails:
      type: object
      properties:
        PickUpTime:
          description: Time of pickup in military format (HHMM) e.g. 0930, 1700, 1845 etc. with exception for midnight. For midnight the time will be returned as 0.
          type: string
          minLength: 4
          maxLength: 4
        NoPickUpIndicator:
          description: |
            Indicates whether or not there is a pickup time for the specified day of the week. Valid values:
            - True-there is a pickup time
            - False-there is not a pickup time.
          type: string
      xml:
        name: PickUpDetails
      required:
      - NoPickUpIndicator
      description: Container to hold information regarding pickup time and pickup availability indicator.
      maximum: 1
    ErrorResponse:
      type: object
      properties:
        response:
          "$ref": "#/components/schemas/CommonErrorResponse"
    CommonErrorResponse:
      type: object
      description: The error response containing any errors that occurred.
      properties:
        errors:
          type: array
          description: The error array containing any errors that occurred.
          items:
            "$ref": "#/components/schemas/ErrorMessage"
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
          description: The error code.
        message:
          type: string
          description: The error message.
      description: The error response containing any errors that occurred.