openapi: 3.2.0
info:
title: Beacon Rest Services Get Quote Order Price 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: GetQuoteOrderPrice
paths:
/getQuoteOrderPrice:
get:
operationId: V2Controller_getQuoteOrderPrice
summary: Returns quote order pricing
description: Returns subtotal and total for quote order.
parameters:
- name: orderId
required: true
in: path
description: ATG Quote Order Id
schema:
type: string
- name: jobNumber
required: false
in: path
description: Job number
schema:
type: string
responses:
'200':
description: successful operation
refer to the API Uniform Format dropdown above
content:
application/json:
schema:
$ref: '#/components/schemas/getQuoteOrderPriceResponse'
'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:
- GetQuoteOrderPrice
components:
schemas:
getQuoteOrderPriceResponse:
type: object
properties:
id:
type: string
subTotal:
type: number
taxes:
type: number
otherCharges:
type: number
total:
type: number
displayTaxTBD:
type: boolean
displayOtherChargeTBD:
type: boolean
commerceItems:
type: array
items:
$ref: '#/components/schemas/CommerceItem'
required:
- id
- subTotal
- taxes
- otherCharges
- total
- displayTaxTBD
- displayOtherChargeTBD
- commerceItems
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