openapi: 3.2.0
info:
title: Beacon Rest Services Get Current Order Review 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: GetCurrentOrderReview
paths:
/getCurrentOrderReview:
get:
operationId: V2Controller_getCurrentOrderReview
summary: Returns order information
description: Returns order information to confirm before placing order.
parameters: []
responses:
'200':
description: successful operation
refer to the API Uniform Format dropdown above
content:
application/json:
schema:
$ref: '#/components/schemas/getCurrentOrderReviewResponse'
'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:
- GetCurrentOrderReview
components:
schemas:
Job:
type: object
properties:
jobName:
type: string
jobNumber:
type: string
required:
- jobName
- jobNumber
DeliveryOption:
type: object
properties:
displayName:
type: string
value:
type: string
selected:
type: boolean
required:
- displayName
- value
- selected
JobAccounts:
type: object
properties:
unavailable:
type: boolean
unavailableMsg:
type: string
jobs:
type: array
items:
$ref: '#/components/schemas/Job'
required:
- unavailable
- unavailableMsg
- jobs
getCurrentOrderReviewResponse:
type: object
properties:
deliveryOption:
type: string
deliveryDate:
type: string
deliveryTime:
type: string
shippingMethod:
type: string
shippingAddress:
$ref: '#/components/schemas/ShippingAddress'
poJob:
$ref: '#/components/schemas/PoJob'
instructions:
type: string
additionalRecipients:
type: array
items:
type: string
orderRelatedDocuments:
type: array
items:
type: string
nextPage:
$ref: '#/components/schemas/NextPage'
required:
- deliveryOption
- deliveryDate
- deliveryTime
- shippingMethod
- shippingAddress
- poJob
- instructions
- additionalRecipients
- orderRelatedDocuments
- nextPage
NextPage:
type: object
properties:
nextUrl:
type: string
required:
- nextUrl
PoJob:
type: object
properties:
poRequired:
type: boolean
jobNameRequired:
type: boolean
jobNumberRequired:
type: boolean
showJobName:
type: boolean
showJobNumber:
type: boolean
poName:
type: string
jobNumber:
type: string
jobName:
type: string
jobAccounts:
$ref: '#/components/schemas/JobAccounts'
required:
- poRequired
- jobNameRequired
- jobNumberRequired
- showJobName
- showJobNumber
- poName
- jobNumber
- jobName
- jobAccounts
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