openapi: 3.2.0
info:
  title: Beacon Rest Services Items API
  description: 'A combination of all methods in the beacon-api


    [ BASE URL: https://beaconproplus.com


    Beacon ProPlus


    Version 1: https://beaconproplus.com/v1/rest/com/becn


    Version 2: https://beaconproplus.com/v2/rest/com/becn


    Version 3: https://beaconproplus.com/v3/rest/com/becn


    Beacon Stack


    [ BASE URL: https://beacon-api-x7xzzdp35a-uk.a.run.app


    Version 1: https://beacon-api-x7xzzdp35a-uk.a.run.app/v1/rest/com/becn/


    Version 2: https://beacon-api-x7xzzdp35a-uk.a.run.app/v2/rest/com/becn/


    Version 3…'
  version: '1.0'
  contact: {}
servers: []
tags:
- name: Items
paths:
  /items:
    get:
      operationId: V1Controller_items
      summary: Returns item details
      description: Returns item details based on product Id or item Id.
      parameters:
      - name: productId
        required: false
        in: path
        description: Product Id
        schema:
          type: string
      - name: itemNumber
        required: false
        in: path
        description: Item number(SKU ID)
        schema:
          type: string
      - name: accountId
        required: false
        in: path
        description: Account Id
        schema:
          type: string
      - name: jobNumber
        required: false
        in: path
        description: Job Number
        schema:
          type: string
      - name: uom
        required: false
        in: path
        description: Unit of Measure
        schema:
          type: string
      - name: showHoverAttrs
        required: false
        in: path
        description: if "true", display hover attributes
        schema:
          type: string
      responses:
        '200':
          description: 'successful operation<br><br>If failed, return messageCode, refer to the <i>API Response Message Code</i> dropdown above<br><br>Example:<br><br>{ "messageCode": "1001", "messages": [{ "type": "error", "value": "Validation exception", "code": "1001" }], "success": false }'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getItemsResponse'
        '400':
          description: Bad Request, accountId is invalid.
        '401':
          description: Unauthorized, the authorization bearer token is invalid.
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '500':
          description: Internal exception.
      tags:
      - Items
components:
  schemas:
    Specification:
      type: object
      properties:
        Shingles_Per_Square:
          type: string
        Algae_Resistance:
          type: string
        Coverage_Per_Square:
          type: string
        Bundles_Per_Square:
          type: string
        Nominal_Size:
          type: string
        Net_Free_Vent_Area__NFVA_:
          type: string
        Exposure:
          type: string
        Wind_Resistance:
          type: string
      required:
      - Shingles_Per_Square
      - Algae_Resistance
      - Coverage_Per_Square
      - Bundles_Per_Square
      - Nominal_Size
      - Net_Free_Vent_Area__NFVA_
      - Exposure
      - Wind_Resistance
    getItemsResponse:
      type: object
      properties:
        product:
          $ref: '#/components/schemas/Product'
        message:
          type: string
        specification:
          $ref: '#/components/schemas/Specification'
        resource:
          $ref: '#/components/schemas/Resource'
        currentSKU:
          $ref: '#/components/schemas/CurrentSKU'
        skuList:
          type: array
          items:
            $ref: '#/components/schemas/SkuList'
      required:
      - product
      - message
      - specification
      - resource
      - currentSKU
      - skuList
    HoverAttributes:
      type: object
      properties:
        sellingUom:
          type: string
        piecesPerUom:
          type: string
        coverageUom:
          type: string
        ppCoverageUom:
          type: string
        lengthExposure:
          type: string
        widthExposure:
          type: string
        lengthHover:
          type: string
        widthHover:
          type: string
        ncpSellingUom:
          type: string
        gcpSellingUom:
          type: string
        sslvoDimensionIn:
          type: string
        sswhoDimensionOption1In:
          type: string
        sswhoDimensionOption2In:
          type: string
        sswhoDimensionOption3In:
          type: string
        lslvoDimensionIn:
          type: string
        lswhoDimensionIn:
          type: string
        rvlvoDimensionIn:
          type: string
        rvwhoDimensionIn:
          type: string
        nfvaHover:
          type: string
        nfvaUomHover:
          type: string
        fhLapIn:
          type: string
        fvLapIn:
          type: string
        chLapIn:
          type: string
        cvLapIn:
          type: string
        cfmValue:
          type: string
        cfmUom:
          type: string
      required:
      - sellingUom
      - piecesPerUom
      - coverageUom
      - ppCoverageUom
      - lengthExposure
      - widthExposure
      - lengthHover
      - widthHover
      - ncpSellingUom
      - gcpSellingUom
      - sslvoDimensionIn
      - sswhoDimensionOption1In
      - sswhoDimensionOption2In
      - sswhoDimensionOption3In
      - lslvoDimensionIn
      - lswhoDimensionIn
      - rvlvoDimensionIn
      - rvwhoDimensionIn
      - nfvaHover
      - nfvaUomHover
      - fhLapIn
      - fvLapIn
      - chLapIn
      - cvLapIn
      - cfmValue
      - cfmUom
    SkuList:
      type: object
      properties:
        currentUOM:
          type: string
        color:
          type: string
        unitPrice:
          type: number
        itemNumber:
          type: string
        productNumber:
          type: string
        itemImage:
          type: string
        heroImage:
          type: string
        thumbImage:
          type: string
        swatchImage:
          type: string
        skuShortDesc:
          type: string
        auxiliaryImages:
          type: array
          items:
            type: string
      required:
      - currentUOM
      - color
      - unitPrice
      - itemNumber
      - productNumber
      - itemImage
      - heroImage
      - thumbImage
      - swatchImage
      - skuShortDesc
      - auxiliaryImages
    Category:
      type: object
      properties:
        categoryName:
          type: string
        categoryId:
          type: string
      required:
      - categoryName
      - categoryId
    CurrentSKU:
      type: object
      properties:
        currentUOM:
          type: string
        color:
          type: string
        manufactureNumber:
          type: string
        unitPrice:
          type: number
        itemNumber:
          type: string
        productNumber:
          type: string
        uomlist:
          type: array
          items:
            type: string
        itemImage:
          type: string
        heroImage:
          type: string
        thumbImage:
          type: string
        swatchImage:
          type: string
        skuShortDesc:
          type: string
        auxiliaryImages:
          type: array
          items:
            type: string
      required:
      - currentUOM
      - color
      - manufactureNumber
      - unitPrice
      - itemNumber
      - productNumber
      - uomlist
      - itemImage
      - heroImage
      - thumbImage
      - swatchImage
      - skuShortDesc
      - auxiliaryImages
    Product:
      type: object
      properties:
        productImage:
          type: string
        productOnErrorImage:
          type: string
        longDesc:
          type: string
        manufactureNumber:
          type: string
        categories:
          type: array
          items:
            $ref: '#/components/schemas/Category'
        shortDesc:
          type: string
        itemNumber:
          type: string
        hoverAttributes:
          $ref: '#/components/schemas/HoverAttributes'
        productName:
          type: string
        productId:
          type: string
        baseProductName:
          type: string
        internalProductName:
          type: string
        brand:
          type: string
        url:
          type: string
        relatedProducts:
          type: array
          items:
            type: string
      required:
      - productImage
      - productOnErrorImage
      - longDesc
      - manufactureNumber
      - categories
      - shortDesc
      - itemNumber
      - hoverAttributes
      - productName
      - productId
      - baseProductName
      - internalProductName
      - brand
      - url
      - relatedProducts
    Resource:
      type: object
      properties:
        General Instructrions:
          type: string
        Warranty:
          type: string
        MSDS:
          type: string
        Brochure:
          type: string
      required:
      - General Instructrions
      - Warranty
      - MSDS
      - Brochure