openapi: 3.2.0
info:
  description: 'This is a collection of APIs to provide Catering Information


    The base endpoint URL for this API in production is: `https://marko.aramark.net/v1/catering`.


    For testing the API with the "Try" tool on this page or in your app, use either our testing server "qa-marko" or our development server "dev-marko".'
  version: 1.0.0-oas3
  title: Catering Order API
servers:
- url: https://qa-marko.aramark.net/v1/catering
  description: Testing server
- url: https://dev-marko.aramark.net/v1/catering
  description: Development server
security:
- apiKey: []
tags:
- name: Order
paths:
  /order/details/{org_value}:
    get:
      operationId: getCateringOrderDetails
      tags:
      - Order
      summary: Gets Catering Order Details
      description: '!This endpoint is in production'
      parameters:
      - $ref: '#/components/parameters/orgValueParam'
      - $ref: '#/components/parameters/sourceSystemParam'
      - $ref: '#/components/parameters/startDateTimeParam'
      - $ref: '#/components/parameters/endDateTimeParam'
      - $ref: '#/components/parameters/pageParam'
      - $ref: '#/components/parameters/sizeParam'
      - $ref: '#/components/parameters/rawParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      responses:
        '200':
          description: Collection of Catering Order Details
          content:
            '*/*':
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success' or 'Error'
                    default: Success
                  count:
                    type: string
                    description: Number of records returned
                  page:
                    type: number
                    description: Page number of the response
                  size:
                    type: number
                    description: Size of the response
                  orders:
                    type: array
                    items:
                      $ref: '#/components/schemas/orders'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
components:
  parameters:
    bypassCacheParam:
      in: header
      name: bypass-cache
      description: This HTTP Header variable will bypass cache.
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
    rawParam:
      in: query
      name: raw
      description: Flag used to determine if the data is direct from the source system, unconformed or not
      schema:
        type: string
        enum:
        - Y
        - N
    orgValueParam:
      in: path
      name: org_value
      description: Aramark Organization code
      required: true
      schema:
        type: string
    endDateTimeParam:
      in: query
      name: end_date_time
      description: Calendar end date and time for transactions. "MM/dd/yyyy HH:mm". Must be within 24 hours of start_date_time.
      required: true
      schema:
        type: string
    sizeParam:
      in: query
      name: size
      description: Number of rows in each page to return. Default 50
      required: false
      schema:
        type: string
    sourceSystemParam:
      in: query
      name: source_system
      description: "Name of the Catering System:\n * `SWZD` - Suite Wizard\n"
      required: true
      schema:
        type: string
        enum:
        - SWZD
    pageParam:
      in: query
      name: page
      description: Page number of result set. Default 1
      required: false
      schema:
        type: number
    startDateTimeParam:
      in: query
      name: start_date_time
      description: Calendar start date and time for transactions. "MM/dd/yyyy HH:mm". Must be within 24 hours of end_date_time.
      required: true
      schema:
        type: string
  schemas:
    orders:
      type: object
      properties:
        source_system:
          type: string
          description: Identifier of the source POS system
        org_value:
          type: string
          description: Aramark Organization Code for rollup
        org_name:
          type: string
          description: Name of the Aramark Organization
        order_count:
          type: number
          description: Number of orders
        suite_wizard_orders:
          type: array
          items:
            $ref: '#/components/schemas/suite_wizard_order_details'
    suite_wizard_order_details:
      type: object
      properties:
        event_date:
          type: string
          description: Date the event took place
        customer_id:
          type: string
          description: System Identifier of the Customer
        customer_name:
          type: string
          description: Name of the Customer
        event_description:
          type: string
          description: Description of the Event
        event_type:
          type: string
          description: Type of the Event
        event_subcatergory_description:
          type: string
          description: Subcategory of the Event
        suite_number:
          type: string
          description: The number of the Suite/Room
        order_id:
          type: string
          description: System Identifier of the Order
        order_num:
          type: string
          description: Alternate Identifier of the Order
        order_type:
          type: string
          description: Type of Order
        order_status:
          type: string
          description: Status of the Order (OPEN, CLOSED, NEW, PENDING, HOLD, VIEWED)
        order_amount:
          type: number
          description: Current amount of the Order
        order_total_at_closing:
          type: number
          description: Total od the Order when it is closed
        order_detail_id:
          type: string
          description: System Identifier of the Order Item
        title:
          type: string
          description: Name of the Order Item
        unit_price:
          type: number
          description: Per Unit Price of the Order Item
        quantity:
          type: number
          description: Quantity of the Item on the Order
        total_price:
          type: number
          description: Total Price of the Order Item
        category_description:
          type: string
          description: Description of the Item Category
        gl_code:
          type: string
          description: Internal Ledger Code for the Item
        gl_code_description:
          type: string
          description: Description of the Ledger Code for the Item
        gl_code_percent_of_item:
          type: number
          description: The percentage of the Item associated to the Ledger Code
        last_update_date:
          type: string
          description: Date-Time the records was last updated
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify permissions.