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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Beacon Roofing Supply

Beacon External Rest Service (all_api)

The combined Beacon Rest Services document — 145 operations spanning the V1, V2, V3 and V4 tags plus the Integrations and Beacon Stack surfaces. It is the ONLY Beacon document that assigns operationIds (V1Controller_*, V2Controller_*, V3Controller_*, V4Controller_*), which makes it the document any SDK generator, tool crosswalk or workflow definition has to bind to. It also carries the API Site ID resolution rules, the uniform response envelope, the numeric message-code registry and the field glossary inside its info.description.

Documentation Provider Profile APIs.io OpenAPI GitHub

Beacon External Rest Service (all_api) 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 145 operations across 147 paths, organized into 6 resource areas, and defines 304 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

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

145 operations 147 paths 304 schemas 67 GET78 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://beaconproplus.com
Resource Areas
6

Paths & Operations 145

Across 147 paths, the API surfaces 145 operations — 67 GET, 78 POST. They span 6 resource areas: V1, V2, V3, V4, Beacon Stack (BASE URL:- https://beacon-api-x7xzzdp35a-uk.a.run.app), Integrations - Development. Each is listed below with its method, path, parameters, and response codes.

V1 10
POST
/login
Logs user into system
V1Controller_login body → 200400401405500
POST
/logout
Logs user out of system
V1Controller_logout → 200400401405500
GET
/getLoginDeclaration
Returns Terms and Conditions for persistent login
V1Controller_getLoginDeclaration 3 params → 200400401405500
GET
/accounts
Lists available accounts for a user
V1Controller_accounts 1 param → 200400401405500
POST
/switchAccount
Changes account for a user
V1Controller_switchAccount body → 200400401405500
GET
/branchlist
Lists all available branches
V1Controller_branchlist 4 params → 200400401405500
GET
/jobs
Lists available job names for an account
V1Controller_jobs 1 param → 200400401405500
GET
/items
Returns item details
V1Controller_items 6 params → 200400401405500
GET
/getProductInfo
Returns list of accounts by Product Id
V1Controller_getProductInfo 2 params → 200400401405500
GET
/getSkuUom
Returns Unit of Measures (UoM) for an item number
V1Controller_getSkuUom 2 params → 200400401405500
V2 126
GET
/getCurrentUserInfo
Returns user details
V2Controller_getCurrentUserInfo → 200400401405500
GET
/orderhistory
Returns orders listed by order id
V2Controller_orderhistory 5 params → 200400401405500
GET
/orderdetail
Returns order details by order Id
V2Controller_orderdetail 4 params → 200400401405500
GET
/pricing
Returns price and unit of measure for item number(s)
V2Controller_pricing 3 params → 200400401405500
GET
/cartItems
Retrieves items from cart
V2Controller_cartItems 1 param → 200400401405500
POST
/submitOrder
Submits order
V2Controller_submitOrder body → 200400401405500
POST
/addMultipleItemsToOrder
Adds multiple items to the cart
V2Controller_addMultipleItemsToOrder 1 param body → 200400401405500
GET
/template
Lists templates and template details for current user
V2Controller_template 11 params → 200400401405500
POST
/hoverExplicitLogin
Hover explicit login
V2Controller_hoverExplicitLogin body → 200400401405500
POST
/saveCurrentUserInfo
Saves current user details
V2Controller_saveCurrentUserInfo body → 200400401405500
GET
/getCurrentUserPermission
Returns current user permissions
V2Controller_getCurrentUserPermission → 200400401405500
GET
/getAddressBook
Returns address book for current user
V2Controller_getAddressBook 1 param → 200400401405500
POST
/createAddressBook
Creates new address in the address book
V2Controller_createAddressBook body → 200400401405500
POST
/updateAddressBook
Updates address in the address book
V2Controller_updateAddressBook body → 200400401405500
POST
/deleteAddressBook
Deletes address in the address book
V2Controller_deleteAddressBook body → 200400401405500
POST
/changePassword
Change password
V2Controller_changePassword body → 200400401405500
POST
/setPassword
Sets password for new user
V2Controller_setPassword body → 200400401405500
POST
/resetPassword
Resets password for current user
V2Controller_resetPassword body → 200400401405500
POST
/forgotPassword
Sends forgot password email
V2Controller_forgotPassword body → 200400401405500
POST
/user
Returns a list of users for an account
V2Controller_user body → 200400401405500
GET
/getUserDetail
Returns user details by profile id.
V2Controller_getUserDetail 1 param → 200400401405500
POST
/createUser
Creates a new user account
V2Controller_createUser body → 200400401405500
POST
/updateUser
Updates user information
V2Controller_updateUser body → 200400401405500
GET
/organization
Returns list of organizations for current user
V2Controller_organization → 200400401405500
GET
/role
Returns role and permissions for current user
V2Controller_role → 200400401405500
POST
/permissionTemplateList
Returns list of permissions templates
V2Controller_permissionTemplateList body → 200400401405500
POST
/getPermissionTemplateDetail
Returns details for permissions templates
V2Controller_getPermissionTemplateDetail 1 param → 200400401405500
POST
/createPermissionTemplate
Creates permissions template
V2Controller_createPermissionTemplate body → 200400401405500
POST
/updatePermissionTemplate
Updates permissions template
V2Controller_updatePermissionTemplate body → 200400401405500
POST
/deletePermissionTemplate
Removes permissions template
V2Controller_deletePermissionTemplate body → 200400401405500
GET
/orderhistory_v2
Returns orders listed by order id
V2Controller_orderhistory_v2 9 params → 200400401405500
GET
/downloadOrderDetailAsPDF
Returns order detail in PDF
V2Controller_downloadOrderDetailAsPDF 9 params → 200400401405500
GET
/getDTOrderDetail
Returns delivery tracking order information by order Id
V2Controller_getDTOrderDetail 2 params → 200400401405500
GET
/typeAhead
Returns like products in search
V2Controller_typeAhead 3 params → 200400401405500
GET
/getProductVariation
Returns product variations by product Id
V2Controller_getProductVariation 3 params → 200400401405500
GET
/getQuoteProductVariation
Returns product variation for quote
V2Controller_getQuoteProductVariation 4 params → 200400401405500
POST
/getMultipleProductVariation
Returns product variation by product Id
V2Controller_getMultipleProductVariation body → 200400401405500
POST
/getMultipleQuoteProductVariation
Returns product variation for quote
V2Controller_getMultipleQuoteProductVariation body → 200400401405500
GET
/getFavoriteProducts
Returns favorite products
V2Controller_getFavoriteProducts 3 params → 200400401405500
GET
/categories
Returns all categories and placement in hierarchy
V2Controller_categories 4 params → 200400401405500
GET
/getProductBranchOrRegionAvailability
Returns product availability for a branch
V2Controller_getProductBranchOrRegionAvailability 4 params → 200400401405500
GET
/getSKUBranchOrRegionAvailability
Returns product availability for a branch
V2Controller_getSKUBranchOrRegionAvailability 4 params → 200400401405500
POST
/updateOrderAlert
Updates order alert
V2Controller_updateOrderAlert body → 200400401405500
POST
/uploadOrderRelatedDocuments
Uploads order related documents
V2Controller_uploadOrderRelatedDocuments 2 params → 200400401405500
POST
/deleteOrderRelatedDocuments
Removes order related documents
V2Controller_deleteOrderRelatedDocuments → 200400401405500
GET
/downloadOrderDocument
Downloads order related document
V2Controller_downloadOrderDocument 2 params → 200400401405500
GET
/getGenericBrands
Returns list of brands
V2Controller_getGenericBrands → 200400401405500
GET
/orderSummary
Returns order total for current items in cart
V2Controller_orderSummary → 200400401405500
POST
/clearCart
Clears items in the current cart
V2Controller_clearCart → 200400401405500
POST
/removeItemFromCart
Removes a single item from cart
V2Controller_removeItemFromCart body → 200400401405500
POST
/updateCart
Updates quantities for items in a cart
V2Controller_updateCart body → 200400401405500
POST
/proceedToCheckout
Proceeds to check out page
V2Controller_proceedToCheckout → 200400401405500
POST
/updateCurrentOrderJobNumber
Updates job number for current order
V2Controller_updateCurrentOrderJobNumber body → 200400401405500
GET
/getOrderShippingInfo
Returns current order shipping information
V2Controller_getOrderShippingInfo → 200400401405500
POST
/addOrderShippingInfo
Updates or adds shipping info for current order
V2Controller_addOrderShippingInfo body → 200400401405500
GET
/getCurrentOrderReview
Returns order information
V2Controller_getCurrentOrderReview → 200400401405500
POST
/submitCurrentOrder
Submits current order
V2Controller_submitCurrentOrder body → 200400401405500
POST
/getSubmitOrderResult
Returns order results
V2Controller_getSubmitOrderResult body → 200400401405500
GET
/validateOrderByLocation
Validates inventory at pick up location
V2Controller_validateOrderByLocation 4 params → 200400401405500
GET
/getTemplateDetail
Returns template details for a given template
V2Controller_getTemplateDetail 8 params → 200400401405500
POST
/createTemplate
Creates template for current user
V2Controller_createTemplate 2 params body → 200400401405500
POST
/updateTemplate
Updates template
V2Controller_updateTemplate 2 params body → 200400401405500
POST
/deleteTemplate
Deletes template
V2Controller_deleteTemplate 3 params → 200400401405500
POST
/copyTemplate
Copies template
V2Controller_copyTemplate 3 params → 200400401405500
POST
/validateTemplateItems
Validates template items
V2Controller_validateTemplateItems 1 param body → 200400401405500
POST
/saveOrder
Creates new saved order and saves cart items to this order
V2Controller_saveOrder body → 200400401405500
POST
/getOrderApprovalList
Returns list of all saved or pending orders
V2Controller_getOrderApprovalList body → 200400401405500
GET
/getOrderApprovalDetail
Returns saved or pending order details and makes order confirmation page for submitter
V2Controller_getOrderApprovalDetail 3 params → 200400401405500
POST
/rejectSavedOrder
Allows approver to reject pending order
V2Controller_rejectSavedOrder body → 200400401405500
POST
/deleteSavedOrder
Deletes saved order
V2Controller_deleteSavedOrder body → 200400401405500
POST
/updateSavedOrderItems
Updates saved or pending order items
V2Controller_updateSavedOrderItems body → 200400401405500
POST
/getSavedOrderShippingInfo
Returns saved or pending order shipping information
V2Controller_getSavedOrderShippingInfo body → 200400401405500
POST
/updateSavedOrderShippingInfo
Returns saved or pending order shipping information
V2Controller_updateSavedOrderShippingInfo body → 200400401405500
POST
/getSavedOrderReviewInfo
Returns saved or pending order review information
V2Controller_getSavedOrderReviewInfo body → 200400401405500
POST
/submitSavedOrder
Submits or revises saved order
V2Controller_submitSavedOrder body → 200400401405500
POST
/approveSavedOrder
Approves saved or pending order
V2Controller_approveSavedOrder body → 200400401405500
POST
/getSavedOrderConfirmationInfo
Returns saved or pending order confirmation information
V2Controller_getSavedOrderConfirmationInfo body → 200400401405500
GET
/saveOrderValidate
Validates the saved or pending order
V2Controller_saveOrderValidate 1 param → 200400401405500
GET
/approver
Returns list of approvers for current user
V2Controller_approver 1 param → 200400401405500
POST
/updateStatusChange
Updates delivery tracking status for current user
V2Controller_updateStatusChange body → 200400401405500
GET
/getStatusChange
Returns delivery status change for an order
V2Controller_getStatusChange 4 params → 200400401405500
GET
/quote
Returns list of quotes for current user
V2Controller_quote 7 params → 200400401405500
POST
/getQuoteDetail
Returns quote details for given quote
V2Controller_getQuoteDetail 2 params → 200400401405500
POST
/getMincronQuoteDetail
Returns quote details for specific quote Id
V2Controller_getMincronQuoteDetail 2 params → 200400401405500
GET
/getAtgQuoteDetail
Returns Atg quote details for given quote
V2Controller_getAtgQuoteDetail 2 params → 200400401405500
POST
/createQuote
Creates quote for current user
V2Controller_createQuote body → 200400401405500
POST
/updateQuote
Updates quote information
V2Controller_updateQuote body → 200400401405500
POST
/deleteQuote
Removes quotes for current user
V2Controller_deleteQuote body → 200400401405500
POST
/submitQuote
Submits quote
V2Controller_submitQuote body → 200400401405500
POST
/submitQuoteForm
Submits quote form
V2Controller_submitQuoteForm 6 params → 200400401405500
POST
/approveQuote
Approves quote
V2Controller_approveQuote body → 200400401405500
POST
/reviseQuote
Revises quote
V2Controller_reviseQuote body → 200400401405500
POST
/rejectQuote
Rejects quote
V2Controller_rejectQuote body → 200400401405500
GET
/downloadQuoteAsPDF
Downloads quote in PDF
V2Controller_downloadQuoteAsPDF 4 params → 200400401405500
GET
/rebateLanding
Returns rebate landing page
V2Controller_rebateLanding → 200400401405500
GET
/getRebateRedeemedSummaryItems
Returns redeemed rebate information for current user
V2Controller_getRebateRedeemedSummaryItems → 200400401405500
POST
/getRebateRedeemedItemDetail
Returns redeemed rebate details
V2Controller_getRebateRedeemedItemDetail body → 200400401405500
GET
/getRebateForm
Returns rebate form
V2Controller_getRebateForm 2 params → 200400401405500
POST
/submitRebate
Submits rebate request
V2Controller_submitRebate body → 200400401405500
GET
/suggestiveSelling
Returns suggestive selling information
V2Controller_suggestiveSelling 9 params → 200400401405500
GET
/getHoverJobList
Returns Hover job addresses
V2Controller_getHoverJobList 4 params → 200400401405500
GET
/getHoverJobListImage
Returns the Hover job image
V2Controller_getHoverJobListImage 1 param → 200400401405500
GET
/getHoverJobDetail
Returns detailed information for a Hover job
V2Controller_getHoverJobDetail 1 param → 200400401405500
GET
/getHoverJobDetailImage
Returns Hover job image
V2Controller_getHoverJobDetailImage 1 param → 200400401405500
GET
/downloadBeacon3DplusApp
Sends SMS to end user
V2Controller_downloadBeacon3DplusApp 1 param → 200400401405500
GET
/getUserRegisterToken
Returns token for registered user
V2Controller_getUserRegisterToken → 200400401405500
POST
/validateUserByEmail
Validates user by email
V2Controller_validateUserByEmail body → 200400401405500
POST
/validateUserByAccount
Validates user by account information
V2Controller_validateUserByAccount body → 200400401405500
POST
/register
Registers user
V2Controller_register body → 200400401405500
POST
/queryQuoteStatus
Returns quote status
V2Controller_queryQuoteStatus 1 param → 200400401405500
POST
/convertQuoteOrder
Converts quote to quote order
V2Controller_convertQuoteOrder 1 param → 200400401405500
GET
/getQuoteOrderDetail
Returns order details for a quote
V2Controller_getQuoteOrderDetail 1 param → 200400401405500
POST
/updateQuoteOrder
Updates quote draft
V2Controller_updateQuoteOrder body → 200400401405500
POST
/updateQuoteOrderShippingInfo
Updates quote order shipping information
V2Controller_updateQuoteOrderShippingInfo body → 200400401405500
GET
/getQuoteOrderPrice
Returns quote order pricing
V2Controller_getQuoteOrderPrice 2 params → 200400401405500
POST
/placeQuoteOrder
Submits the quote into an order
V2Controller_placeQuoteOrder body → 200400401405500
POST
/submitQuoteOrderForApproval
Converts quote order to a saved order and sends saved order for approval
V2Controller_submitQuoteOrderForApproval body → 200400401405500
GET
/getCurrentUserLastSelectedJobInfo
Returns last selected job information for current user
V2Controller_getCurrentUserLastSelectedJobInfo 1 param → 200400401405500
POST
/placeEagleViewOrder
Creates an Eagle View order
V2Controller_placeEagleViewOrder body → 200400401405500
POST
/placeEagleViewUpgradeOrder
Upgrades a report to a premium report
V2Controller_placeEagleViewUpgradeOrder body → 200400401405500
GET
/getEagleViewOrderReport
Returns information for an Eagle View report
V2Controller_getEagleViewOrderReport 1 param → 200400401405500
GET
/getEagleViewOrderUpgradeProducts
Returns product upgrades for an Eagle View report
V2Controller_getEagleViewOrderUpgradeProducts 1 param → 200400401405500
GET
/getEagleViewOrderReportV3
Returns information for an Eagle View report
V2Controller_getEagleViewOrderReportV3 1 param → 200400401405500
GET
/getOktaEagleViewLoginUrl
Generates current user okta eagle view redirect URL
V2Controller_getOktaEagleViewLoginUrl → 200400401405500
GET
/exchangeOktaEagleViewAuthorizationCode
Returns access token by authorization code
V2Controller_exchangeOktaEagleViewAuthorizationCode → 200400401405500
GET
/unlinkEVAccount
Unlinks current user’s Eagleview account
V2Controller_unlinkEVAccount → 200400401405500
V3 4
GET
/itemlist
Get list of items
V3Controller_itemlist 12 params → 200400401405500
GET
/itemDetails
Get items details
V3Controller_itemDetails 6 params → 200400401405500
GET
/downloadCatalogItemData
Downloads catalog item data
V3Controller_downloadCatalogItemData 6 params → 200400401405500
GET
/mincronMapping
Returns Mincron mapping products
V3Controller_mincronMapping 1 param → 200400401405500
V4 1
GET
/V4/healthCheck
Check if becn.com and mincron are up and running
V4Controller_healthCheck 2 params → 200
Beacon Stack (BASE URL:- https://beacon-api-x7xzzdp35a-uk.a.run.app) 2
POST
/api/address-validation/getaddress
AddressValidationController_getAddress → 201
POST
/api/address-validation/getstreetwildsearch
AddressValidationController_getStreetWildSearch → 201
Integrations - Development 2
GET
/api/integrations/itemlist
IntegrationsController_test → 200
POST
/api/integrations/submitOrder
IntegrationsController_submitOrder → 201

Schemas 304

The contract defines 304 schemas that model the data the API accepts and returns. The most detailed are getSavedOrderConfirmationInfoResponse (59 properties), getEagleViewOrderReportV3Response (56 properties), getQuoteOrderDetailResponse (56 properties), getOrderApprovalDetailResponse (51 properties). Each schema is shown below with its type and property counts.

login
object
5 properties 5 required
Address
object
7 properties 7 required
AccountBranch
object
10 properties 10 required
LastSelectedAccount
object
7 properties 7 required
MessageInfo
object
9 properties 9 required
loginResponse
object
1 property 1 required
logoutResponse
object
1 property 1 required
getLoginDeclarationResponse
object
4 properties 4 required
MyOrders
object
3 properties 3 required
DeliveryTrackingSettings
object
5 properties 5 required
getCurrentUserInfoResponse
object
29 properties 29 required
Branch
object
10 properties 10 required
Account
object
9 properties 9 required
accountResponse
object
4 properties 4 required
switchAccountBody
object
1 property 1 required
switchAccountResponse
object
21 properties 21 required
branchListResponse
object
4 properties 4 required
Job
object
2 properties 2 required
jobsResponse
object
5 properties 5 required
Shipping
object
3 properties 3 required
Order
object
15 properties 15 required
Result
object
5 properties 5 required
orderHistoryResponse
object
3 properties 3 required
LineItem
object
13 properties 13 required
Destination
object
9 properties 9 required
Photo
object
3 properties 3 required
Line
object
5 properties 5 required
DTInfo
object
19 properties 19 required
orderDetailResponse
object
8 properties 8 required
Item
object
1 property 1 required
DidYouMean
object
2 properties 2 required
Category
object
2 properties 2 required
HoverAttributes
object
26 properties 26 required
Item2
object
12 properties 12 required
itemListResponse
object
8 properties 8 required
Product
object
15 properties 15 required
Specification
object
8 properties 8 required
Resource
object
4 properties 4 required
CurrentSKU
object
13 properties 13 required
SkuList
object
11 properties 11 required
getItemsResponse
object
6 properties 6 required
getProductInfoResponse
object
3 properties 3 required
SkuIdsUomList
object
3 properties 3 required
getSkuUomResponse
object
2 properties 2 required
253729
object
2 properties 2 required
253737
object
1 property 1 required
253740
object
2 properties 2 required
PriceInfo
object
3 properties 3 required
pricingResponse
object
3 properties 3 required
LastSelectedJob
object
2 properties 2 required
cartItemsResponse
object
5 properties 5 required
submitOrderBody
object
14 properties 14 required
submitOrderResponse
object
1 property 1 required
addMultipleItemsToOrderBody
object
6 properties 6 required
addMultipleItemsToOrderResponse
object
4 properties 4 required
LastModifiedUser
object
4 properties 4 required
Option
object
4 properties 4 required
CurrentVariation
object
3 properties 3 required
ImageUrl
object
2 properties 2 required
TemplateItem
object
15 properties 15 required
Template
object
9 properties 9 required
templateResponse
object
4 properties 4 required
hoverExplicitLoginBody
object
7 properties 7 required
hoverExplicitLoginResponse
object
1 property 1 required
SubscribEmailType
object
3 properties 3 required
ContactAddress
object
10 properties 10 required
saveCurrentUserInfoBody
object
15 properties 15 required
Price
object
2 properties 2 required
OrderHistory
object
3 properties 3 required
Quotes
object
3 properties 3 required
Original
object
5 properties 5 required
Orderhistory
object
4 properties 4 required
Quote
object
12 properties 12 required
Rebate
object
7 properties 7 required
Computed
object
5 properties 5 required
getCurrentUserPermissionResponse
object
2 properties 2 required
Message
object
3 properties 3 required
AddressBookInfo
object
12 properties 12 required
AddressBook
object
4 properties 4 required
getAddressBookResponse
object
4 properties 4 required
createAddressBookBody
object
10 properties 10 required
createAddressBookResponse
object
4 properties 4 required
updateAddressBookBody
object
2 properties 2 required
updateAddressBookResponse
object
3 properties 3 required
deleteAddressBookBody
object
1 property 1 required
deleteAddressBookResponse
object
3 properties 3 required
changePasswordBody
object
3 properties 3 required
changePasswordResponse
object
3 properties 3 required
setPasswordBody
object
3 properties 3 required
setPasswordResponse
object
3 properties 3 required
resetPasswordBody
object
3 properties 3 required
resetPasswordResponse
object
3 properties 3 required
forgotPasswordBody
object
1 property 1 required
forgotPasswordResponse
object
3 properties 3 required
Value
object
Or
object
3 properties 3 required
Query
object
6 properties 6 required
userBody
object
1 property 1 required
Next
object
3 properties 3 required
Pagination
object
6 properties 6 required
User
object
6 properties 6 required
userResponse
object
2 properties 2 required
Permission
object
9 properties 9 required
Permission2
object
4 properties 4 required
Role
object
3 properties 3 required
PermissionValues
object
3 properties 3 required
MasterAdmin
object
20 properties 20 required
Org
object
3 properties 3 required
PermissionTemplate
object
6 properties 6 required
getUserDetailResponse
object
21 properties 21 required
createUserBody
object
11 properties 11 required
createUserResponse
object
1 property 1 required
updateUserBody
object
12 properties 12 required
organizationResponse
object
3 properties 3 required
roleResponse
object
3 properties 3 required
permissionTemplateListBody
object
4 properties 4 required
PermssionTemplate
object
6 properties 6 required
permissionTemplateListResponse
object
2 properties 2 required
getPermissionTemplateDetailResponse
object
6 properties 6 required
createPermissionTemplateBody
object
2 properties 2 required
createPermissionTemplateResponse
object
1 property 1 required
updatePermissionTemplateBody
object
3 properties 3 required
deletePermissionTemplateBody
object
1 property 1 required
orderhistoryResponse
object
2 properties 2 required
orderHistoryv2Response
object
2 properties 2 required
Info
object
5 properties 5 required
DTStatus
object
5 properties 5 required
DTPhoto
object
3 properties 3 required
orderdetailResponse
object
9 properties 9 required
getDTOrderDetailResponse
object
5 properties 5 required
typeAheadResponse
object
2 properties 2 required
Category2
object
4 properties 4 required
Child
object
4 properties 4 required
Child2
object
5 properties 5 required
Category3
object
4 properties 4 required
Facets
object
4 properties 4 required
Color
object
2 properties 2 required
Size
object
2 properties 2 required
Thickness
object
3 properties 3 required
Variations2
object
3 properties 3 required
itemDetailsResponse
object
7 properties 7 required
2537292
object
1 property 1 required
2537402
object
1 property 1 required
OrderPricing
object
3 properties 3 required
300003
object
3 properties 3 required
Skus
object
3 properties 3 required
Variations
object
3 properties 3 required
VendorColor
object
6 properties 6 required
CurrentVariations
object
7 properties 7 required
VariationGroup
object
1 property 1 required
ProductMultiVariation
object
10 properties 10 required
VariationContentKeyMap
object
getProductVariationResponse
object
3 properties 3 required
getQuoteProductVariationResponse
object
3 properties 3 required
getMultipleProductVariationBody
object
3 properties 3 required
getMultipleProductVariationResponse
object
3 properties 3 required
getMultipleQuoteProductVariationBody
object
4 properties 4 required
getMultipleQuoteProductVariationResponse
object
3 properties 3 required
getFavoriteProductsResponse
object
2 properties 2 required
categoriesResponse
object
1 property 1 required
getProductBranchOrRegionAvailabilityResponse
object
2 properties 2 required
getSKUBranchOrRegionAvailabilityResponse
object
2 properties 2 required
updateOrderAlertBody
object
7 properties 7 required
orderSummaryResponse
object
6 properties 6 required
clearCartResponse
object
3 properties 2 required
removeItemFromCartBody
object
1 property 1 required
updateCartBody
object
1 property 1 required
proceedToCheckoutResponse
object
1 property 1 required
updateCurrentOrderJobNumberBody
object
1 property 1 required
DeliveryOption
object
3 properties 3 required
ShippingAddress
object
14 properties 14 required
ShippingAddress2
object
8 properties 8 required
ContactInfo
object
4 properties 4 required
AddressBook2
object
4 properties 4 required
BranchAddress
object
10 properties 10 required
getOrderShippingInfoResponse
object
15 properties 15 required
addOrderShippingInfoBody
object
8 properties 8 required
JobAccounts
object
3 properties 3 required
PoJob
object
9 properties 9 required
NextPage
object
1 property 1 required
getCurrentOrderReviewResponse
object
10 properties 10 required
submitCurrentOrderBody
object
7 properties 7 required
OrderSummary
object
6 properties 6 required
submitCurrentOrderResponse
object
17 properties 17 required
getSubmitOrderResultBody
object
2 properties 2 required
getSubmitOrderResultResponse
object
9 properties 9 required
UnavailableItem
object
2 properties 2 required
VendorColorNotMatchedItem
object
3 properties 3 required
getTemplateDetailResponse
object
9 properties 9 required
createTemplateBody
object
3 properties 3 required
createTemplateResponse
object
10 properties 10 required
updateTemplateBody
object
5 properties 5 required
updateTemplateResponse
object
9 properties 9 required
validateTemplateItemsBody
object
2 properties 2 required
InvalidTemplateItem
object
1 property 1 required
validateTemplateItemsResponse
object
1 property 1 required
saveOrderBody
object
5 properties 5 required
saveOrderResponse
object
2 properties 2 required
getOrderApprovalListBody
object
8 properties 8 required
getOrderApprovalListResponse
object
2 properties 2 required
getOrderApprovalDetailResponse
object
51 properties 51 required
rejectSavedOrderBody
object
2 properties 2 required
deleteSavedOrderBody
object
1 property 1 required
updateSavedOrderItemsBody
object
4 properties 4 required
Items
object
15 properties 15 required
updateSavedOrderItemsResponse
object
3 properties 3 required
getSavedOrderShippingInfoBody
object
1 property 1 required
AssignApproval
object
3 properties 3 required
CommerceItem
object
15 properties 15 required
getSavedOrderShippingInfoResponse
object
49 properties 49 required
updateSavedOrderShippingInfoBody
object
9 properties 9 required
getSavedOrderReviewInfoBody
object
1 property 1 required
getSavedOrderReviewInfoResponse
object
49 properties 49 required
submitSavedOrderBody
object
6 properties 6 required
approveSavedOrderBody
object
6 properties 6 required
getSavedOrderConfirmationInfoBody
object
1 property 1 required
ShippingMethod
object
3 properties 3 required
RequiredFields
object
22 properties 22 required
getSavedOrderConfirmationInfoResponse
object
59 properties 59 required
approverResponse
object
4 properties 4 required
DtStatusChangeNotification
object
3 properties 3 required
DtAccountStatusChangeNotification
object
4 properties 4 required
updateStatusChangeBody
object
5 properties 5 required
updateStatusChangeResponse
object
2 properties 2 required
Notification
object
3 properties 3 required
DtStatusChangeNotifacation
object
3 properties 3 required
DtOrderStatusChangeNotifacation
object
1 property 1 required
getStatusChangeResponse
object
8 properties 8 required
QuoteList
object
5 properties 5 required
DraftQuote
object
2 properties 2 required
quoteResponse
object
6 properties 6 required
getMincronQuoteDetailResponse
object
1 property 1 required
getAtgQuoteDetailResponse
object
1 property 1 required
QuoteItem
object
7 properties 7 required
createQuoteBody
object
20 properties 20 required
createQuoteResponse
object
3 properties 3 required
updateQuoteBody
object
24 properties 24 required
deleteQuoteBody
object
1 property 1 required
submitQuoteBody
object
20 properties 20 required
submitQuoteResponse
object
3 properties 3 required
approveQuoteBody
object
1 property 1 required
reviseQuoteBody
object
2 properties 2 required
rejectQuoteBody
object
2 properties 2 required
rebateLandingResponse
object
5 properties 5 required
getRebateRedeemedSummaryItemsResponse
object
10 properties 10 required
getRebateRedeemedItemDetailBody
object
4 properties 4 required
Header
object
10 properties 10 required
Body
object
17 properties 17 required
getRebateRedeemedItemDetailResponse
object
3 properties 3 required
SelectValue
object
2 properties 2 required
Row
object
17 properties 17 required
getRebateFormResponse
object
4 properties 4 required
RebateInfo
object
4 properties 4 required
RebateAddress
object
4 properties 4 required
RebateCustomInfo
object
submiteRebateBody
object
5 properties 5 required
DefaultItem
object
6 properties 6 required
suggestiveSellingResponse
object
5 properties 5 required
getHoverJobListResponse
object
2 properties 2 required
Image
object
1 property 1 required
getHoverJobDetailResponse
object
49 properties 49 required
UserRegInfo
object
1 property 1 required
getUserRegisterTokenResponse
object
1 property 1 required
validateUserByEmailBody
object
6 properties 6 required
BranchSelection
object
3 properties 3 required
validateUserByEmailResponse
object
10 properties 10 required
validateUserByAccountBody
object
5 properties 5 required
validateUserByAccountResponse
object
10 properties 10 required
AccountInfo
object
3 properties 3 required
registerBody
object
12 properties 12 required
registerResponse
object
5 properties 5 required
queryQuoteStatusResponse
object
3 properties 3 required
getQuoteOrderDetailResponse
object
56 properties 56 required
updateQuoteOrderBody
object
3 properties 3 required
updateQuoteOrderResponse
object
2 properties 2 required
updateQuoteOrderShippingInfoBody
object
9 properties 9 required
getQuoteOrderPriceResponse
object
8 properties 8 required
placeQuoteOrderBody
object
5 properties 5 required
submitQuoteOrderForApprovalBody
object
7 properties 7 required
submitQuoteOrderForApprovalResponse
object
1 property 1 required
getCurrentUserLastSelectedJobInfoResponse
object
12 properties 12 required
ReportAddress
object
7 properties 7 required
ReportAttibute
object
2 properties 2 required
OrderReport
object
24 properties 24 required
placeEagleViewOrderBody
object
8 properties 8 required
ModelState
object
2 properties 2 required
placeEagleViewOrderResponse
object
4 properties 4 required
placeEagleViewUpgradeOrderBody
object
12 properties 12 required
placeEagleViewUpgradeOrderResponse
object
3 properties 3 required
ReportImage
object
11 properties 11 required
getEagleViewOrderReportResponse
object
39 properties 39 required
DeliveryProduct
object
8 properties 8 required
AvailableProduct
object
15 properties 15 required
CurrentOrder
object
12 properties 12 required
getEagleViewOrderUpgradeProductsResponse
object
2 properties 2 required
DeliveryFilesAvailable
object
2 properties 2 required
MeasurementByStructure
object
8 properties 8 required
AddOnProduct
object
2 properties 2 required
From
object
3 properties 3 required
ProductSubstitution
object
2 properties 2 required
getEagleViewOrderReportV3Response
object
56 properties 56 required
getOktaEagleViewLoginUrlResponse
object
1 property 1 required
exchangeOktaEagleViewAuthorizationCodeResponse
object
2 properties 2 required
mincronMappingResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beacon-roofing-supply-all-api-openapi.yml Raw ↑

Other APIs Beacon Roofing Supply publishes across the network.

Beacon PRO+ API (V2, OAuth)
AE Profile APIs.io
Beacon Rest Services V3 (Public / Integrations)
AE Profile APIs.io
Beacon Rest Services V1 (session)
AE Profile APIs.io
Beacon OAuth Rest Service
AE Profile APIs.io
Beacon Rest Services Public
AE Profile APIs.io
Beacon Internal Rest Service
AE Profile APIs.io
#Construction#Roofing#Distribution#E-Commerce#Order
← Back to B APIs
API Details
ID
beacon-roofing-supply:beacon-rest-all-api
Base URL
https://beaconproplus.com
Docs
https://beaconproplus.com/swagger/all_api/
Provider
Beacon Roofing Supply
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=beacon-rest-all-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/beacon-rest-all-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Beacon External Rest Service (all_api), 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.