# Beacon External Rest Service (all_api)

**Canonical:** https://apis.io/apis/beacon-roofing-supply/beacon-rest-all-api/  
**Provider:** Beacon Roofing Supply — https://apis.io/providers/beacon-roofing-supply/  
**Base URL:** https://beaconproplus.com  
**Documentation:** https://beaconproplus.com/swagger/all_api/

Beacon External Rest Service (all_api) is one of 7 APIs that [Beacon Roofing Supply](https://apis.io/providers/beacon-roofing-supply/) publishes on the [APIs.io](https://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.

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.

## Operations (60 of 145)

| Method | Path | Summary |
|---|---|---|
| POST | `/login` | Logs user into system |
| POST | `/logout` | Logs user out of system |
| GET | `/getLoginDeclaration` | Returns Terms and Conditions for persistent login |
| GET | `/accounts` | Lists available accounts for a user |
| POST | `/switchAccount` | Changes account for a user |
| GET | `/branchlist` | Lists all available branches |
| GET | `/jobs` | Lists available job names for an account |
| GET | `/items` | Returns item details |
| GET | `/getCurrentUserInfo` | Returns user details |
| GET | `/orderhistory` | Returns orders listed by order id |
| GET | `/orderdetail` | Returns order details by order Id |
| GET | `/itemlist` | Get list of items |
| GET | `/getProductInfo` | Returns list of accounts by Product Id |
| GET | `/getSkuUom` | Returns Unit of Measures (UoM) for an item number |
| GET | `/pricing` | Returns price and unit of measure for item number(s) |
| GET | `/cartItems` | Retrieves items from cart |
| POST | `/submitOrder` | Submits order |
| POST | `/addMultipleItemsToOrder` | Adds multiple items to the cart |
| GET | `/template` | Lists templates and template details for current user |
| POST | `/hoverExplicitLogin` | Hover explicit login |
| POST | `/saveCurrentUserInfo` | Saves current user details |
| GET | `/getCurrentUserPermission` | Returns current user permissions |
| GET | `/getAddressBook` | Returns address book for current user |
| POST | `/createAddressBook` | Creates new address in the address book |
| POST | `/updateAddressBook` | Updates address in the address book |
| POST | `/deleteAddressBook` | Deletes address in the address book |
| POST | `/changePassword` | Change password |
| POST | `/setPassword` | Sets password for new user |
| POST | `/resetPassword` | Resets password for current user |
| POST | `/forgotPassword` | Sends forgot password email |
| POST | `/user` | Returns a list of users for an account |
| GET | `/getUserDetail` | Returns user details by profile id. |
| POST | `/createUser` | Creates a new user account |
| POST | `/updateUser` | Updates user information |
| GET | `/organization` | Returns list of organizations for current user |
| GET | `/role` | Returns role and permissions for current user |
| POST | `/permissionTemplateList` | Returns list of permissions templates |
| POST | `/getPermissionTemplateDetail` | Returns details for permissions templates |
| POST | `/createPermissionTemplate` | Creates permissions template |
| POST | `/updatePermissionTemplate` | Updates permissions template |
| POST | `/deletePermissionTemplate` | Removes permissions template |
| GET | `/orderhistory_v2` | Returns orders listed by order id |
| GET | `/downloadOrderDetailAsPDF` | Returns order detail in PDF |
| GET | `/getDTOrderDetail` | Returns delivery tracking order information by order Id |
| GET | `/typeAhead` | Returns like products in search |
| GET | `/itemDetails` | Get items details |
| GET | `/getProductVariation` | Returns product variations by product Id |
| GET | `/getQuoteProductVariation` | Returns product variation for quote |
| POST | `/getMultipleProductVariation` | Returns product variation by product Id |
| POST | `/getMultipleQuoteProductVariation` | Returns product variation for quote |
| GET | `/getFavoriteProducts` | Returns favorite products |
| GET | `/categories` | Returns all categories and placement in hierarchy |
| GET | `/getProductBranchOrRegionAvailability` | Returns product availability for a branch |
| GET | `/getSKUBranchOrRegionAvailability` | Returns product availability for a branch |
| POST | `/updateOrderAlert` | Updates order alert |
| POST | `/uploadOrderRelatedDocuments` | Uploads order related documents |
| POST | `/deleteOrderRelatedDocuments` | Removes order related documents |
| GET | `/downloadOrderDocument` | Downloads order related document |
| GET | `/getGenericBrands` | Returns list of brands |
| GET | `/orderSummary` | Returns order total for current items in cart |

…and 85 more operations. They are listed in full on the page.

## Machine-readable artifacts (3)

- **Documentation** — https://beaconproplus.com/swagger/all_api/
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/beacon-roofing-supply/refs/heads/main/openapi/beacon-roofing-supply-all-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/beacon-roofing-supply/refs/heads/main/overlays/beacon-roofing-supply-all-api-overlay.yaml

## Other Beacon Roofing Supply APIs (6)

- [Beacon PRO+ API (V2, OAuth)](https://apis.io/apis/beacon-roofing-supply/beacon-pro-plus/)
- [Beacon Rest Services V3 (Public / Integrations)](https://apis.io/apis/beacon-roofing-supply/beacon-rest-v3/)
- [Beacon Rest Services V1 (session)](https://apis.io/apis/beacon-roofing-supply/beacon-rest-v1/)
- [Beacon OAuth Rest Service](https://apis.io/apis/beacon-roofing-supply/beacon-oauth/)
- [Beacon Rest Services Public](https://apis.io/apis/beacon-roofing-supply/beacon-rest-public/)
- [Beacon Internal Rest Service](https://apis.io/apis/beacon-roofing-supply/beacon-rest-internal/)

## Tags

Construction, Roofing, Distribution, E-Commerce, Order

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/beacon-roofing-supply/beacon-rest-all-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/beacon-roofing-supply/.