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

Supersonic models and API specifications

type: object
required:
  - organisationFirestoreId
  - storeFirestoreId
  - status
properties:
  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.
  fromDateTime:
    type: string
    example: "2020-11-15"
    description: List orders from this start point. Should be a date or a date and time following ISO format.
  status:
    $ref: "./order-status.yaml"
  desc:
    type: boolean
    example: false
    description: Sort orders by desc
  limit:
    type: number
    example: 10
    description: Number of orders per page
  startAfterOrder:
    type: object
    description: This object represents a short order with some properties that the API needs to find it on the database to start fetching the next page from that order.
    required:
      - timestamp
      - cartId
      - deviceFirestoreId
    properties:
      deviceFirestoreId:
        type: string
        example: "YxfP4JLZwQPmhbeBdkYw"
        description: Device ID from database. This is provided by Fingermark.
      timestamp:
        type: string
        example: "2020-12-06T19:50:00Z"
        description: Timestamp from the cart state, it's part of the document path on firestore.
      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.