openapi: 3.2.0
info:
  title: Caseys General Stores Pull API
  version: '1.0'
  description: 'Operations tagged pull across 2 of this provider''s published API definitions: caseys-general-stores-cas-api-openapi.json, caseys-general-stores-cas-gateway-api-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://esl.caseys.io/casapi
- url: https://esl.caseys.io/casgatewayapi
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Pull
paths:
  /report:
    get:
      tags:
      - Pull
      summary: get /report
      description: 'These functions will allow reading report information from the request body of the message.

        The request parameter "reportId" should contain the information necessary to identify the correct report/document.'
      operationId: get-reports
      parameters:
      - name: reportId
        in: query
        description: Unique Identifier of the report
        required: true
        schema:
          type: string
      - name: x-correlation-id
        in: header
        description: correlation identifier
        schema:
          type: string
      - name: openretailing-organization-id
        in: header
        description: organization identifier
        schema:
          type: string
      - name: openretailing-store-location-id
        in: header
        description: location identifier
        schema:
          type: string
      responses:
        '200':
          description: "Requests with valid payloads (parsable and containing all of the\n        mandatory fields)  must use the 200 response. Note that a request can be\n        successfully processed but still  produce a failure response. If all the\n        systems are operating correctly at a given time,  all replies will use a\n        response 200."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/movementReportStatusReturn'
              example:
                status:
                  timestamp: string
                  result: 0
                  error: 0
                posMovement:
                  version: string
                  release: string
                  transmissionHeader:
                    storeLocationId: string
                    vendorName: string
                    vendorModelVersion: string
                    organizationId: string
                  posMovementReport:
                    posMovementReportHeader:
                      reportSequenceNumber: 0
                      primaryReportPeriod:
                        interval: 0
                        value: string
                      secondaryReportPeriod:
                        interval: 0
                        value: string
                      beginDateTime: string
                      endDateTime: string
                      reportRange:
                        value: 0
                      businessDate: string
                    posMovementReportGroup:
                    - {}
        '400':
          description: "Requests with invalid payloads or invalid URLs (paths) must use the\n        response 400."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statusReturn'
              example:
                timestamp: string
                result: 0
                message: string
        '403':
          description: Unauthorized requests must use response 403 (forbidden).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statusReturn'
              example:
                timestamp: string
                result: 0
                message: string
    servers:
    - url: https://esl.caseys.io/casapi
  /journal/{storeNumber}/{reportType}/{documentId}:
    get:
      tags:
      - Pull
      summary: GET /journal/{storeNumber}/{reportType}/{documentId}
      description: 'Retrieve a CPJR (raw) document. The located document is packaged into a 7-Zip (.7z)

        archive containing exactly one document and streamed back to the caller as a download.'
      operationId: get-cpjr-document
      parameters:
      - name: storeNumber
        in: path
        description: Store number associated with the document
        required: true
        schema:
          type: string
      - name: reportType
        in: path
        description: 'Report type. Supported values: cpjr'
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: Blob file name of the document
        required: true
        schema:
          type: string
      - name: x-correlation-id
        in: header
        description: correlation identifier
        required: true
        schema:
          type: string
      - name: openretailing-organization-id
        in: header
        description: organization identifier
        required: true
        schema:
          type: string
      - name: openretailing-store-location-id
        in: header
        description: location identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The CPJR document was located and is returned as a streamed 7-Zip (.7z) archive attachment.
          content:
            application/x-7z-compressed:
              schema:
                type: string
                format: binary
              examples:
                default:
                  value: null
        '400':
          description: Requests with missing required headers or invalid/missing route parameters must use the response 400.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statusReturn_2'
              example:
                timestamp: string
                result: 0
                error: 0
                message: string
        '403':
          description: Requests lacking the required 'casgateway.journal:read' scope must use the response 403 (forbidden).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statusReturn_2'
              example:
                timestamp: string
                result: 0
                error: 0
                message: string
        '404':
          description: When the specified document cannot be located the response 404 is used and no content is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/statusReturn_2'
              example:
                timestamp: string
                result: 0
                error: 0
                message: string
    servers:
    - url: https://esl.caseys.io/casgatewayapi
components:
  schemas:
    statusReturn:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        result:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          - 10
          - 11
          - 12
          type: integer
          format: int32
          default: 0
        message:
          type: string
    movementReportStatusReturn:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/reportResponseStatus'
        posMovement:
          $ref: '#/components/schemas/posMovement'
    posMovementReportHeader:
      required:
      - reportSequenceNumber
      - primaryReportPeriod
      - beginDateTime
      - endDateTime
      type: object
      properties:
        reportSequenceNumber:
          maximum: 99999999
          minimum: 0
          type: integer
          format: int32
        primaryReportPeriod:
          $ref: '#/components/schemas/movementReportPeriod'
        secondaryReportPeriod:
          $ref: '#/components/schemas/movementReportPeriod'
        beginDateTime:
          minLength: 1
          type: string
          format: date-time
        endDateTime:
          minLength: 1
          type: string
          format: date-time
        reportRange:
          $ref: '#/components/schemas/reportRange'
        businessDate:
          type:
          - string
          - 'null'
          format: date-time
    reportRange:
      type: object
      properties:
        value:
          enum:
          - 0
          - 1
          - 2
          - -1
          type: integer
          format: int32
          default: 0
    transmissionHeader:
      required:
      - storeLocationId
      - vendorName
      - vendorModelVersion
      - organizationId
      type: object
      properties:
        storeLocationId:
          minLength: 1
          type: string
        vendorName:
          minLength: 1
          type: string
        vendorModelVersion:
          minLength: 1
          type: string
        organizationId:
          minLength: 1
          type: string
    posMovementReport:
      required:
      - posMovementReportHeader
      - posMovementReportGroup
      type: object
      properties:
        posMovementReportHeader:
          $ref: '#/components/schemas/posMovementReportHeader'
        posMovementReportGroup:
          type: array
          items:
            $ref: '#/components/schemas/movementReport'
    movementReportPeriod:
      type: object
      properties:
        interval:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          - 9
          - 10
          type:
          - integer
          - 'null'
          format: int32
          default: 0
        value:
          type: string
    posMovement:
      required:
      - transmissionHeader
      - posMovementReport
      type: object
      properties:
        version:
          type: string
        release:
          type: string
        transmissionHeader:
          $ref: '#/components/schemas/transmissionHeader'
        posMovementReport:
          $ref: '#/components/schemas/posMovementReport'
    reportResponseStatus:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        result:
          enum:
          - 0
          - 1
          - 2
          type: integer
          format: int32
          default: 0
        error:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          type: integer
          format: int32
          default: 0
    movementReport:
      type: object
    statusReturn_2:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        result:
          enum:
          - 0
          - 1
          - 2
          type: integer
          format: int32
          default: 0
        error:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          type: integer
          format: int32
          default: 0
        message:
          type: string
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
x-refined-from:
- caseys-general-stores-cas-api-openapi.json
- caseys-general-stores-cas-gateway-api-openapi.json