openapi: 3.0.0
info:
  title: VisibilityIQ Repairs
  version: 1.4.2
servers:
- url: https://api.zebra.com/v2/services/repairs/analytics/visibility
  description: For US
- url: https://api.zebra.com/v2/eu/services/repairs/analytics/visibility
  description: For EU
security:
- BearerAuth: []
- ApiKeyAuth: []
paths:
  /open-orders:
    get:
      tags:
      - Repairs
      summary: Retrieves open repair orders
      description: Retrieves <i>open</i> repair orders for a company-partner combination
        within a given date and time range. <i>Open</i> repair orders represent devices
        expected to be shipped to the customer in the form or replaced devices or
        repaired devices.
      operationId: Retrieve Open Repairs
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object. Currently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array.  Elements other than the first one will be ignored currently. In\
          \ the object, a stands for attribute and o for order.\n  {\n    \"criteria\"\
          : [\n      {\n        \"a\": \"repairNum\",\n        \"o\": \"asc\"\n  \
          \    }\n    ]\n  }                 "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenOrderSortCriteria'
      - name: filter
        in: header
        description: "Filter based on field values in the response.  Numeric value\
          \ will be filtered by an exact match.  Strings will be filtered by partial\
          \ matches as well and are case-insensitive matches.  The filter criteria\
          \ are ANDed together. Date filters are also supported, but the value must\
          \ match the format yyyy-MM-dd'T'HH:mm:ss'Z'. Example\n  {\n    \"repairNum\"\
          : \"12312363-92\",\n    \"expectedSerialNum\": \"12312312312397\"\n  } \
          \                  "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenOrderFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /expected-orders:
    get:
      tags:
      - Repairs
      summary: Retrieves expected repair orders
      description: Retrieves <i>expected</i> repair orders for a company-partner combination
        within a given date and time range. <i>Expected</i> orders represent devices
        that Zebra is waiting to receive from the customer.
      operationId: Retrieve Expected Repairs
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object. Currently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently. \n\
          \  {\n    \"criteria\": [\n      {\n        \"a\": \"repairNum\",\n    \
          \    \"o\": \"asc\"\n      }\n    ]\n  } "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpectedSortCriteria'
      - name: filter
        in: header
        description: "Filter based on field values.  Numeric value will be filtered\
          \ by an exact match.  Strings will be filtered by partial matches as well\
          \ and are case insensitive matches.  The filter criteria are ANDed together.Date\
          \ filters are also supported, but the value must match the format yyyy-MM-dd'T'HH:mm:ss'Z'.\
          \ Example\n  {\n    \"repairNum\": \"12312363-92\",\n    \"expectedSerialNum\"\
          : \"12312312312397\"\n  }                   "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpectedFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /inrepair-orders:
    get:
      tags:
      - Repairs
      summary: Retrieves in repair orders
      description: Retrieves <i>in repair</i> orders for a company-partner combination
        and a given date and time range. <i>In repair</i> orders represent the devices
        which have been received at the repair depot and are currently being worked
        on.
      operationId: Retrieve Active Repairs
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object. Currently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently. \n\
          \  {\n    \"criteria\": [\n      {\n        \"a\": \"repairNum\",\n    \
          \    \"o\": \"asc\"\n      }\n    ]\n  } "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InRepairSortCriteria'
      - name: filter
        in: header
        description: "Filter based on column values.  Numeric value will be filtered\
          \ by an exact match.  Strings will be filtered by partial matches as well\
          \ and are case insensitive matches.  The filter criteria are ANDed together.Date\
          \ filters are also supported, but the value must match the format yyyy-MM-dd'T'HH:mm:ss'Z'\
          \ Example\n  {\n    \"repairNum\": \"12312363-92\",\n    \"expectedSerialNum\"\
          : \"12312312312397\"\n  }                 "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InRepairFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /repaired-orders:
    get:
      tags:
      - Repairs
      summary: Retrieves repaired orders
      description: Retrieves <i>repaired</i> orders for a company-partner combination
        and a given date and time range.  <i>Repair</i> orders represent repaired
        devices and the fault/resolution associated with each repair.
      operationId: Retrieve Completed Repairs
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object. Currently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently. \n\
          \  {\n    \"criteria\": [\n      {\n        \"a\": \"repairNum\",\n    \
          \    \"o\": \"asc\"\n      }\n    ]\n  } "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepairedSortCriteria'
      - name: filter
        in: header
        description: "Filter based on column values.  Numeric value will be filtered\
          \ by an exact match.  Strings will be filtered by partial matches as well\
          \ and are case insensitive matches.  The filter criteria are ANDed together.Date\
          \ filters are also supported, but the value must match the format yyyy-MM-dd'T'HH:mm:ss'Z'\
          \ Example\n  {\n    \"repairNum\": \"12312363-92\",\n    \"expectedSerialNum\"\
          : \"12312312312397\"\n  }                    "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepairedFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /shipped-orders:
    get:
      tags:
      - Repairs
      summary: Retrieves shipped orders
      description: Retrieves <i>shipped</i> orders for a company-partner combination
        and a given date and time range. Shipped orders. <i>Shipped</i> orders represent
        repaired devices or device replacements sent to the customer.
      operationId: Retrieve Shipped Repairs
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object.\nCurrently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently. \n\
          \n  {\n    \"criteria\": [\n      {\n        \"a\": \"repairNum\",\n   \
          \     \"o\": \"asc\"\n      }\n    ]\n  } "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippedSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values.  Numeric value will be filtered by an exact match.  Strings will be filtered by partial matches as well and are case insensitive matches.  The filter criteria are ANDed together.Date filters are also supported, but the value must match the format yyyy-MM-dd'T'HH:mm:ss'Z' Example
            {
              "repairNum": "12312363-92",
              "expectedSerialNum": "12312312312397"
            }
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippedFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /sparepool-orders:
    get:
      tags:
      - Repairs
      summary: Retrieves sparepool information
      description: Retrieves <i>sparepool</i> information for a company-partner combination
        and a given date and time range. <i>Sparepool</i> represent the number devices
        residing in a customer owned pool.
      operationId: Retrieve Sparepool
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object.\nCurrently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently. \n\
          \n  {\n    \"criteria\": [\n      {\n        \"a\": \"repairNum\",\n   \
          \     \"o\": \"asc\"\n      }\n    ]\n  } "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SparepoolSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values.  Numeric value will be filtered by an exact match.  Strings will be filtered by partial matches as well and are case insensitive matches.  The filter criteria are ANDed together. Date filters are also supported, but the value must match the format yyyy-MM-dd'T'HH:mm:ss'Z' Example
            {
              "deviceType": "MOBILE COMPUTER",
              "serialNum": "12312312312397"
            }
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SparepoolFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
  /fastrack-orders:
    get:
      tags:
      - Repairs
      summary: Retrieves fastrack orders
      description: Retrieves  <i>fastrack</i> orders for a company-partner combination
        within a given date and time range whose exchange type as Fastrack.
      operationId: Retrieve fastrack orders
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which data is
          fetched. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results.  Specified as a JSON object.\nCurrently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently. \n\
          \n  {\n    \"criteria\": [\n      {\n        \"a\": \"repairNum\",\n   \
          \     \"o\": \"asc\"\n      }\n    ]\n  } "
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FastrackSortCriteria'
      - name: filter
        in: header
        description: |2-

          Filter based on column values. Numeric value will be filtered by an exact match and also by using relational operators such as <,>,==,<=,>= . Strings will be filtered by partial matches and exact matches by using == relational operator and are case insensitive matches. Filter opeartor and filter values are sepearted by "|".  The filter criteria are ANDed together. Example { "receivedModel": "==|A5XXX1", "receivedDatetime": "23 july 2021" "exchangeType": "Fastrack" }
        required: false
        style: simple
        explode: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FastrackFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
components:
  schemas:
    DateTime:
      type: string
      format: date-time
    Date:
      type: string
      format: date
    ApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/OpenOrder'
            - $ref: '#/components/schemas/ExpectedOrder'
            - $ref: '#/components/schemas/InRepairOrder'
            - $ref: '#/components/schemas/RepairedOrder'
            - $ref: '#/components/schemas/ShippedOrder'
            - $ref: '#/components/schemas/Sparepool'
            - $ref: '#/components/schemas/FastrackOrder'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    ApiError:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this particular occurrence of the problem
        links:
          type: object
          properties:
            about:
              type: string
              description: A link that leads to further details about this particular
                occurrence of the problem
          description: Links providing information related to this error
        status:
          type: integer
          description: The HTTP status code applicable to this problem
          format: int32
        code:
          type: string
          description: An application-specific error code, expressed as a string value
        title:
          type: string
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem, except for purposes
            of localization
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of
            the problem. Like title, this field’s value can be localized
        source:
          type: object
          properties:
            pointer:
              type: string
              description: A JSON Pointer [RFC6901] to the associated entity in the
                request document [e.g. "/data" for a primary data object, or "/data/attributes/title"
                for a specific attribute]
            parameter:
              type: string
              description: A string indicating which URI query parameter caused the
                error
          description: An object containing references to the source of the error
        meta:
          type: object
          description: A meta object containing non-standard meta-information about
            the error
    OpenOrderSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - recordDate
                - receivedModel
                - rmaOpenDatetime
                - deliveredStoreNum
                - inboundAirwayBillNum
                - deviceType
                - exchangeType
                - expectedSerialNum
                - repairNum
                - lastKnownMdmSite
                - problemCode2
                - problemCode1
                - receivedManufactureDate
                - receivedFullModel
                - sfdcCaseNum
                - customerRefNum
                - serviceOrderNum
                - customerDueDatetime
                - repairType
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    OpenOrderFilterCriteria:
      type: object
      properties:
        receivedModel:
          type: string
        deliveredStoreNum:
          type: string
        inboundAirwayBillNum:
          type: string
        deviceType:
          type: string
        exchangeType:
          type: string
        expectedSerialNum:
          type: string
        repairNum:
          type: string
        lastKnownMdmSite:
          type: string
        problemCode2:
          type: string
        problemCode1:
          type: string
        problemDescription:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        receivedFullModel:
          type: string
        sfdcCaseNum:
          type: string
        customerRefNum:
          type: string
        serviceOrderNum:
          type: string
        recordDate:
          $ref: '#/components/schemas/Date'
        rmaOpenDatetime:
          $ref: '#/components/schemas/DateTime'
        customerDueDatetime:
          $ref: '#/components/schemas/DateTime'
        repairType:
          type: string
    ExpectedSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - recordDate
                - receivedModel
                - rmaOpenDatetime
                - deliveredStoreNum
                - replacementShipped
                - inboundAirwayBillNum
                - deviceType
                - exchangeType
                - expectedSerialNum
                - repairNum
                - lastKnownMdmSite
                - receivedManufactureDate
                - receivedFullModel
                - sfdcCaseNum
                - customerRefNum
                - daysOverdue
                - serviceOrderNum
                - returnSerialNum
                - shippedDatetime
                - repairType
                - trackingNum
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    ExpectedFilterCriteria:
      type: object
      properties:
        receivedModel:
          type: string
        deliveredStoreNum:
          type: string
        replacementShipped:
          type: string
        inboundAirwayBillNum:
          type: string
        deviceType:
          type: string
        exchangeType:
          type: string
        expectedSerialNum:
          type: string
        returnSerialNum:
          type: string
        shippedDatetime:
          $ref: '#/components/schemas/DateTime'
        repairNum:
          type: string
        lastKnownMdmSite:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        receivedFullModel:
          type: string
        sfdcCaseNum:
          type: string
        customerRefNum:
          type: string
        serviceOrderNum:
          type: string
        daysOverdue:
          type: integer
          format: int32
        recordDate:
          $ref: '#/components/schemas/DateTime'
        rmaOpenDatetime:
          $ref: '#/components/schemas/DateTime'
        repairType:
          type: string
        trackingNum:
          type: string
    InRepairSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - inboundTrackingNum
                - recordDate
                - unexpectedReceipt
                - receivedModel
                - deliveredStoreNum
                - inboundAirwayBillNum
                - deviceType
                - exchangeType
                - repairNum
                - lastKnownMdmSite
                - problemCode2
                - receivedOnly
                - problemCode1
                - receivedFullModel
                - receiveDatetime
                - sfdcCaseNum
                - customerRefNum
                - receivedSerialNum
                - serviceOrderNum
                - age
                - repairType
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    InRepairFilterCriteria:
      type: object
      properties:
        inboundTrackingNum:
          type: string
        unexpectedReceipt:
          type: string
        receivedModel:
          type: string
        deliveredStoreNum:
          type: string
        inboundAirwayBillNum:
          type: string
        deviceType:
          type: string
        exchangeType:
          type: string
        repairNum:
          type: string
        lastKnownMdmSite:
          type: string
        problemCode2:
          type: string
        receivedOnly:
          type: string
        problemCode1:
          type: string
        problemDescription:
          type: string
        receivedFullModel:
          type: string
        sfdcCaseNum:
          type: string
        customerRefNum:
          type: string
        receivedSerialNum:
          type: string
        serviceOrderNum:
          type: string
        age:
          type: integer
          format: int32
        recordDate:
          $ref: '#/components/schemas/DateTime'
        receivedDatetime:
          $ref: '#/components/schemas/DateTime'
        repairType:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
    RepairedSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - inboundTrackingNum
                - recordDate
                - repairDatetime
                - receivedModel
                - deliveredStoreNum
                - repairClassification
                - fault
                - remedy
                - deviceType
                - exchangeType
                - repairNum
                - lastKnownMdmSite
                - problemCode2
                - problemCode1
                - receivedManufactureDate
                - receivedFullModel
                - action
                - sfdcCaseNum
                - customerRefNum
                - receivedSerialNum
                - serviceOrderNum
                - age
                - repairType
                - installedSerialNum
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    RepairedFilterCriteria:
      type: object
      properties:
        inboundTrackingNum:
          type: string
        receivedModel:
          type: string
        deliveredStoreNum:
          type: string
        repairClassification:
          type: string
        fault:
          type: string
        remedy:
          type: string
        deviceType:
          type: string
        exchangeType:
          type: string
        repairNum:
          type: string
        lastKnownMdmSite:
          type: string
        problemCode2:
          type: string
        problemCode1:
          type: string
        problemDescription:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        receivedFullModel:
          type: string
        action:
          type: string
        sfdcCaseNum:
          type: string
        customerRefNum:
          type: string
        receivedSerialNum:
          type: string
        serviceOrderNum:
          type: string
        age:
          type: string
        recordDate:
          $ref: '#/components/schemas/DateTime'
        repairDatetime:
          $ref: '#/components/schemas/DateTime'
        repairType:
          type: string
        installedSerialNum:
          type: string
    ShippedSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - shippedDatetime
                - trackingNum
                - deviceType
                - deliveredStoreNum
                - exchangeType
                - replacedFullModel
                - expectedSerialNum
                - repairNum
                - lastKnownMdmSite
                - receivedManufactureDate
                - replacedModel
                - onTime
                - sfdcCaseNum
                - customerRefNum
                - receivedSerialNum
                - serviceOrderNum
                - returnSerialNum
                - carrierCode
                - rmaOpenDatetime
                - receiveDatetime
                - repairType
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    ShippedFilterCriteria:
      type: object
      properties:
        trackingNum:
          type: string
        deviceType:
          type: string
        deliveredStoreNum:
          type: string
        exchangeType:
          type: string
        replacedFullModel:
          type: string
        expectedSerialNum:
          type: string
        repairNum:
          type: string
        lastKnownMdmSite:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        replacedModel:
          type: string
        onTime:
          type: string
        sfdcCaseNum:
          type: string
        customerRefNum:
          type: string
        receivedSerialNum:
          type: string
        serviceOrderNum:
          type: string
        returnSerialNum:
          type: string
        carrierCode:
          type: string
        recordDate:
          $ref: '#/components/schemas/DateTime'
        shippedDatetime:
          $ref: '#/components/schemas/DateTime'
        rmaOpenDatetime:
          $ref: '#/components/schemas/DateTime'
        receivedDatetime:
          $ref: '#/components/schemas/DateTime'
        repairType:
          type: string
    SparepoolSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - lastRepairNum
                - fullModel
                - model
                - repairCompleteDate
                - serialNum
                - sparepoolId
                - sparepoolName
                - deviceType
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    SparepoolFilterCriteria:
      type: object
      properties:
        lastRepairNum:
          type: string
        fullModel:
          type: string
        model:
          type: string
        serialNum:
          type: string
        sparepoolId:
          type: string
        sparepoolName:
          type: string
        deviceType:
          type: string
        repairCompleteDate:
          $ref: '#/components/schemas/DateTime'
    FastrackSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - serviceOrderNum
                - repairNum
                - exchangeType
                - customerRefNum
                - rmaOpenDatetime
                - expectedSerialNum
                - customerDueDate
                - shippedDatetime
                - returnSerialNum
                - receivedDatetime
                - receivedSerialNum
                - repairDatetime
                - receivedModel
                - receivedFullModel
                - deliveredStoreNum
                - trackingNumber
                - carrierCode
                - falseCall
                - falseCallReason
                - onTime
                - sfdcCaseNum
                - deviceType
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    FastrackFilterCriteria:
      type: object
      properties:
        serviceOrderNum:
          type: string
        repairNum:
          type: string
        exchangeType:
          type: string
        customerRefNum:
          type: string
        rmaOpenDatetime:
          $ref: '#/components/schemas/DateTime'
        expectedSerialNum:
          type: string
        customerDueDate:
          $ref: '#/components/schemas/DateTime'
        shippedDatetime:
          $ref: '#/components/schemas/DateTime'
        returnSerialNum:
          type: string
        receivedDatetime:
          type: string
        receivedSerialNum:
          type: string
        repairDatetime:
          $ref: '#/components/schemas/DateTime'
        receivedModel:
          type: string
        receivedFullModel:
          type: string
        deliveredStoreNum:
          type: string
        trackingNumber:
          type: string
        carrierCode:
          type: string
        falseCall:
          type: string
        falseCallReason:
          type: string
        onTime:
          type: string
        sfdcCaseNum:
          type: string
        deviceType:
          type: string
    OpenOrder:
      type: object
      properties:
        recordDate:
          $ref: '#/components/schemas/DateTime'
        inboundAirwayBillNum:
          type: string
        rmaOpenDatetime:
          $ref: '#/components/schemas/DateTime'
        receivedModel:
          type: string
        expectedSerialNum:
          type: string
        exchangeType:
          type: string
        lastKnownMdmSite:
          type: string
        problemCode2:
          type: string
        problemCode1:
          type: string
        problemDescription:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        repairNum:
          type: string
        deliveredStoreNum:
          type: string
        receivedFullModel:
          type: string
        customerRefNum:
          type: string
        serviceOrderNum:
          type: string
        customerDueDatetime:
          $ref: '#/components/schemas/DateTime'
        sfdcCaseNum:
          type: string
        deviceType:
          type: string
        repairType:
          type: string
      example:
        recordDate: 2020-03-04T00:00:00Z
        receivedModel: TXXXXX
        rmaOpenDatetime: 2020-03-04T22:31:06Z
        deliveredStoreNum: null
        inbountAirwayBillNum: null
        deviceType: MOBILE COMPUTER
        exchangeType: Repair and Return
        expectedSerialNum: "12312312312381"
        repairNum: 12312356-93
        lastKnownMdmSite: Zebra
        problemCode2: Others
        problemCode1: Unspecified
        problemDescription: UNABLE TO TURN ON DEVICE
        receivedManufactureDate: Sep 20 2017
        receivedFullModel: TCXXXK-2XXXXX-XX
        sfdcCaseNum: "12312392"
        customerRefNum: null
        serviceOrderNum: "12312356"
        customerDueDatetime: 2020-03-09T22:10:58Z
        repairType: Depot
    ExpectedOrder:
      type: object
      properties:
        inboundAirwayBillNum:
          type: string
        rmaOpenDatetime:
          $ref: '#/components/schemas/DateTime'
        receivedModel:
          type: string
        recordDate:
          $ref: '#/components/schemas/DateTime'
        expectedSerialNum:
          type: string
        returnSerialNum:
          type: string
        shippedDatetime:
          $ref: '#/components/schemas/DateTime'
        exchangeType:
          type: string
        lastKnownMdmSite:
          type: string
        problemCode:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        repairNum:
          type: string
        deliveredStoreNum:
          type: string
        receivedFullModel:
          type: string
        customerRefNum:
          type: string
        serviceOrderNum:
          type: string
        sfdcCaseNum:
          type: string
        deviceType:
          type: string
        replacementShipped:
          type: string
        daysOverdue:
          type: integer
        repairType:
          type: string
        trackingNum:
          type: string
      example:
        recordDate: 2020-03-04T00:00:00Z
        receivedModel: XXXXXXXXX
        rmaOpenDatetime: 2019-10-24T14:12:47Z
        deliveredStoreNum: null
        replacementShipped: "N"
        inbountAirwayBillNum: null
        deviceType: MOBILE COMPUTER
        exchangeType: Repair and Return
        expectedSerialNum: XX12312360
        returnSerialNum: "12312312312374"
        shippedDatetime: 2020-03-04T21:58:31Z
        repairNum: 12312313 - 1
        lastKnownMdmSite: 6123 XXXX XXX
        receivedManufactureDate: Aug 14 2017
        problemCode: null
        receivedFullModel: ETXXXX - L15E - XXXX
        sfdcCaseNum: "12312331"
        daysOverdue: 16
        customerRefNum: INC000001231232
        serviceOrderNum: "12312313"
        repairType: Depot
        trackingNum: "123123123123"
    InRepairOrder:
      type: object
      properties:
        inboundTrackingNum:
          type: string
        recordDate:
          $ref: '#/components/schemas/DateTime'
        unexpectedReceipt:
          type: string
        receivedModel:
          type: string
        deliveredStoreNum:
          type: string
        inboundAirwayBillNum:
          type: string
        deviceType:
          type: string
        exchangeType:
          type: string
        repairNum:
          type: string
        lastKnownMdmSite:
          type: string
        problemCode2:
          type: string
        receivedOnly:
          type: string
        problemCode1:
          type: string
        problemDescription:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        receivedFullModel:
          type: string
        receivedDatetime:
          $ref: '#/components/schemas/DateTime'
        sfdcCaseNum:
          type: string
        customerRefNum:
          type: string
        receivedSerialNum:
          type: string
        serviceOrderNum:
          type: string
        age:
          type: integer
        repairType:
          type: string
      example:
        inboundTrackingNum: 1z1231231231231231
        recordDate: 2020-03-04T00:00:00Z
        unexpectedReceipt: "N"
        receivedModel: TCXXXX
        deliveredStoreNum: null
        inbountAirwayBillNum: null
        deviceType: MOBILE COMPUTER
        exchangeType: Repair and Return
        repairNum: 12312356 - 5
        lastKnownMdmSite: Zebra
        problemCode2: Others
        problemDescription: UNABLE TO TURN ON DEVICE
        receivedOnly: null
        problemCode1: Unspecified
        receivedManufactureDate: Jan 22 2018
        receivedFullModel: TC510K - 2PAZXXX - XX
        receivedDatetime: 2020-03-04T23:16:16Z
        sfdcCaseNum: "12312392"
        customerRefNum: null
        receivedSerialNum: "12312312312381"
        serviceOrderNum: "12312356"
        age: 8
        repairType: Depot
    RepairedOrder:
      type: object
      properties:
        inboundTrackingNum:
          type: string
        recordDate:
          $ref: '#/components/schemas/DateTime'
        repairDatetime:
          $ref: '#/components/schemas/DateTime'
        receivedModel:
          type: string
        deliveredStoreNum:
          type: string
        repairClassification:
          type: string
        fault:
          type: string
        remedy:
          type: string
        deviceType:
          type: string
        exchangeType:
          type: string
        repairNum:
          type: string
        lastKnownMdmSite:
          type: string
        problemCode2:
          type: string
        problemCode1:
          type: string
        problemDescription:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        receivedFullModel:
          type: string
        action:
          type: string
        sfdcCaseNum:
          type: string
        customerRefNum:
          type: string
        receivedSerialNum:
          type: string
        serviceOrderNum:
          type: string
        age:
          type: string
        repairType:
          type: string
        installedSerialNum:
          type: string
      example:
        inboundTrackingNum: "9622013700004944686100778123123123"
        recordDate: 2020-03-25T00:00:00Z
        repairDatetime: 2020-03-04T21:19:31Z
        receivedModel: XX31XX
        deliveredStoreNum: NA
        repairClassification: Damage
        fault: Damage - Cracked Touch Panel Scanner - Intermittent Damage - Physical
          Damage Damage - Connector Battery - Backup Batt Not Charge
        remedy: null
        deviceType: MOBILE COMPUTER
        exchangeType: Repair and Return
        repairNum: 12312320 - 15
        lastKnownMdmSite: null
        problemCode2: null
        problemCode1: Unspecified
        problemDescription: UNABLE TO TURN ON DEVICE
        receivedManufactureDate: Jan 14 2013
        receivedFullModel: XX3190 - XX4S04E0A
        action: Replace / Install Replace / Install Replace / Install Replace / Install
          Replace / Install
        sfdcCaseNum: "12312358"
        customerRefNum: null
        receivedSerialNum: "12312312312333"
        serviceOrderNum: "12312320"
        age: "N"
        repairType: Depot
        installedSerialNum: "12312312312334"
    ShippedOrder:
      type: object
      properties:
        shippedDatetime:
          $ref: '#/components/schemas/DateTime'
        recordDate:
          $ref: '#/components/schemas/DateTime'
        trackingNum:
          type: string
        deviceType:
          type: string
        deliveredStoreNum:
          type: string
        exchangeType:
          type: string
        replacedFullModel:
          type: string
        expectedSerialNum:
          type: string
        repairNum:
          type: string
        lastKnownMdmSite:
          type: string
        receivedManufactureDate:
          $ref: '#/components/schemas/Date'
        replacedModel:
          type: string
        onTime:
          type: string
        sfdcCaseNum:
          type: string
        customerRefNum:
          type: string
        receivedSerialNum:
          type: string
        serviceOrderNum:
          type: string
        returnSerialNum:
          type: string
        carrierCode:
          type: string
        rmaOpenDatetime:
          $ref: '#/components/schemas/DateTime'
        receivedDatetime:
          $ref: '#/components/schemas/DateTime'
        repairType:
          type: string
      example:
        shippedDatetime: 2020-03-04T21:58:31Z
        recordDate: 2020-03-04T00:00:00Z
        trackingNum: "123123123123"
        deviceType: MOBILE COMPUTER
        deliveredStoreNum: null
        exchangeType: Repair and Return
        replacedFullModel: XX32N0-XX4HXXXXX
        expectedSerialNum: "12312312312374"
        repairNum: 12312380-57
        lastKnownMdmSite: null
        receivedManufactureDate: Jun 12 2017
        replacedModel: XX32XX
        onTime: "Y"
        sfdcCaseNum: "12312399"
        customerRefNum: null
        receivedSerialNum: "12312312312374"
        serviceOrderNum: "12312380"
        returnSerialNum: "12312312312374"
        carrierCode: XXXXX
        rmaOpenDatetime: 2020-03-04T22:31:06Z
        receivedDatetime: 2020-03-04T23:16:16Z
        repairType: Depot
    Sparepool:
      type: object
      properties:
        lastRepairNum:
          type: string
        fullModel:
          type: string
        model:
          type: string
        repairCompleteDate:
          $ref: '#/components/schemas/DateTime'
        serialNum:
          type: string
        sparepoolId:
          type: string
        sparepoolName:
          type: string
        deviceType:
          type: string
      example:
        lastRepairNum: 12312393-1
        fullModel: DS3608-XXX
        model: DS3608
        repairCompleteDate: 2020-03-05T03:58:09Z
        serialNum: "12312312312395"
        sparepoolId: US04C1232
        sparepoolName: EPIABC-US04C
        deviceType: SCANNER
    FastrackOrder:
      type: object
      properties:
        serviceOrderNum:
          type: string
        repairNum:
          type: string
        exchangeType:
          type: string
        customerRefNum:
          type: string
        rmaOpenDatetime:
          $ref: '#/components/schemas/DateTime'
        expectedSerialNum:
          type: string
        customerDueDate:
          $ref: '#/components/schemas/DateTime'
        shippedDatetime:
          $ref: '#/components/schemas/DateTime'
        returnSerialNum:
          type: string
        receivedDatetime:
          type: string
        receivedSerialNum:
          type: string
        repairDatetime:
          $ref: '#/components/schemas/DateTime'
        receivedModel:
          type: string
        receivedFullModel:
          type: string
        deliveredStoreNum:
          type: string
        trackingNumber:
          type: string
        carrierCode:
          type: string
        falseCall:
          type: string
        falseCallReason:
          type: string
        onTime:
          type: string
        sfdcCaseNum:
          type: string
        deviceType:
          type: string
      example:
        serviceOrderNum: "12312380"
        repairNum: 12312380-57
        exchangeType: Fastrack
        customerRefNum: "1231231"
        rmaOpenDatetime: 2020-03-04T22:31:06Z
        expectedSerialNum: "12312312312374"
        customerDueDate: 2020-03-09T22:10:58Z
        shippedDatetime: 2020-03-04T21:58:31Z
        returnSerialNum: "12312312312374"
        receivedDatetime: 2020-03-04T22:31:06Z
        receivedSerialNum: "12312312312381"
        repairDatetime: 2020-03-04T21:19:31Z
        receivedModel: TXXXXX
        receivedFullModel: MC9090-GF0HJEFA6WR
        deliveredStoreNum: "123092103"
        trackingNumber: "123123123123"
        carrierCode: XXXXX
        falseCall: "Y"
        falseCallReason: OS Failure
        onTime: "Y"
        sfdcCaseNum: "12312392"
        deviceType: MOBILE COMPUTER
    ApiResponseStatus:
      type: integer
      description: The HTTP status code
      format: int32
    ApiResponseMeta:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this request
        total:
          type: integer
          description: The total number of results
        offset:
          type: integer
          description: The offset used in this request
        limit:
          type: integer
          description: The effective limit used in this request
    ApiResponseLinks:
      type: object
      properties:
        self:
          type: string
          description: URL to this page
        first:
          type: string
          description: URL to the first page
        last:
          type: string
          description: URL to the last page
        prev:
          type: string
          description: URL to the previous page
        next:
          type: string
          description: URL to the next page
      description: Links for navigation. Only the applicable links are required to
        be present.
  responses:
    Response200:
      description: Successful operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
    Response400:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response500:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  parameters:
    companyName:
      name: companyName
      in: header
      description: Company name
      required: true
      schema:
        type: string
    partnerName:
      name: partnerName
      in: header
      description: Partner name
      required: true
      schema:
        type: string
    startDatetime:
      name: startDatetime
      in: header
      description: ISO timestamp for the start of the time period in which data is
        retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
      required: true
      schema:
        $ref: '#/components/schemas/DateTime'
    endDatetime:
      name: endDatetime
      in: header
      description: ISO timestamp for the end of the time period in which data is fetched.
        Example=2020-04-13T00:00:00Z
      required: true
      schema:
        $ref: '#/components/schemas/DateTime'
    offset:
      name: offset
      in: query
      description: 'Pagination parameter indicating the starting record position for
        returning the results from the result set.  Any positive value is acceptable.
        An offset bigger than the number of available results will result in an error.
        A negative value will be replaced with 0. Normally, value should be 0 or a
        positive multiple of limit. '
      required: false
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: 'Pagination size indicating the maximum number of results to be
        returned in the response. Valid values are 1 to 20000. Values higher than
        20000 will be replaced with 20000. Values less than 1 will be replaced with
        250. '
      required: false
      schema:
        type: integer
        default: 250
  requestBodies: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
    ApiKeyAuth:
      type: apiKey
      name: X-APIKey
      in: header
  links: {}
  callbacks: {}