supersonic-models/src/order/spec/definitions/mycentral-settings.yaml

Supersonic models and API specifications

type: object
description: MyCentral provider settings
required:
  - providerType
  - menuId
  - endpoint
  - applicationId
  - cultureCode
  - kioskId
properties:
  providerType:
    $ref: "./provider-type.yaml"
  menuId:
    type: number
    example: 10000
    description: Aloha menu ID
  deliveryOptionsRequiringBeacon:
    type: array
    description: Order/cart modes that requiring a beacon number. If some mode are requiring beacon number and it isn't present, the request will respond with an error.
    example: ["DINE_IN", "TAKEAWAY"]
    items:
      $ref: "./cart-mode.yaml"
  orderNumberSource:
    type: string
    enum: ["CREDIT_CARD_LAST_2_DIGITS"]
    example: "CREDIT_CARD_LAST_2_DIGITS"
    description: |
      * CREDIT_CARD_LAST_2_DIGITS: Set the last 2 digits from the card number as the order number.
  endpoint:
    type: string
    example: "https://kfckiosk.restaurantbrands.co.nz:81"
    description: MyCnetral base URL
  cultureCode:
    type: string
    example: en-AU
    default: en-AU
    description: MyCentral culture code.
  placeOrderIndividualItems:
    type: boolean
    example: false
    description: Split products with quantity bigger than 1 into many products with quantity equal to 1.
  receiveMarketingEmail:
    type: boolean
    example: false
    description: Flag to send to MyCentral place order request.