Beacon Roofing Supply Integration Services API

openapi: 3.2.0
info:
  title: Beacon Rest Services Ver 3 (Public) Integration Services API
  version: release/7.2_siteId
  description: 'This version of APIs do not require the user to login, to be able to access

    services. A bearer token is required to be authorized to access the

    services.


    [ PROD BASE URL: *https://beaconproplus.com/v3/rest/com/becn* ]


    [ UAT BASE URL: *https://beacon-uat.becn.com/v3/rest/com/becn* ]


    [ DEV BASE URL: *https://beacon-dev.becn.com/v3/rest/com/becn* ]


    ### API Site ID:


    Show...

    Most of the APIs supports the `apiSiteId` parameter in the following locations, the parsing priority is higher to lower. For example, if this parameter appears both in request parameter and request body, will get the one in the request parameter, any other locations will be ignored.

    1. `apiSiteId` in Request Parameter/URL/Query String e.g.

    ```

    example.com/?apiSiteId=XYZ...

    example.com/?...&apiSiteId=XYZ...

    ```

    2. `apiSiteId` in Request Body/Payload e.g.


    ```

    {

    ...

    "apiSiteId": "XYZ",

    ...

    }

    ```


    Please be noted, only support when `apiSiteId` is the root element of request body. For example, the `apiSiteId` in the following request body is the second element, so this property will be ignored:

    ```

    {

    ...

    "foo": {

    "apiSiteId": "XYZ",

    }

    ...

    }

    ```

    3. `apiSiteId` related OAuth Token in Request Header e.g.

    ```

    Authorization Bearer atdy9au5qtg0ofkxdewwr3169...

    ```

    In this case, the `apiSiteId` will be parsed via the OAuth Token. For example, if one token is generated by the client id ''nigu0zjtyih7lb36l2...'', then this client related api site id(pre-defined and stored in the server database) will be the value of `apiSiteId`'
servers:
- url: https://beaconproplus.com/v3/rest/com/becn
  description: 'Production. Added by API Evangelist; the harvested document carried no servers[]. Source: info.description of the all_api spec: ''Version 3: https://beaconproplus.com/v3/rest/com/becn''; probed 2026-09-04 -> 401 JSON envelope'
tags:
- name: Integration Services
paths:
  /mincronMapping:
    get:
      security:
      - bearerAuth: []
      tags:
      - Integration Services
      summary: Get Mincron mapping products
      description: This service returns mapping products based on customer number.
      parameters:
      - in: query
        name: accountId
        schema:
          type: string
        description: Customer number
        required: true
      - in: query
        name: pageSize
        description: Default page size is 100
        schema:
          type: integer
      - in: query
        name: pageNo
        description: Default page no is 1
        schema:
          type: integer
      responses:
        '200':
          description: 'successful operation


            If failed, return messageCode, refer to messageCode doc.


            Example


            { "messageCode": "1001", "message": "Validation exception" }

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/productsRep'
        '401':
          description: Unauthorized, the authorization bearer token is invalid
        '403':
          description: Forbidden, user do not has permission to access this API
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '419':
          description: Unauthorized, the authorization bearer token is expired
        '500':
          description: Internal exception
      operationId: getMincronMapping
      x-operation-id-source: derived
components:
  schemas:
    productObj_mincronMapping:
      type: object
      properties:
        customerNumber:
          type: string
        itemNumber:
          type: string
        itemDescription:
          type: string
        productNumber:
          type: string
        aliasNumber:
          type: string
    BCPaginationObj:
      type: object
      properties:
        enable:
          type: boolean
        page:
          type: integer
        currentPage:
          type: boolean
        type:
          type: string
    BCOtherPaginationObj:
      type: object
      properties:
        available:
          type: boolean
        label:
          type: string
        page:
          type: integer
    productsRep:
      type: object
      properties:
        result:
          type: object
          properties:
            products:
              type: array
              items:
                $ref: '#/components/schemas/productObj_mincronMapping'
            pagination:
              $ref: '#/components/schemas/BCPaginationDataObj'
    BCPaginationDataObj:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/BCOtherPaginationObj'
        previous:
          $ref: '#/components/schemas/BCOtherPaginationObj'
        pageSize:
          type: integer
        currentPage:
          type: integer
        totalCount:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/BCPaginationObj'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token