Location API
Find an ABC Supply location by city, state, longitude and latitude, and other criteria. View geography hierarchies and key branch attributes such as products and services offered, branch hours and contacts.
The Get Branch endpoint returns detailed branch information for a specific branch by account number. Branch details returned include contact information, manager details, hours of operation, products, services, branch website link, and nearby branches.
Location API
Get Branch
GET /branches/{branchnumber}
Get ABC Supply branch information by branch number
Sandbox
Production
Authorization
OAuth 2.0 server or user token with the location.read scope.
Request
Query Parameters
The URI parameter “{branchNumber}” is the branch number to search.
Example Request
Request for a given branch.
GET /api/location/v1/branches/409 HTTP/1.1
Host: partner.abcsupply.com
Authorization: Bearer <TOKEN>Response
Example Response
Response for a given branch.
{
"branch": {
"number": "409",
"name": "ABC Supply - Billings, MT",
"storefront": "abc",
"status": "active",
"type": "primary"
},
"address": {
"addressLine1": "3404 Kenilworth Ave",
"addressLine2": "N/A",
"addressLine3": "N/A",
"city": "Hyattsville",
"state": "MD",
"postal": "20781",
"country": "USA"
},
"locale": {
"lat": "51.0",
"long": "41.9",
"timeZoneCode": "ET",
"timeZoneDescription": " US-CAN Eastern Timezone"
},
"contact": {
"phones": [
"3043651700 - ext 1234",
"3043651700 - ext 4567"
],
"emails": [
"[email protected]",
"[email protected]"
],
"fax": "3043651700"
},
"manager": {
"firstName": "Ryan",
"lastName": "Mannick",
"email": "[email protected]",
"title": "Managing Partner",
"pictureUrl": "https://managerimages.abcsupply.com/managerimages/020797.jpg"
},
"hoursOfOperation": [
{
"type": "DAILY",
"days": "MON - FRI",
"open": "7 AM",
"close": "7 PM",
"notes": "Closed on Weekends"
},
{
"type": "WEEKEND",
"days": "SAT",
"open": "9 AM",
"close": "6 PM",
"notes": ""
},
{
"type": "WEEKEND",
"days": "SUN",
"open": "11 AM",
"close": "4 PM",
"notes": ""
},
{
"type": "OFF_SEASON",
"days": "MON -FRI",
"open": "12 AM",
"close": "6 PM",
"notes": "Winter Hours of Operation 11/22 - 03/31"
}
],
"products": [
{
"productGroup": {
"name": "Steep Slope Products - 1",
"description": "Steep Slope Products"
},
"categories": [
{
"name": "Steep Slope Roofing (<gt/>2:12 Pitch) - 13",
"description": "Steep Slope Roofing (<gt/>2:12 Pitch)"
}
]
}
],
"services": [
{
"type": "local",
"name": "local services",
"value": [
"Express Pickup",
"Rooftop Delivery",
"Cut-to-length Gutter Coil",
"Two man roof load"
]
},
{
"type": "national",
"name": "national services",
"value": [
"Window Order Assistance",
"In-home financing",
"Job Site Signs",
"Custom Website Creation",
"Targeted Custom Mailer"
]
}
],
"links": {
"website": "https://www.abcsupply.com/location/662"
},
"nearByBranches": [
{
"number": "481",
"name": "ABC Supply - Lenexa, KS",
"storefront": "abc",
"distance": 10.4,
"status": "active",
"links": {
"self": "https://partners.abcsupply.com/api/location/v1/branches/481",
"website": "https://www.abcsupply.com/location/481"
}
},
{
"number": "6629",
"name": "ABC Supply - Denver, CO",
"storefront": "abc",
"distance": 11,
"status": "active",
"links": {
"self": "https://partners.abcsupply.com/api/location/v1/branches/662",
"website": "https://www.abcsupply.com/location/662"
}
}
]
}Name
Type
Description
branch
object
The object describing the branch.
branch.number
string
The unique branch number.
branch.name
string
The branch name., including the city and state.
branch.storefront
string
The storefront or branding of the branch (e.g., “abc”, “lw”, “tci”). ABC Supply is the only storefront supported at this time.
branch.status
string
The current operational status of the branch (e.g., “active”, “inactive”).
branch.type
string
The type of the branch (e.g., “primary”, “warehouse”).
address
object
The object describing the address of the branch.
address.addressLine1
string
The first line of the branch’s address including the street number and street name.
address.addressLine2
string
The second line of the branch’s address, which may include additional information like building numbers.
address.addressLine3
string
The third line of the branch’s address, often used for more specific location information or additional directions.
address.city
string
The city where the branch is located.
address.state
string
The two-letter state abbreviation code where the branch is located (e.g., “WI”, “IL”).
address.postal
string
The postal or zip code of the branch.
address.country
string
The three-letter ISO 3166-1 country code where the branch is located (e.g.. “USA”). “USA” is the only country code supported at this time.
locale
object
The object containing information about the branch geographical location and time zone.
locale.lat
string
The latitude of the branch location.
locale.long
string
The longitude of the branch location.
locale.timeZoneCode
string
The two-letter time zone abbreviation where the branch is located (e.g.. “PT”, “CT”, “ET”).
locale.timeZoneDescription
string
The canonical time zone identifier as maintained by ICANN (e.g.. “US-CAN Eastern Timezone”).
contact
object
The object describing the branch contacts.
contact.phones[]
array
The list of branch phone numbers with extensions, if applicable.
contact.emails[]
array
The email addresses of branch contacts.
contact.fax
string
The branch fax number.
manager
object
The object that describes the branch manager information.
manager.firstName
string
The first name of the branch manager.
manager.lastName
string
The last name of the branch manager.
manager.email
string
The email address of the branch manager.
manager.title
string
The title or role held by the branch manager (e.g., “Branch Manager”, “Managing Partner”).
manager.pictureUrl
string
The URL of the branch manager’s profile image.
hoursOfOperation
array
The list of the hours of operation of the branch.
hoursOfOperation[].type
string
The type of hours operation or service (e.g., “DAILY”, “WEEKEND”, “OFF_HOURS”).
hoursOfOperation[].days
string
The abbreviated day name when the branch is open or operational (e.g., “MON – FRI”, “SAT”, “SUN”).
hoursOfOperation[].open
string
The opening time of the branch.
hoursOfOperation[].close
string
The closing time of the branch.
hoursOfOperation[].notes
string
The additional notes or information about the branch hours of operation.
products
array
The list of the information about products offered by the branch.
products[].productGroup
object
The object describing the product group.
products[].productGroup.name
string
The name of the product group.
products[].productGroup.description
string
The description of the product group.
products[].categories
array
The list of the information about product categories offered by the branch.
products[].categories[].name
string
The name of the product category.
products[].categories[].description
string
The description of the product category.
services
array
The list of information for services offered by the branch.
services[].type
string
The type of service (e.g., “local”, “national”).
services[].name
string
The name of the service.
services[].value[]
array
The list of specific services offered at the branch (e.g. , “Express Pickup”, “Rooftop Delivery”, “Cut-to-length Gutter Coil”, “Two man roof load”).
links
object
The object describing reference links for the branch.
nearByBranches
array
The list of information about the nearest branch location.
nearByBranches[].number
string
The unique branch number.
nearByBranches[].name
string
The branch name., including the city and state.
nearByBranches[].storefront
string
The storefront or branding of the branch (e.g., “abc”, “lw”, “tci”). ABC Supply is the only storefront supported at this time.
nearByBranches[].distance
float
The distance in miles between the requested branch and the nearby branch.
nearByBranches[].status
string
The current operational status of the branch (e.g., “active”, “inactive”).
nearByBranches[].links
object
The object describing reference links for the nearby branch.
nearByBranches[].links.self
string
The API reference link for the branch.
HTTP Status Codes
Name
Type
Description
400
Bad Request
Check the Request to make sure the Request Body and Parameters are passed correctly based on the API documentation.
404
Object Not Found
The request returned empty or no object. Please check the object identifier.