openapi: 3.0.3
info:
  title: Aramark Marko API
  description: Marko is Aramark's data and AI platform providing fast, frictionless access to Aramark's robust data universe with 70+ services designed to provide realtime insights and streamline 
    business processes.
  version: 1.0.0
  x-generated-from: documentation
  contact:
    name: Aramark Developer Portal
    url: https://marko-developers.aramark.net/
servers:
- url: https://www.marko.aramark.net/v1
  description: Marko API Production Server
tags:
- name: Organization
  description: Organization hierarchy and location management
- name: Point of Sale
  description: Point of sale transaction data
- name: Product
  description: Product and menu catalog data
- name: Profit Centers
  description: Profit center and financial unit management
- name: Revenue
  description: Revenue snapshot and financial analytics
- name: Service
  description: Service management and tracking
paths:
  /organization:
    get:
      operationId: getOrganization
      summary: Aramark Get Organization Data
      description: Retrieve organization hierarchy and location data from the Aramark Marko data platform.
      tags:
      - Organization
      parameters:
      - name: locationId
        in: query
        description: Filter by location identifier
        schema:
          type: string
        example: LOC-001
      - name: orgType
        in: query
        description: Filter by organization type
        schema:
          type: string
        example: DISTRICT
      responses:
        '200':
          description: Organization data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
              examples:
                GetOrganization200Example:
                  summary: Default getOrganization 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: ORG-001
                      name: Northeast District
                      type: DISTRICT
                      parentId: REGION-NE
                      locationCount: 45
                    count: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - apiKey: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /service:
    get:
      operationId: getService
      summary: Aramark Get Service Data
      description: Retrieve service management and tracking data from the Aramark Marko platform.
      tags:
      - Service
      parameters:
      - name: serviceType
        in: query
        description: Filter by service type
        schema:
          type: string
        example: FOOD_SERVICE
      - name: locationId
        in: query
        description: Filter by location
        schema:
          type: string
        example: LOC-001
      responses:
        '200':
          description: Service data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                GetService200Example:
                  summary: Default getService 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: SVC-001
                      type: FOOD_SERVICE
                      locationId: LOC-001
                      status: ACTIVE
                      name: Campus Dining
                    count: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - apiKey: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /product:
    get:
      operationId: getProduct
      summary: Aramark Get Product Data
      description: Retrieve product and menu catalog data from the Aramark Marko platform.
      tags:
      - Product
      parameters:
      - name: category
        in: query
        description: Filter by product category
        schema:
          type: string
        example: ENTREE
      - name: locationId
        in: query
        description: Filter by location
        schema:
          type: string
        example: LOC-001
      responses:
        '200':
          description: Product data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResponse'
              examples:
                GetProduct200Example:
                  summary: Default getProduct 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: PROD-001
                      name: Grilled Chicken
                      category: ENTREE
                      price: 8.95
                      calories: 380
                    count: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - apiKey: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /profit-centers:
    get:
      operationId: getProfitCenters
      summary: Aramark Get Profit Centers
      description: Retrieve profit center and financial unit data from the Aramark Marko platform.
      tags:
      - Profit Centers
      parameters:
      - name: parentId
        in: query
        description: Filter by parent profit center
        schema:
          type: string
        example: PC-REGION-NE
      responses:
        '200':
          description: Profit center data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfitCenterResponse'
              examples:
                GetProfitCenters200Example:
                  summary: Default getProfitCenters 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - id: PC-001
                      name: Campus Center Dining
                      code: NE-CC-001
                      parentId: PC-REGION-NE
                      active: true
                    count: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - apiKey: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /revenue-snapshot:
    get:
      operationId: getRevenueSnapshot
      summary: Aramark Get Revenue Snapshot
      description: Retrieve revenue snapshot and financial performance data from the Aramark Marko platform.
      tags:
      - Revenue
      parameters:
      - name: profitCenterId
        in: query
        description: Filter by profit center
        schema:
          type: string
        example: PC-001
      - name: startDate
        in: query
        description: Start date for revenue period (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-04-01'
      - name: endDate
        in: query
        description: End date for revenue period (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-04-19'
      responses:
        '200':
          description: Revenue snapshot data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevenueSnapshotResponse'
              examples:
                GetRevenueSnapshot200Example:
                  summary: Default getRevenueSnapshot 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - profitCenterId: PC-001
                      period: 2026-04
                      totalRevenue: 125430.5
                      transactionCount: 3215
                      averageTicket: 39.02
                    count: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - apiKey: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /point-of-sale:
    get:
      operationId: getPointOfSale
      summary: Aramark Get Point of Sale Data
      description: Retrieve point of sale transaction data from the Aramark Marko platform.
      tags:
      - Point of Sale
      parameters:
      - name: locationId
        in: query
        description: Filter by location identifier
        schema:
          type: string
        example: LOC-001
      - name: startDate
        in: query
        description: Start date (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-04-01'
      - name: endDate
        in: query
        description: End date (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-04-19'
      responses:
        '200':
          description: Point of sale data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSResponse'
              examples:
                GetPointOfSale200Example:
                  summary: Default getPointOfSale 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - transactionId: TXN-001
                      locationId: LOC-001
                      amount: 12.5
                      items: 2
                      timestamp: '2026-04-19T12:30:00Z'
                    count: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - apiKey: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apiKey
      description: API key for Marko platform authentication, obtained from the developer portal.
  schemas:
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: Error message
          example: Unauthorized
        code:
          type: integer
          description: Error code
          example: 401
    OrganizationUnit:
      type: object
      properties:
        id:
          type: string
          description: Unique organization unit identifier
          example: ORG-001
        name:
          type: string
          description: Organization unit name
          example: Northeast District
        type:
          type: string
          description: Organization unit type
          enum:
          - REGION
          - DISTRICT
          - LOCATION
          - ACCOUNT
          example: DISTRICT
        parentId:
          type: string
          description: Parent organization unit identifier
          example: REGION-NE
        locationCount:
          type: integer
          description: Number of locations under this unit
          example: 45
    OrganizationResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationUnit'
        count:
          type: integer
          description: Total record count
          example: 10
    Service:
      type: object
      properties:
        id:
          type: string
          description: Service identifier
          example: SVC-001
        type:
          type: string
          description: Service type
          enum:
          - FOOD_SERVICE
          - FACILITIES
          - UNIFORM
          - RETAIL
          example: FOOD_SERVICE
        locationId:
          type: string
          description: Location identifier
          example: LOC-001
        status:
          type: string
          description: Service status
          enum:
          - ACTIVE
          - INACTIVE
          - SUSPENDED
          example: ACTIVE
        name:
          type: string
          description: Service name
          example: Campus Dining
    ServiceResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Service'
        count:
          type: integer
          description: Total record count
          example: 5
    Product:
      type: object
      properties:
        id:
          type: string
          description: Product identifier
          example: PROD-001
        name:
          type: string
          description: Product name
          example: Grilled Chicken
        category:
          type: string
          description: Product category
          enum:
          - ENTREE
          - SIDE
          - BEVERAGE
          - DESSERT
          - SNACK
          example: ENTREE
        price:
          type: number
          description: Product price in USD
          example: 8.95
        calories:
          type: integer
          description: Caloric content
          example: 380
        allergens:
          type: array
          items:
            type: string
          description: List of allergens
          example:
          - GLUTEN
          - DAIRY
    ProductResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Product'
        count:
          type: integer
          description: Total record count
          example: 50
    ProfitCenter:
      type: object
      properties:
        id:
          type: string
          description: Profit center identifier
          example: PC-001
        name:
          type: string
          description: Profit center name
          example: Campus Center Dining
        code:
          type: string
          description: Profit center code
          example: NE-CC-001
        parentId:
          type: string
          description: Parent profit center identifier
          example: PC-REGION-NE
        active:
          type: boolean
          description: Whether the profit center is active
          example: true
    ProfitCenterResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProfitCenter'
        count:
          type: integer
          description: Total record count
          example: 20
    RevenueSnapshot:
      type: object
      properties:
        profitCenterId:
          type: string
          description: Profit center identifier
          example: PC-001
        period:
          type: string
          description: Revenue period (YYYY-MM)
          example: 2026-04
        totalRevenue:
          type: number
          description: Total revenue for the period in USD
          example: 125430.5
        transactionCount:
          type: integer
          description: Number of transactions in the period
          example: 3215
        averageTicket:
          type: number
          description: Average transaction value in USD
          example: 39.02
    RevenueSnapshotResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RevenueSnapshot'
        count:
          type: integer
          description: Total record count
          example: 12
    POSTransaction:
      type: object
      properties:
        transactionId:
          type: string
          description: Transaction identifier
          example: TXN-001
        locationId:
          type: string
          description: Location identifier
          example: LOC-001
        amount:
          type: number
          description: Transaction amount in USD
          example: 12.5
        items:
          type: integer
          description: Number of items in the transaction
          example: 2
        timestamp:
          type: string
          format: date-time
          description: Transaction timestamp (ISO 8601)
          example: '2026-04-19T12:30:00Z'
        paymentMethod:
          type: string
          description: Payment method used
          enum:
          - CREDIT
          - DEBIT
          - CASH
          - MEAL_PLAN
          - MOBILE
          example: MEAL_PLAN
    POSResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/POSTransaction'
        count:
          type: integer
          description: Total record count
          example: 100
security:
- apiKey: []