Beacon Roofing Supply Get Quote Order Detail API

openapi: 3.2.0
info:
  title: Beacon Rest Services Get Quote Order Detail 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: https://beacon-api-x7xzzdp35a-uk.a.run.app/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. apiSiteId in Request Parameter/URL/Query String e.g. example.com/?apiSiteId=XYZ... example.com/?...&apiSiteId=XYZ... 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", } ... }


    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


    API Uniform Format

    Show... Response

    { "success":true, "messages":[ { "key":null, "code":null, "type":"success", "value":"" } ], "result": }

    Explanation


    If the response example value of one endpoint /foo is:

    { "name":"bar", "age":123 }

    Then the actual response value of this endpoint is: (replace the value of "result" element in API Uniform Format with example response)

    { "success":true, "messages":[ { "code":null, "type":"success", "value":"" } ], "result":{ "name":"bar", "age":123 } }


    API Response Message Code

    Show... Code Group


    Code


    Comments


    1XXX:

    common request param error 1001 Param is required. 1002 Repository item not found via request


    1003 Param max length is invalid. 1004 Param min length is invalid. 1005 Param regular expression is invalid. 1006 Request param requestBody is not a valid


    1007 Request param caused validation exception


    1008 Request param caused form error


    2XXX:

    current profile error 2001 Current profile in request is empty


    2002 Current profile type/instance in request is empty


    2003 Current profile in request do not have available accounts


    2004 Current profile is unauthorized


    2005 Current profile is already authorized


    2006 Current profile is permission denied


    3XXX:

    specified request param error 3001 Request param account id is not available/not belong to current profile


    3002 Request param product id is not available to current region of current profile


    3003 Request param profile id is not equal to current profile


    3004 Request param profile id is not found


    3005 Request param site id is not equal to current site


    3006 Request param sku id is not available to current region of current profile


    3007 Request param shipping is invalid to current region of current profile


    4XXX:

    system level common error 4001 System error


    4002 Mincron error


    4003 ATG Order version invalid error


    5XXX:

    specified response error 5001 Submit order failed response


    5002 Submit order failed with integration exception message returned


    5003 Query order detail not match with current


    5004 No result is returned to order history


    5005 Template name invalid


    5006 Need change account


    5007 Account no longer available for current user


    5008 Illegal data


    5009 Account token invalid


    5010 No current Order


    5011 Quote order account not match


    Glossary

    Show...'
  version: '1.0'
  contact: {}
servers: []
tags:
- name: GetQuoteOrderDetail
paths:
  /getQuoteOrderDetail:
    get:
      operationId: V2Controller_getQuoteOrderDetail
      summary: Returns order details for a quote
      description: Returns order details for a quote.
      parameters:
      - name: orderId
        required: true
        in: path
        description: Quote order Id
        schema:
          type: string
      responses:
        '200':
          description: successful operation<br><br>refer to the <i>API Uniform Format</i> dropdown above
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getQuoteOrderDetailResponse'
        '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:
      - GetQuoteOrderDetail
components:
  schemas:
    CommerceItem:
      type: object
      properties:
        id:
          type: string
        imageUrl:
          type: string
        imageOnErrorUrl:
          type: string
        thumbImageUrl:
          type: string
        pdpUrl:
          type: string
        description:
          type: string
        itemNumber:
          type: string
        price:
          type: number
        quantity:
          type: number
        uom:
          type: string
        subTotal:
          type: number
        deleteStatus:
          type: boolean
        vendorColorId:
          type: string
        productId:
          type: string
        itemGrayOutLevel:
          type: string
      required:
      - id
      - imageUrl
      - imageOnErrorUrl
      - thumbImageUrl
      - pdpUrl
      - description
      - itemNumber
      - price
      - quantity
      - uom
      - subTotal
      - deleteStatus
      - vendorColorId
      - productId
      - itemGrayOutLevel
    ShippingAddress:
      type: object
      properties:
        addressBookId:
          type: string
        nickName:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        address1:
          type: string
        address2:
          type: string
        address3:
          type: string
        city:
          type: string
        stateValue:
          type: string
        states:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryOption'
        postalCode:
          type: string
        countryValue:
          type: string
        countries:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryOption'
        phoneNumber:
          type: string
      required:
      - addressBookId
      - nickName
      - firstName
      - lastName
      - address1
      - address2
      - address3
      - city
      - stateValue
      - states
      - postalCode
      - countryValue
      - countries
      - phoneNumber
    DeliveryOption:
      type: object
      properties:
        displayName:
          type: string
        value:
          type: string
        selected:
          type: boolean
      required:
      - displayName
      - value
      - selected
    AddressBookInfo:
      type: object
      properties:
        nickName:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        stateValue:
          type: string
        postalCode:
          type: string
        country:
          type: string
        countryValue:
          type: string
        phoneNumber:
          type: string
      required:
      - nickName
      - firstName
      - lastName
      - address1
      - address2
      - city
      - state
      - stateValue
      - postalCode
      - country
      - countryValue
      - phoneNumber
    RequiredFields:
      type: object
      properties:
        deliveryOption:
          type: boolean
        deliveryDate:
          type: boolean
        deliveryTime:
          type: boolean
        shippingMethod:
          type: boolean
        shippingAddress:
          type: boolean
        postalCode:
          type: boolean
        state:
          type: boolean
        address1:
          type: boolean
        address2:
          type: boolean
        address3:
          type: boolean
        country:
          type: boolean
        city:
          type: boolean
        branchName:
          type: boolean
        contactInfo:
          type: boolean
        firstName:
          type: boolean
        lastName:
          type: boolean
        nickName:
          type: boolean
        phoneNumber:
          type: boolean
        instructions:
          type: boolean
        po:
          type: boolean
        jobName:
          type: boolean
        jobAccounts:
          type: boolean
      required:
      - deliveryOption
      - deliveryDate
      - deliveryTime
      - shippingMethod
      - shippingAddress
      - postalCode
      - state
      - address1
      - address2
      - address3
      - country
      - city
      - branchName
      - contactInfo
      - firstName
      - lastName
      - nickName
      - phoneNumber
      - instructions
      - po
      - jobName
      - jobAccounts
    ContactInfo:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        nickName:
          type: string
        phoneNumber:
          type: string
      required:
      - firstName
      - lastName
      - nickName
      - phoneNumber
    BranchAddress:
      type: object
      properties:
        displayName:
          type: string
        address1:
          type: string
        address2:
          type: string
        address3:
          type: string
        country:
          type: string
        city:
          type: string
        state:
          type: string
        stateValue:
          type: string
        postalCode:
          type: string
        phoneNumber:
          type: string
      required:
      - displayName
      - address1
      - address2
      - address3
      - country
      - city
      - state
      - stateValue
      - postalCode
      - phoneNumber
    JobAccounts:
      type: object
      properties:
        unavailable:
          type: boolean
        unavailableMsg:
          type: string
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/Job'
      required:
      - unavailable
      - unavailableMsg
      - jobs
    getQuoteOrderDetailResponse:
      type: object
      properties:
        id:
          type: string
        mincronId:
          type: string
        displayName:
          type: string
        accountNumber:
          type: string
        accountName:
          type: string
        creationDate:
          type: string
        createdUser:
          type: string
        createdUserEmail:
          type: string
        lastModifiedDate:
          type: string
        lastModifiedUser:
          type: string
        lastModifiedUserEmail:
          type: string
        placeOrderDate:
          type: string
        placeOrderUser:
          type: string
        placeOrderEmail:
          type: string
        job:
          $ref: '#/components/schemas/Job'
        jobAccounts:
          $ref: '#/components/schemas/JobAccounts'
        shippingMethod:
          type: string
        shippingMethodValue:
          type: string
        shippingMethods:
          type: array
          items:
            $ref: '#/components/schemas/ShippingMethod'
        shippingAddress:
          $ref: '#/components/schemas/ShippingAddress'
        shippingAddressTitle:
          type: string
        branchName:
          type: string
        contactInfo:
          $ref: '#/components/schemas/ContactInfo'
        branchAddress:
          $ref: '#/components/schemas/BranchAddress'
        instructions:
          type: string
        commerceItems:
          type: array
          items:
            $ref: '#/components/schemas/CommerceItem'
        requiredFields:
          $ref: '#/components/schemas/RequiredFields'
        po:
          type: string
        emailAddress:
          type: array
          items:
            type: string
        deliveryOption:
          type: string
        deliveryOptionValue:
          type: string
        deliveryOptions:
          type: array
          items:
            $ref: '#/components/schemas/ShippingMethod'
        deliveryDate:
          type: string
        deliveryTime:
          type: string
        deliveryTimes:
          type: array
          items:
            $ref: '#/components/schemas/ShippingMethod'
        expressDeliveryTimes:
          type: array
          items:
            $ref: '#/components/schemas/ShippingMethod'
        addressBook:
          $ref: '#/components/schemas/AddressBook'
        storeLocatorItemId:
          type: string
        total:
          type: number
        subTotal:
          type: number
        taxes:
          type: number
        otherCharges:
          type: number
        displayTaxTBD:
          type: boolean
        displayOtherChargeTBD:
          type: boolean
        atgOrderId:
          type: string
        quoteStatus:
          type: string
        atgQuoteId:
          type: string
        action:
          type: string
        timeZoneId:
          type: string
        serverTime:
          type: number
        postponeDeliveryHour:
          type: number
        accountBranchState:
          type: string
        branchAddressTimeZoneId:
          type: string
        showDeliveryNotification:
          type: boolean
        showOrderSummary:
          type: boolean
        orderRelatedDocuments:
          type: array
          items:
            type: string
      required:
      - id
      - mincronId
      - displayName
      - accountNumber
      - accountName
      - creationDate
      - createdUser
      - createdUserEmail
      - lastModifiedDate
      - lastModifiedUser
      - lastModifiedUserEmail
      - placeOrderDate
      - placeOrderUser
      - placeOrderEmail
      - job
      - jobAccounts
      - shippingMethod
      - shippingMethodValue
      - shippingMethods
      - shippingAddress
      - shippingAddressTitle
      - branchName
      - contactInfo
      - branchAddress
      - instructions
      - commerceItems
      - requiredFields
      - po
      - emailAddress
      - deliveryOption
      - deliveryOptionValue
      - deliveryOptions
      - deliveryDate
      - deliveryTime
      - deliveryTimes
      - expressDeliveryTimes
      - addressBook
      - storeLocatorItemId
      - total
      - subTotal
      - taxes
      - otherCharges
      - displayTaxTBD
      - displayOtherChargeTBD
      - atgOrderId
      - quoteStatus
      - atgQuoteId
      - action
      - timeZoneId
      - serverTime
      - postponeDeliveryHour
      - accountBranchState
      - branchAddressTimeZoneId
      - showDeliveryNotification
      - showOrderSummary
      - orderRelatedDocuments
    Job:
      type: object
      properties:
        jobName:
          type: string
        jobNumber:
          type: string
      required:
      - jobName
      - jobNumber
    AddressBook:
      type: object
      properties:
        addressBookId:
          type: string
        accountLegacyId:
          type: string
        accountName:
          type: string
        addressBookInfo:
          $ref: '#/components/schemas/AddressBookInfo'
      required:
      - addressBookId
      - accountLegacyId
      - accountName
      - addressBookInfo
    ShippingMethod:
      type: object
      properties:
        displayName:
          type: string
        value:
          type: string
        selected:
          type: boolean
      required:
      - displayName
      - value
      - selected