Get Locations

The Locations API provides the capability of retrieving FedEx Office locations.

Swagger

			
swagger: '2.0'
info:
  x-ibm-name: location
  title: Location
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  oauth2:
    type: oauth2
    description: ''
    flow: accessCode
    authorizationUrl: 'https://<............................>/fsc/oauth2/authorize'
    scopes:
      Fulfillment_Returns: ''
    tokenUrl: 'https://<............................>/fsc/oauth2/token'
  Client_Secret:
    type: apiKey
    description: ''
    in: header
    name: X-IBM-Client-Secret
  Client_Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security:
  - Client_Id: []
    Client_Secret: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /locations:
    get:
      responses:
        '200':
          description: 200 OK      
      parameters:
        - name: addressLine1
          type: string
          required: false
          in: query
          description: 123 Main Street
        - name: addressLine2
          type: string
          required: false
          in: query
          description: 123 Main Street
        - name: city
          type: string
          required: false
          in: query
          description: PLUM
        - name: stateCode
          type: string
          required: false
          in: query
          description: PA
        - name: zipCode
          type: string
          required: false
          in: query
          description: '15238'
        - name: countryCode
          type: string
          required: false
          in: query
          description: US
        - name: distance
          type: string
          required: false
          in: query
          description: '10'
        - name: limit
          type: string
          required: false
          in: query
          description: '3'
        - name: accessToken
          type: string
          required: false
          in: header
          description: 'Enter AccessToken, it is mandatory.'
	  summary: Location Service
      description: The Locations API provides the capability of retrieving FedEx Office locations.
			
		

Sample Request

			
	•	Retrieve location details using below details
	https://<........>/api/v1/locations?addressLine1=123 MainStreet&addressLine2=123 Main Street&stateCode=PA&zipCode=15238&countryCode=US&city=PLUM

			
		

Sample Response

Success Response

			
{
	"requestIdentifier" : "COM1482178",
	"transactionDate" : "2014-01-09T13:31:00-05:00",
	"status" : true,
	"locations" : {
		"totalResultsAvailable" : "63",
		"resultsReturned" : "3",
		"matchedAddressGeoCoordinates" : "+40.5230452-79.8632834/",
		"matchedAddress" : {
			"city" : "Pittsburgh",
			"stateCode" : "PA",
			"zipCode" : "15238",
			"countryCode" : "US",
			"residential" : "false"
		},
		"locationsFound" : [{
			"distance" : {
			"value" : "1.494",
			"units" : "MI"
			},
			"locationId" : "S5XVN",
			"contact" : {
				"companyName" : "Walgreens"
			},
			"address" : {
			"streetLines" : "324 Hulton Rd",
			"city" : "Oakmont",
			"stateCode" : "PA",
			"zipCode" : "15139",
			"countryCode" : "US",
			"residential" : "false"
			},
			"geoCoordinates" : "+40.52528-79.841736/",
			"locationType" : "FEDEX_OFFICE",
			"mapUrl" : "https://maps.googleapis.com/maps/api/staticmap?size=350x350&zoom=15&
			markers=color:blue%7Clabel:A%7C40.52528,-79.841736&maptype=roadmap&sensor=false",
			"normalHours" : [{
				"dayofWeek" : "MON",
				"operationalHours" : "OPEN_BY_HOURS",
				"hours" : {
					"begins" : "08:00:00",
					"ends" : "22:00:00"
				}
			}, {
			"dayofWeek" : "TUE",
				"operationalHours" : "OPEN_BY_HOURS",
				"hours" : {
				"begins" : "08:00:00",
				"ends" : "22:00:00"
				}
			}, {
			"dayofWeek" : "WED",
				"operationalHours" : "OPEN_BY_HOURS",
				"hours" : {
					"begins" : "08:00:00",
					"ends" : "22:00:00"
					}
			}, {
				"dayofWeek" : "THU",
				"operationalHours" : "OPEN_BY_HOURS",
				"hours" : {
					"begins" : "08:00:00",
					"ends" : "22:00:00"
					}
				}, {
				"dayofWeek" : "FRI",
				"operationalHours" : "OPEN_BY_HOURS",
				"hours" : {
					"begins" : "08:00:00",
					"ends" : "22:00:00"
				}
				}, {
				"dayofWeek" : "SAT",
				"operationalHours" : "OPEN_BY_HOURS",
				"hours" : {
					"begins" : "08:00:00",
					"ends" : "22:00:00"
				}
				}, {
				"dayofWeek" : "SUN",
				"operationalHours" : "OPEN_BY_HOURS",
				"hours" : {
					"begins" : "08:00:00",
					"ends" : "22:00:00"
					}
				}
			]
		}
	]
}
}

			
		

OAuth 2.0

Custom authentication

Query Parameters

Response Attribute

HTTP Status Code

Error Code

Country Codes

Location Service Location Types

Location Service Operational Hours