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

Supersonic models and API specifications

type: object
required:
  - customer
  - kiosk
  - cart
  - timestamp
  - cartId
  - total
  - paymentType
  - payment
  - receipt
properties:
  customer:
    $ref: "./customer.yaml"
  kiosk:
    $ref: "./kiosk.yaml"
  cart:
    $ref: "./aloha-cart.yaml"
  timestamp:
    type: string
    example: "2020-12-06T19:50:00Z"
    description: Timestamp from the cart state, it's part of the document path on firestore. Send the value from a previous request if you are trying to update an existing order.
  cartId:
    type: string
    example: "cf9d9350-1ed5-11eb-98af-d198a7520869"
    description: Cart ID from the cart state, it's part of the document path on firestore. Send the same value from a previous request if you are trying to update an existing order.
  mock:
    type: boolean
    default: true
    example: true
    description: Mock provider responses.
  orderId:
    type: number
    example: 12345
    description: Order ID from provider.
  total:
    type: number
    example: 13.95
    description: Order total
  paymentType:
    $ref: "./payment-type.yaml"
  payment:
    type: object
    description: Payment provider details
  status:
    $ref: "./order-status.yaml"
  financialSummary:
    $ref: "./financial-summary.yaml"
  orderNumber:
    example: 10
    readOnly: true
    description: |
      * If there is a beacon number then it will be used as the order number;
      * Otherwise it will use a sequencial number.
  receiptId:
    readOnly: true
    type: string
    example: eyJpZCI6IjAxOjM3OjE4LWNmOWQ5MzUwLTFlZDUtMTFlYi05OGFmLWQxOThhNzUyMDg2OSIsImRhdGUiOiIyMDIwLTEyLTA4Iiwib3JnYW5pc2F0aW9uRmlyZXN0b3JlSWQiOiJUWUlNWEp5cnNieTNoQWY0WjFXayIsImRldmljZUZpcmVzdG9yZUlkIjoiWXhmUDRKTFp3UVBtaGJlQmRrWXciLCJzdG9yZUZpcmVzdG9yZUlkIjoiTEswbjZXZWkwYjlCeTZCREVoYUQifQ==
    description: Receipt ID
  receipt:
    $ref: "./receipt.yaml"
  messages:
    $ref: "./messages-array.yaml"