How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Beacon Rest Services V1 (session)

The original Beacon PRO+ API surface — login and logout, account switching, branch list, jobs, order history and detail, catalog item lookup, pricing, cart items, order submission and templates. Nineteen published operations. Authenticated with a browser-shaped cookie session (JSESSIONID, DYN_USER_ID, DYN_USER_CONFIRM, siteId) established by POST /login and lasting one hour, or seven days with the RememberMe flag, rather than with a bearer token.

Beacon Rest Services V1 (session) is one of 7 APIs that Beacon Roofing Supply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Construction, Roofing, Distribution, E-Commerce, and Order. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 19 operations across 19 paths, organized into 8 resource areas, and defines 57 schemas. It is described by OpenAPI 3.0.0, at version 24PI-4-Sprint-3.

Requests are made against a single base URL, https://beaconproplus.com/v1/rest/com/becn.

19 operations 19 paths 57 schemas 14 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
24PI-4-Sprint-3
Base URL
https://beaconproplus.com/v1/rest/com/becn
Authentication
API Key, API Key, API Key, API Key, API Key
Resource Areas
8

Authentication & Security 5

Beacon Rest Services V1 (session) declares 5 security schemes for authenticating requests. An API key is passed in the cookie as JSESSIONID (JSESSIONID). An API key is passed in the cookie as DYN_USER_ID (DYN_USER_ID). An API key is passed in the cookie as DYN_USER_CONFIRM (DYN_USER_CONFIRM). An API key is passed in the cookie as siteId (siteId). An API key is passed in the cookie as rememberPassword (rememberPassword).

Paths & Operations 19

Across 19 paths, the API surfaces 19 operations — 14 GET, 5 POST. They span 8 resource areas: My Account Services, Branch Services, Job Service, Order History Services, Catalog ITEM Services, Submit Order Services, Add Multiple Items To Order, Template Services. Each is listed below with its method, path, parameters, and response codes.

My Account Services 6
POST
/login
User login with username/password
body → 200400
POST
/logout
User logout
→ 200400401500
GET
/getLoginDeclaration
Get login declaration
4 params → 200405500
GET
/getCurrentUserInfo
Get current user details
→ 200401405500
GET
/accounts
List all available accounts for the user
1 param → 200400401405500
POST
/switchAccount
Change user's current account
body → 200400401500
Branch Services 1
GET
/branchlist
List all available branches
4 params → 200401405500
Job Service 1
GET
/jobs
List available jobs for an account and provide the job name and number combination rule.
3 params → 200400401405500
Order History Services 2
GET
/orderhistory
List all the orders in the account
6 params → 200400401403500
GET
/orderdetail
Get details of the order by Id
4 params → 200400401403500
Catalog ITEM Services 6
GET
/itemlist
Get list of items
9 params → 200400401405500
GET
/items
Get items details
6 params → 200400401405500
GET
/getProductInfo
Get product and related accounts info
2 params → 200401405500
GET
/getSkuUom
Get all the Unit of Measure (UoM) for a given sku ids
2 params → 200401405500
GET
/pricing
Get price and Unit of Measures (UoMs) for multiple line items
3 params → 200401405500
GET
/cartItems
Get items in the cart
→ 200401405500
Submit Order Services 1
POST
/submitOrder
Submit order
body → 200401403405500
Add Multiple Items To Order 1
POST
/addMultipleItemsToOrder
Add item(s) to cart
1 param body → 200400401500
Template Services 1
GET
/template
List all templates and details for the current user
8 params → 200401405500

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are getCurrentUserInfoRep (32 properties), hoverAttributesObj (26 properties), orderHistoryObj (20 properties), DTInfoObj (19 properties). Each schema is shown below with its type and property counts.

branchObj
object
17 properties
branchAddressObj
object
8 properties
jobObj
object
2 properties
accountObj
object
14 properties
accountObjWithRewardsEligible
object
14 properties
accountWithBranchObj
object
16 properties
customerType
object
3 properties
orderHistoryObj
object
20 properties
orderHistoryLineItemObj
object
13 properties
jobRows
object
5 properties
orderHistoryRows
object
5 properties
categoryObj
object
2 properties
productObj_itemlist
object
14 properties
productObj_itemDetails
object
16 properties
hoverAttributesObj
object
26 properties
heroImagesObj
object
currentSkuObj
object
14 properties
skuObj
object
12 properties
dtStatusObj
object
2 properties
deviceTokenObj
object
5 properties
deliveryTrackingSettingsObj_getCurrentUserInfo
object
5 properties
currentUserPermissionObj
object
2 properties
loginReq
object
6 properties
loginRep
object
1 property
getLoginDeclarationRep
object
4 properties
getCurrentUserInfoRep
object
32 properties
accountsRep
object
4 properties
branchlistRep
object
4 properties
jobsRep
object
9 properties
orderhistoryRep
object
3 properties
orderdetailRep
object
10 properties
didYouMeanAndAutoCorrectionObj
object
2 properties
itemlistRep
object
7 properties
itemDetailsRep
object
6 properties
submitOrderReq
object
16 properties
submitOrderRep
object
2 properties
creditpurchase_req
object
3 properties
addItemsToOrderReq
object
6 properties
addTocartItem
object
7 properties
shippingObj
object
3 properties
addItemsToOrderRep
object
1 property
templatelistRep
object
4 properties
templateListObj
object
10 properties
templateListItemObj
object
15 properties
imageUrlObj
object
2 properties
profileObj
object
4 properties
variationTypeObj
object
3 properties
variationOptionObj
object
4 properties
getProductInfoRep
object
3 properties
pricingRep
object
2 properties
cartItemsRep
object
2 properties
cartItemsFullRep
object
5 properties
getSkuUomRep
object
2 properties
DTInfoObj
object
19 properties
DTAddressInfoObj
object
9 properties
DTLineItemObj
object
5 properties
cartItemList
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beacon-roofing-supply-v1-openapi.yml Raw ↑

Other APIs Beacon Roofing Supply publishes across the network.

Beacon PRO+ API (V2, OAuth)
Beacon External Rest Service (all_api)
Beacon Rest Services V3 (Public / Integrations)
Beacon OAuth Rest Service
Beacon Rest Services Public
Beacon Internal Rest Service
Where this information came from

This is an independent, third-party profile of Beacon Rest Services V1 (session), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.