openapi: 3.2.0
info:
  title: Beacon Rest Services Update Order Alert 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: UpdateOrderAlert
paths:
  /updateOrderAlert:
    post:
      operationId: V2Controller_updateOrderAlert
      summary: Updates order alert
      description: 'Updates order alert type to email and/or text message for a specific order. The query condition for alertType can be email,sms,emailAndsms or none.


        Example:


        {

        "orderId ": "string",

        "alertType": "email",

        "phoneNumber": "string",

        "emailAddress": "string",

        "saveToProfile": "true"

        },

        {

        "orderNumber": "string",

        "alertType": "sms",

        "phoneNumber": "string",

        "emailAddress": "string",

        "saveToProfile": "false"

        },

        {

        "savedOrderId": "string",

        "alertType": "emailAndsms",

        "phoneNumber": "string",

        "emailAddress": "string",

        "saveToProfile": "true"

        }'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateOrderAlertBody'
      responses:
        '200':
          description: successful operation<br><br>refer to the <i>API Uniform Format</i> dropdown above
        '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:
      - UpdateOrderAlert
components:
  schemas:
    updateOrderAlertBody:
      type: object
      properties:
        orderId:
          type: string
        orderNumber:
          type: string
        savedOrderId:
          type: string
        alertType:
          type: string
        phoneNumber:
          type: string
        emailAddress:
          type: string
        saveToProfile:
          type: boolean
      required:
      - orderId
      - orderNumber
      - savedOrderId
      - alertType
      - phoneNumber
      - emailAddress
      - saveToProfile