openapi: 3.2.0
info:
  description: 'This API will return POS Daily Product Ranking by Sales or Volume data fromi Aramark''s Enterprise POS.


    The base endpoint URL for this API in production is:

    `https://marko.aramark.net/v1/pos/daily/product`.


    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: POS Daily Product Ranking Sales Ranking API
servers:
- url: https://qa-marko.aramark.net/v1/pos/daily/product
  description: Testing server
- url: https://dev-marko.aramark.net/v1/pos/daily/product
  description: Development server
security:
- apiKey: []
tags:
- name: Sales Ranking
paths:
  /sales_rank/{org_value}:
    get:
      summary: POS product rankings by sales
      description: 'Returns POS Daily Product Rankings by Sales


        !This endpoint is in production'
      operationId: getDailySalesRank
      tags:
      - Sales Ranking
      parameters:
      - $ref: '#/components/parameters/orgValueParam'
      - $ref: '#/components/parameters/startDateParam'
      - $ref: '#/components/parameters/rankParam'
      - $ref: '#/components/parameters/hierarchyParam'
      - $ref: '#/components/parameters/pageParam'
      - $ref: '#/components/parameters/sizeParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam'
      responses:
        '200':
          description: Product ranking results of sales
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success', 'Error' or 'Not Found'
                    default: Success
                  count:
                    type: string
                    description: Number of records returned
                    default: '0'
                  page:
                    type: string
                    description: Page number of result set
                    default: '1'
                  size:
                    type: string
                    description: Number of records returned with the result set
                    default: '50'
                  family_rank:
                    type: array
                    items:
                      $ref: '#/components/schemas/sales_rank'
        '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'
        default: 'false'
    smokeParam:
      in: header
      name: smoke
      description: When set to 'true' this HTTP header variable will route the API call to the Integration testing environment.  Only applicable in QA.
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
    hierarchyParam:
      in: query
      name: hierarchy
      description: Product hierarchy to group ranking by
      required: false
      schema:
        type: string
        enum:
        - FAMILY
        - DEPARTMENT
    orgValueParam:
      in: path
      name: org_value
      description: Aramark Organization code for rollup
      required: true
      schema:
        type: string
    sizeParam:
      in: query
      name: size
      description: Number of records to be returned in each page of result set
      required: false
      schema:
        type: string
        default: 50
    startDateParam:
      in: query
      name: start_date
      description: Calendar date for daily transactions. "mm/dd/yyyy"
      required: true
      schema:
        type: string
    pageParam:
      in: query
      name: page
      description: Page number of result set
      required: false
      schema:
        type: string
        default: 1
    rankParam:
      in: query
      name: rank
      description: Number of Highest Rank to Return. (range 1-20 or "ALL")
      required: false
      schema:
        type: string
        default: 5
  schemas:
    sales_rank:
      type: object
      properties:
        calendar_date:
          type: string
          description: Date or transactional rollup
        product_family:
          type: string
          description: Name of Aramark Product Family [Only applicable if hierarchy=family]
        product_department:
          type: string
          description: Name of Aramark Product Department [Only applicable if hierarchy=department]
        product:
          type: string
          description: Name of Aramark POS Product
        total_items_sold:
          type: number
          description: Number of Items sold
        total_sales:
          type: number
          description: Total sales
        rank:
          type: number
          description: Product rank number returned by operations based on total sales
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify security