supersonic-models/src/order/spec/definitions/kiosk.yaml

Supersonic models and API specifications

type: object
description: Device settings
required:
  - organisation
  - serial
  - storeId
  - timezone
  - organisationFirestoreId
  - storeFirestoreId
  - deviceFirestoreId
  - localtime
properties:
  organisation:
    type: string
    example: yum-au-kfc
    description: Organisation code provided by Fingermark
  serial:
    type: string
    example: "2"
    description: Device serial
  storeId:
    type: string
    example: "1"
    description: Store ID from Aloha provider
  timezone:
    type: string
    example: "Pacific/Auckland"
    description: Device timezone
  organisationFirestoreId:
    type: string
    example: "TYIMXJyrsby3hAf4Z1Wk"
    description: Organisation ID from database. This is provided by Fingermark.
  storeFirestoreId:
    type: string
    example: "LK0n6Wei0b9By6BDEhaD"
    description: Store ID from database. This is provided by Fingermark.
  deviceFirestoreId:
    type: string
    example: "YxfP4JLZwQPmhbeBdkYw"
    description: Device ID from database. This is provided by Fingermark.
  site:
    $ref: "./site.yaml"
  localtime:
    type: string
    example: "2020-12-06T19:50:00Z"
    description: Device date and time
  headers:
    type: object
    description: A list of HTTP headers to send to Aloha provider endpoints
    example:
      "X-Api-Channel": "Kiosk Pickup"