Inspectorio REPORT API

openapi: 3.2.0
info:
  title: Inspectorio REPORT API
  version: v1
  description: 'Operations tagged REPORT across 2 of this provider''s published API definitions: inspectorio-qrm-openapi.json, inspectorio-rsc-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: Production Environment
  url: https://sight.inspectorio.com
- description: Pre-Production Environment
  url: https://sight.pre.inspectorio.com
- description: Production Environment
  url: https://rise-integration.inspectorio.com
- description: Pre-Production Environment
  url: https://rise-integration.pre.inspectorio.com
security:
- ApiKeyAuth: []
tags:
- name: Report
paths:
  /api/v1/reports:
    get:
      summary: List Reports
      parameters:
      - description: Style ID of items included in reports
        in: query
        name: style_id
        required: false
        schema:
          example: Style_1
          type: string
      - description: limit number of results per page
        in: query
        name: limit
        required: false
        schema:
          default: 10
          maximum: 200
          minimum: 1
          type: integer
      - description: End date of the range when reports were created
        in: query
        name: created_to
        required: false
        schema:
          example: '2021-12-31T23:59:59Z'
          format: date-time
          type: string
      - description: End date of the range when reports were updated
        in: query
        name: updated_to
        required: false
        schema:
          example: '2021-12-31T23:59:59Z'
          format: date-time
          type: string
      - description: Start date of the range when reports were updated by the system (including both client actions and actions taken by Inspectorio on behalf of the client)
        in: query
        name: system_updated_from
        required: false
        schema:
          example: '2021-01-31T00:00:00Z'
          format: date-time
          type: string
      - description: Order of reports in response by report creation date in descending or ascending
        in: query
        name: order
        required: false
        schema:
          default: created_date:desc
          example: created_date:desc|asc
          type: string
      - description: CAPA status of the report
        in: query
        name: capa_status
        required: false
        schema:
          enum:
          - Waiting for Response
          - Submitted
          - Submitted by Reviewer
          - Rejected
          - Re-inspection Requested (Solved)
          - Re-inspection Requested (Unsolved)
          - Approved
          example: Waiting for Response
          type: string
      - in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Start date of the range when reports were updated
        in: query
        name: updated_from
        required: false
        schema:
          example: '2021-01-31T00:00:00Z'
          format: date-time
          type: string
      - description: Start date of the range when reports were created
        in: query
        name: created_from
        required: false
        schema:
          example: '2021-01-31T00:00:00Z'
          format: date-time
          type: string
      - description: Status of reports
        in: query
        name: status
        required: false
        schema:
          enum:
          - in-progress
          - pending
          - completed
          example: in-progress
          type: string
      - description: End date of the range when reports were updated by the system (including both client actions and actions taken by Inspectorio on behalf of the client)
        in: query
        name: system_updated_to
        required: false
        schema:
          example: '2021-12-31T23:59:59Z'
          format: date-time
          type: string
      - description: End date of the range of inspection date in reports
        in: query
        name: inspection_date_to
        required: false
        schema:
          example: '2021-12-31T23:59:59Z'
          format: date-time
          type: string
      - description: Start date of the range of inspection date in reports
        in: query
        name: inspection_date_from
        required: false
        schema:
          example: '2021-01-31T00:00:00Z'
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportListResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestApiError'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedApiError'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateApiError'
          description: Validation Error
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyResponsesApiError'
          description: Rate-limiting Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalApiError'
          description: Internal Error
      tags:
      - Report
      operationId: getApiV1Reports
      x-operation-id-source: derived
    servers:
    - description: Production Environment
      url: https://sight.inspectorio.com
    - description: Pre-Production Environment
      url: https://sight.pre.inspectorio.com
  /api/v1/reports/{report_id}:
    get:
      summary: Get Report
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestApiError'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedApiError'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateApiError'
          description: Validation Error
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyResponsesApiError'
          description: Rate-limiting Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalApiError'
          description: Internal Error
      tags:
      - Report
      operationId: getApiV1ReportsByReportId
      x-operation-id-source: derived
    servers:
    - description: Production Environment
      url: https://sight.inspectorio.com
    - description: Pre-Production Environment
      url: https://sight.pre.inspectorio.com
  /api/v1/reports/{report_id}/steps/{step_id}:
    get:
      operationId: getStepExecution
      parameters:
      - in: path
        name: step_id
        required: true
        schema:
          type: string
      - in: path
        name: report_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StepExecutionResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestApiError'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedApiError'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateApiError'
          description: Validation Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalApiError'
          description: Internal Error
      summary: Get Step Execution
      tags:
      - Report
    servers:
    - description: Production Environment
      url: https://rise-integration.inspectorio.com
    - description: Pre-Production Environment
      url: https://rise-integration.pre.inspectorio.com
components:
  schemas:
    InspectionStandardsMaxAllowed:
      properties:
        critical:
          description: The number of critical defects max allowed
          example: '0'
          type: string
        major:
          description: The number of major defects max allowed
          example: '1'
          type: string
        minor:
          description: The number of minor defects max allowed
          example: '1'
          type: string
      type: object
    InspectionSpecialAttentionPointPictures:
      properties:
        rotateAngle:
          description: Angle of rotation of the picture
          example: '0'
          type: string
        source:
          description: Direct URL to the picture
          example: https://.../image1.jpg
          type: string
      type: object
    BookingSolidItem:
      properties:
        availableCartonQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        availableQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        brandId:
          description: 'Precondition: must be configured in your Inspectorio''s account.'
          example: brand_1
          type:
          - string
          - 'null'
        brandName:
          minLength: 1
          readOnly: true
          type: string
        cartonQuantity:
          minimum: 0
          type:
          - integer
          - 'null'
        casePackQuantity:
          minimum: 0
          type:
          - integer
          - 'null'
        classId:
          example: class_id_1
          type:
          - string
          - 'null'
        color:
          minLength: 1
          type: string
        departmentId:
          example: department_id_1
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        itemId:
          minLength: 1
          type: string
        quantity:
          minimum: 1
          type: integer
        shipmentTerm:
          example: shipment_term_1
          type:
          - string
          - 'null'
        size:
          minLength: 1
          type: string
      required:
      - color
      - itemId
      - quantity
      - size
      type: object
    InspectionStandardsSampleSizeCategory:
      properties:
        productCategory:
          description: Unique identifier of the product category
          example: '124301'
          type: string
        sampleSize:
          description: Sample size
          example: '8'
          type: integer
      type: object
    InspectionGeneralPos:
      properties:
        poNumber:
          description: PO Number of the report
          example: PO123
          type: string
      type: object
    InspectionQuestions:
      properties:
        groupId:
          description: Unique identifier of the group of question
          example: 7384b63c-bc99-43f0-b1b5-600959220e19_1e601f70-3c65-4ea8-931f-4976b9c91b3a
          type: string
        inspectionId:
          description: Unique identifier of the report
          example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
          type: string
        label:
          description: Label of the question
          example: Do we need to pull a Green sealed sample?
          type: string
        options:
          description: Options available to answer the question
          items:
            $ref: '#/components/schemas/InspectionQuestionsOptions'
          type: array
        organizationId:
          description: Unique identifier of the organization
          example: 'null'
          type: string
        questionId:
          description: Unique identifier of the question
          example: 7384b63c-bc99-43f0-b1b5-600959220e19_5689d212-b001-4ad2-89c7-2c39654d4cc3_SyJivf3CA
          type: string
        type:
          description: Type of the question
          example: 'null'
          type: string
      type: object
    ReportResponseSchemaInspectionEsignatures:
      properties:
        id:
          description: Unique Identifier of the inspection eSignature
          example: 123456
          type: integer
        name:
          description: Name of the inspector who provided eSignature
          example: Bob
          type:
          - string
          - 'null'
        signature:
          description: Name of the inspector who provided eSignature
          example: https://example.jpg
          type: string
        title:
          description: Title of the inspector who provided eSignature
          example: Factory Representative
          type: string
      type: object
    InspectionQuestionsOptions:
      properties:
        actions:
          description: List of actions per question
          items:
            $ref: '#/components/schemas/InspectionQuestionsOptionsActions'
          type: array
        failResponse:
          description: Boolean indicating whether the option, if selected, will make the overall inspection result fail
          example: 'false'
          type: boolean
        id:
          description: Unique identifier of the option
          example: chk__97
          type: string
        selected:
          description: Boolean indicating whether the option has been selected
          example: 'true'
          type: boolean
        value:
          description: Label of the option displayed to the user
          example: 'YES'
          type: string
      type: object
    InspectionPhotos:
      properties:
        file:
          $ref: '#/components/schemas/InspectionPhotosFile'
          description: List of the files
        groupId:
          description: Unique identifier of the group of photo
          type: string
        inspectionId:
          description: Unique identifier of the report
          example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
          type: string
        itemId:
          description: Unique identifier of the item
          example: 02112-1851
          type: string
        label:
          description: Label of the photo
          type: string
        organizationId:
          description: Unique identifier of the organization who executed the inspection
          example: '200373'
          type: string
        photoId:
          description: Unique identifier of the photo
          type: string
        status:
          description: Status of the photo
          type: string
        styleId:
          description: Unique identifier of the style
          example: '123456'
          type: string
        type:
          description: Type of the photo
          example: image
          type: string
      type: object
    OrganizationContact:
      properties:
        contactId:
          example: contact_id
          type: string
        email:
          example: email@email.com
          type: string
        mobileNumber:
          example: '1234567890'
          type: string
        name:
          example: Contact Name
          type: string
        telephoneNumber:
          example: '1234567890'
          type: string
      type: object
    InspectionAssortment:
      properties:
        assortmentId:
          minLength: 1
          type: string
        availableCartonQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        cartonQuantity:
          minimum: 0
          type: integer
        items:
          items:
            $ref: '#/components/schemas/InspectionAssortmentItem'
          minItems: 1
          type: array
      required:
      - assortmentId
      - cartonQuantity
      - items
      type: object
    InternalApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        errors:
          example:
            system:
            - Internal error detail message
          type: object
        message:
          example: Internal server error
          type: string
      type: object
    BookingMeasurementItemDetail:
      properties:
        measurement:
          type: string
        size:
          description: Size name
          example: Medium
          minLength: 1
          type: string
      required:
      - measurement
      - size
      type: object
    User:
      properties:
        email:
          type: string
        id:
          type: string
        mobileNumber:
          type: string
        name:
          type: string
      type: object
    InspectionStandardsCountedForAql:
      properties:
        critical:
          description: The number of critical defects that counted for AQL
          example: '1'
          type: string
        major:
          description: The number of major defects that counted for AQL
          example: '0'
          type: string
        minor:
          description: The number of minor defects that counted for AQL
          example: '0'
          type: string
      type: object
    InspectionResult:
      properties:
        groupName:
          description: Name of the group of results
          example: Check In
          type: string
        includeInReport:
          description: Boolean indicating if the result is included in the report
          example: 'true'
          type: boolean
        inspectionId:
          description: Unique identifier of the report
          example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
          type: string
        organizationId:
          description: Unique identifier of the organization who executed the inspection
          example: '200373'
          type: string
        resultId:
          description: Unique identifier of the result
          example: 7384b63c-bc99-43f0-b1b5-600959220e19_6e451830-1d61-4a14-a5e7-03ce20704f52
          type: string
        status:
          description: Status of the result
          example: non-applicable
          type: string
      type: object
    InspectionPhotosFile:
      properties:
        description:
          description: Description of the photo, if any
          example: photo_1
          type: string
        fileType:
          description: Type of the file
          example: image
          type: string
        rotateAngle:
          description: Angle of rotation of the photo
          example: '0'
          type: string
        source:
          description: Direct URL to the photo
          example: https://.../.../.../1a2b3c4d-1a2b-1a2b-1a2b3c4d_eb77a158.jpg
          type: string
      type: object
    ReportListInspectionGeneral:
      properties:
        actualInspectionDate:
          description: Date when the inspection was started on mobile
          example: '2021-06-03T00:00:00+00:00'
          format: date-time
          type:
          - string
          - 'null'
        bookingType:
          description: Type of the booking, e.g. Normal
          example: normal
          type: string
        capaStatus:
          description: Status of the CAPA
          example: Waiting for Response
          type: string
        caseNumber:
          description: Case number of the report generated based on a configurable rule
          example: 5832DUPRO2019-00537345TESTMTTestInspectorioFactoryASOLID-ASSORTMENT2019-12-095832IS
          type: string
        client:
          $ref: '#/components/schemas/InspectionGeneralOrganizationWithLocalId'
          description: Information on the brand/retailer
        country:
          description: Country of shipment
          example: VN
          type: string
        createdDate:
          description: Date and time when the inspection started
          example: '2021-06-03 07:18:05.372000+00:00'
          type: string
        creator:
          $ref: '#/components/schemas/User'
          description: Information on the user who generated the report
        executor:
          $ref: '#/components/schemas/InspectionGeneralOrganization'
          description: Information on the executor of the report
        expectedDate:
          description: Expected date of inspection that was selected when creating a new inspection
          example: '2021-06-03 00:00:00+00:00'
          type: string
        factory:
          $ref: '#/components/schemas/InspectionGeneralOrganizationWithLocalId'
          description: Information on the factory of the report
        inspectionDate:
          description: Date and time when the inspection completed
          example: '2021-06-03 08:27:20.624000+00:00'
          type: string
        inspectionId:
          description: Unique identifier of the inspection's report
          example: 123a456b-abcd-efgh-ijk1-a88aa05d7c86
          type: string
        inspectionForm:
          description: The name of the inspection form used
          example: FIForm
          type: string
        inspectionLocation:
          $ref: '#/components/schemas/InspectionGeneralOrganizationWithLocalId'
          description: The location of the inspection
          example: 'null'
        inspectionResult:
          description: Overall result of the inspection
          example: fail
          type: string
        inspector:
          $ref: '#/components/schemas/Inspector'
          description: Information on the inspector
        isReferenceSample:
          description: Indicates whether a reference sample had been provided
          example: 'null'
          type: integer
        opoNumber:
          description: Original PO Number of the report
          example: 123-456
          type: string
        oversightOffice:
          $ref: '#/components/schemas/InspectionGeneralOversightOffice'
          description: Oversight office
        pdfUrl:
          description: Direct URL to the report in PDF format
          example: https://.../.../.../.../case-number_123a456b-abcd-efgh-ijk1-a88aa05d7c86.pdf
          type: string
        poNumber:
          description: PO Number of the report
          example: 123-456-L001
          type: string
        productCategories:
          description: List of unique identifiers of all the product categories
          items:
            type: string
          type:
          - array
          - 'null'
        productLineId:
          description: Unique identifier of the product line
          example: '100991'
          type: string
        productLineName:
          description: Name of the product line
          example: APPAREL
          type: string
        productOrders:
          description: List of all the PO numbers
          items:
            type: string
          type:
          - array
          - 'null'
        productStyles:
          description: List of all the styles with items and measurements
          items:
            $ref: '#/components/schemas/ReportListProductStyle'
          type:
          - array
          - 'null'
        status:
          description: Status of the report, e.g. In-Progress, Completed
          example: completed
          type: string
        systemUpdatedAt:
          description: Date and time the report was last updated by the system (including both client actions and actions taken by Inspectorio on behalf of the client)
          example: '2021-06-03 08:27:21.316000+00:00'
          type: string
        tags:
          description: Labels attached to the report giving other information, e.g. 1st re-inspection
          example: 'null'
          items:
            type: string
          type:
          - array
          - 'null'
        type:
          $ref: '#/components/schemas/BookingInspectionInformation'
          description: Information on the type of inspection
        updatedDate:
          description: Date and time the report was last updated
          example: '2021-06-03 08:27:21.316000+00:00'
          type: string
        vendor:
          $ref: '#/components/schemas/InspectionGeneralOrganizationWithLocalId'
          description: Information on the supplier of the report
        workflowName:
          description: Name of workflow
          example: DUPRO Apparel workflow
          type:
          - string
          - 'null'
      type: object
    TooManyResponsesApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        message:
          example: Too many requests
          type: string
      type: object
    ProductStyle:
      properties:
        assortments:
          items:
            $ref: '#/components/schemas/InspectionAssortment'
          type:
          - array
          - 'null'
        measurements:
          items:
            $ref: '#/components/schemas/InspectionMeasurement'
          type: array
        productCategoryId:
          example: product_category_1
          type: string
        productCategoryName:
          minLength: 1
          readOnly: true
          type: string
        solids:
          items:
            $ref: '#/components/schemas/InspectionSolidItem'
          type:
          - array
          - 'null'
        styleId:
          example: style_1
          minLength: 1
          type: string
        styleName:
          type:
          - string
          - 'null'
      required:
      - productCategoryId
      - styleId
      type: object
    InspectionDefectListPhoto:
      properties:
        description:
          description: Description of the defect photo
          example: Mismatch color
          type: string
        rotateAngle:
          description: Angle of rotation of the defect photo
          example: '0'
          type: string
        source:
          description: Source of the defect photo
          example: https://.../image1.jpg
          type: string
      type: object
    InspectionMeasurement:
      properties:
        caption:
          minLength: 1
          type: string
        isPomCritical:
          description: Measurement is critical or not
          example: 'true'
          type:
          - boolean
          - 'null'
        pom:
          minLength: 1
          type: string
        sizes:
          items:
            $ref: '#/components/schemas/BookingMeasurementItemDetail'
          type: array
        tolerance:
          type: string
        toleranceLower:
          description: Accepted lower limit between the expected measure (standard) and the actual measure
          example: 1
          type:
          - number
          - 'null'
        toleranceUpper:
          description: Accepted upper limit between the expected measure (standard) and the actual measure
          example: 1
          type:
          - number
          - 'null'
        unit:
          enum:
          - inch
          - cm
          - mm
          type: string
      required:
      - caption
      - pom
      - tolerance
      - unit
      type: object
    InspectionRfid:
      properties:
        barcode:
          description: Barcode of the item
          example: '123456'
          type: string
        code:
          description: Code of the item
          example: '123'
          type: string
        decodedCode:
          description: Decoded code of the item
          example: '111'
          type: string
        id:
          description: Unique identifier of the barcode
          example: abc-def-123
          type: string
        inspectionId:
          description: Unique identifier of the report
          example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
          type: string
        matched:
          description: Indicates whether the barcode of the item matches the expected barcode
          example: 'true'
          type: boolean
        organizationId:
          description: Unique identifier of the organization who executed the inspection
          example: '200373'
          type: string
        photos:
          description: List of photos taken
          items:
            type: string
          type: array
      type: object
    BadRequestApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        message:
          example: Bad Request
          type: string
      type: object
    InspectionSpecialAttentionPoint:
      properties:
        attentionId:
          description: Unique identifier of the special attention point
          example: remark-ee79693e-cd81-45df-af2e-1ee4628b4123-2020-01-15-14-25-13-182
          type: string
        description:
          description: Description of the special attention point
          example: This is a test
          type: string
        group:
          description: Unique identifier of the special attention point's group
          example: remark-ee79693e-cd81-45df-af2e-1ee4628b4123-2020-01-15-14-25-13-182
          type: string
        inspectionId:
          description: Unique identifier of the report
          example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
          type: string
        organizationId:
          description: Unique identifier of the organization who executed the inspection
          example: '200373'
          type: string
        pictures:
          description: The list of pictures taken for the special attention point
          items:
            $ref: '#/components/schemas/InspectionSpecialAttentionPointPictures'
          type: array
        type:
          description: The type of special attention point
          example: remark
          type: string
      type: object
    InspectionAssortmentItem:
      properties:
        availableQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        brandId:
          description: 'Precondition: must be configured in your Inspectorio''s account.'
          example: brand_1
          type:
          - string
          - 'null'
        brandName:
          minLength: 1
          readOnly: true
          type: string
        classId:
          example: class_id_1
          type:
          - string
          - 'null'
        color:
          minLength: 1
          type: string
        configuration:
          minimum: 1
          type: integer
        departmentId:
          example: department_id_1
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        itemId:
          minLength: 1
          type: string
        purchaseOrders:
          description: 'List of unique purchase orders associated with this item '
          items:
            type: string
          type:
          - array
          - 'null'
        quantity:
          readOnly: true
          type: integer
        shipmentTerm:
          example: shipment_term_1
          type:
          - string
          - 'null'
        size:
          minLength: 1
          type: string
      required:
      - color
      - configuration
      - itemId
      - size
      type: object
    BookingAssortmentItem:
      properties:
        availableQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        brandId:
          description: 'Precondition: must be configured in your Inspectorio''s account.'
          example: brand_1
          type:
          - string
          - 'null'
        brandName:
          minLength: 1
          readOnly: true
          type: string
        classId:
          example: class_id_1
          type:
          - string
          - 'null'
        color:
          minLength: 1
          type: string
        configuration:
          minimum: 1
          type: integer
        departmentId:
          example: department_id_1
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        itemI

# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/inspectorio/refs/heads/main/openapi/inspectorio-report-api-openapi.yml