Skip to main content

Get Report

GET 

https://sight.inspectorio.com/api/v1/reports/:report_id

Get Report

Request​

Path Parameters

    report_id stringrequired

Responses​

OK

Schema
    data object
    inspectionDefectList object[]

    Defect list of the report

  • Array [
  • assortmentIdstring

    Unique identifier of the assortment carton, e.g. 1234

    Example: 1234
    clarificationstring

    Classification of the defect, e.g. Critical, Major, Minor

    Example: major
    colorstring

    Color of the item

    Example: Blue/Pink
    commentstringnullable

    Comment of the defect

    Example: Comment
    defectCategorystring

    Category of the defect

    Example: Safety and Regulatory
    defectCodestring

    Code of the defect

    Example: SR002
    defectIdstring

    Unique identifier of the defect

    Example: abcd1234-ab12-cd34-ef56-123456789012_workmanship_1
    defectNamestring

    Name of the defect

    Example: PKG005 - Missing silica gel / box sticker / box flag
    defectiveUnitstringnullable

    Defective unit

    Example: Defective unit
    descriptionstring

    Description of the defect

    Example: PKG005 - Missing silica gel / box sticker / box flag
    groupstring

    Group of the defect, e.g. Workmanship

    Example: workmanship
    idstring

    Custom ID of the list

    inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    itemDescriptionstring

    Description of the item

    Example: Box AB1851
    itemIdstring

    Unique identifier of the item

    Example: 02112-1851
    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    photos object[]

    List of photos taken for the defect

  • Array [
  • descriptionstring

    Description of the defect photo

    Example: Mismatch color
    rotateAnglestring

    Angle of rotation of the defect photo

    Example: 0
    sourcestring

    Source of the defect photo

    Example: https://.../image1.jpg
  • ]
  • productCategorystring[]

    List of product categories of the item

    sizestring

    Size of the item

    Example: XXL
    styleIdstring

    Unique identifier of the style of the item

    Example: 123456
    totalDefectsinteger

    Total number of times the defect was found during the inspection

    Example: 1
  • ]
  • inspectionEsignatures object[]nullable

    Information on the eSignature

  • Array [
  • idinteger

    Unique Identifier of the inspection eSignature

    Example: 123456
    namestringnullable

    Name of the inspector who provided eSignature

    Example: Bob
    signaturestring

    Name of the inspector who provided eSignature

    Example: https://example.jpg
    titlestring

    Title of the inspector who provided eSignature

    Example: Factory Representative
  • ]
  • inspectionGeneral object

    General information of the report

    actualInspectionDatedate-timenullable

    Date when the inspection was started on mobile

    Example: 2021-06-03T00:00:00+00:00
    bookingTypestring

    Type of the booking, e.g. Normal

    Example: normal
    capaStatusstring

    Status of the CAPA

    Example: Waiting for Response
    caseNumberstring

    Case number of the report generated based on a configurable rule

    Example: 5832DUPRO2019-00537345TESTMTTestInspectorioFactoryASOLID-ASSORTMENT2019-12-095832IS
    client objectnullable

    Information on the brand/retailer

    addressstring

    Address of the organization

    Example: 5 Madison Avenue
    citystring

    City of the organization

    Example: New York
    contact objectnullable

    Contact information of the organization

    contactIdstring
    Example: contact_id
    emailstring
    Example: email@email.com
    mobileNumberstring
    Example: 1234567890
    namestring
    Example: Contact Name
    telephoneNumberstring
    Example: 1234567890
    countrystring

    Country of the organization

    Example: US
    localOrganizationIdstringnullable

    Local Custom ID of the organization

    Example: 123
    localOrganizationIdsstring[]nullable

    The list of all connected Local Custom IDs of the organization

    Example: ["123","ABC"]
    namestring

    Name of the organization

    Example: Acme Corp
    organizationIdstring

    Unique Identifier of the organization

    Example: 3123123
    countrystring

    Country of shipment

    Example: VN
    createdDatestring

    Date and time when the inspection started

    Example: 2021-06-03 07:18:05.372000+00:00
    creator objectnullable

    Information on the user who generated the report

    emailstring
    idstring
    mobileNumberstring
    namestring
    executor objectnullable

    Information on the executor of the report

    addressstring

    Address of the organization

    Example: 5 Madison Avenue
    citystring

    City of the organization

    Example: New York
    contact objectnullable

    Contact information of the organization

    contactIdstring
    Example: contact_id
    emailstring
    Example: email@email.com
    mobileNumberstring
    Example: 1234567890
    namestring
    Example: Contact Name
    telephoneNumberstring
    Example: 1234567890
    countrystring

    Country of the organization

    Example: US
    namestring

    Name of the organization

    Example: Acme Corp
    organizationIdstring

    Unique Identifier of the organization

    Example: 3123123
    expectedDatestring

    Expected date of inspection that was selected when creating a new inspection

    Example: 2021-06-03 00:00:00+00:00
    factory objectnullable

    Information on the factory of the report

    addressstring

    Address of the organization

    Example: 5 Madison Avenue
    citystring

    City of the organization

    Example: New York
    contact objectnullable

    Contact information of the organization

    contactIdstring
    Example: contact_id
    emailstring
    Example: email@email.com
    mobileNumberstring
    Example: 1234567890
    namestring
    Example: Contact Name
    telephoneNumberstring
    Example: 1234567890
    countrystring

    Country of the organization

    Example: US
    localOrganizationIdstringnullable

    Local Custom ID of the organization

    Example: 123
    localOrganizationIdsstring[]nullable

    The list of all connected Local Custom IDs of the organization

    Example: ["123","ABC"]
    namestring

    Name of the organization

    Example: Acme Corp
    organizationIdstring

    Unique Identifier of the organization

    Example: 3123123
    inspectionDatestring

    Date and time when the inspection completed

    Example: 2021-06-03 08:27:20.624000+00:00
    inspectionIdstring

    Unique identifier of the inspection's report

    Example: 123a456b-abcd-efgh-ijk1-a88aa05d7c86
    inspectionLocation objectnullable

    The location of the inspection

    addressstring

    Address of the organization

    Example: 5 Madison Avenue
    citystring

    City of the organization

    Example: New York
    contact objectnullable

    Contact information of the organization

    contactIdstring
    Example: contact_id
    emailstring
    Example: email@email.com
    mobileNumberstring
    Example: 1234567890
    namestring
    Example: Contact Name
    telephoneNumberstring
    Example: 1234567890
    countrystring

    Country of the organization

    Example: US
    localOrganizationIdstringnullable

    Local Custom ID of the organization

    Example: 123
    localOrganizationIdsstring[]nullable

    The list of all connected Local Custom IDs of the organization

    Example: ["123","ABC"]
    namestring

    Name of the organization

    Example: Acme Corp
    organizationIdstring

    Unique Identifier of the organization

    Example: 3123123
    inspectionResultstring

    Overall result of the inspection

    Example: fail
    inspector objectnullable

    Information on the inspector

    emailstring
    employeeIdstring
    idstring
    mobileNumberstring
    namestring
    isReferenceSampleinteger

    Indicates whether a reference sample had been provided

    Example: null
    opoNumberstring

    Original PO Number of the report

    Example: 123-456
    oversightOffice objectnullable

    Oversight office

    idstringnullable

    Oversight office id

    Example: 111
    namestringnullable

    Oversight office name

    Example: Acme Oversight Office
    pdfUrlstring

    Direct URL to the report in PDF format

    Example: https://.../.../.../.../case-number_123a456b-abcd-efgh-ijk1-a88aa05d7c86.pdf
    photosstring[]nullable

    List of direct URLs to the photos taken during the inspection

    poNumberstring

    PO Number of the report

    Example: 123-456-L001
    pos object[]nullable

    List of all the PO numbers

  • Array [
  • poNumberstring

    PO Number of the report

    Example: PO123
  • ]
  • productCategoriesstring[]nullable

    List of unique identifiers of all the product categories

    productLineIdstring

    Unique identifier of the product line

    Example: 100991
    productLineNamestring

    Name of the product line

    Example: APPAREL
    productOrdersstring[]nullable

    List of all the PO numbers

    productStyles object[]nullable

    List of all the styles with items and measurements

  • Array [
  • assortments object[]nullable
  • Array [
  • assortmentIdstringrequired

    Possible values: non-empty

    availableCartonQuantityintegernullable
    cartonQuantityintegerrequired

    Possible values: >= 0

    items object[]required

    Possible values: >= 1

  • Array [
  • availableQuantityintegernullable
    brandIdstringnullable

    Precondition: must be configured in your Inspectorio's account.

    Example: brand_1
    brandNamestring

    Possible values: non-empty

    classIdstringnullable
    Example: class_id_1
    colorstringrequired

    Possible values: non-empty

    configurationintegerrequired

    Possible values: >= 1

    departmentIdstringnullable
    Example: department_id_1
    idstringnullable
    itemIdstringrequired

    Possible values: non-empty

    purchaseOrdersstring[]nullable

    List of unique purchase orders associated with this item

    quantityinteger
    shipmentTermstringnullable
    Example: shipment_term_1
    sizestringrequired

    Possible values: non-empty

  • ]
  • ]
  • measurements object[]
  • Array [
  • captionstringrequired

    Possible values: non-empty

    isPomCriticalbooleannullable

    Measurement is critical or not

    Example: true
    pomstringrequired

    Possible values: non-empty

    sizes object[]
  • Array [
  • measurementstringrequired
    sizestringrequired

    Size name

    Possible values: non-empty

    Example: Medium
  • ]
  • tolerancestringrequired
    toleranceLowernumbernullable

    Accepted lower limit between the expected measure (standard) and the actual measure

    Example: 1
    toleranceUppernumbernullable

    Accepted upper limit between the expected measure (standard) and the actual measure

    Example: 1
    unitstringrequired

    Possible values: [inch, cm, mm]

  • ]
  • productCategoryIdstringrequired
    Example: product_category_1
    productCategoryNamestring

    Possible values: non-empty

    solids object[]nullable
  • Array [
  • availableCartonQuantityintegernullable
    availableQuantityintegernullable
    brandIdstringnullable

    Precondition: must be configured in your Inspectorio's account.

    Example: brand_1
    brandNamestring

    Possible values: non-empty

    cartonQuantityintegernullable

    Possible values: >= 0

    casePackQuantityintegernullable

    Possible values: >= 0

    classIdstringnullable
    Example: class_id_1
    colorstringrequired

    Possible values: non-empty

    departmentIdstringnullable
    Example: department_id_1
    idstringnullable
    itemIdstringrequired

    Possible values: non-empty

    purchaseOrdersstring[]nullable

    List of unique purchase orders associated with this item

    quantityintegerrequired

    Possible values: >= 1

    shipmentTermstringnullable
    Example: shipment_term_1
    sizestringrequired

    Possible values: non-empty

  • ]
  • styleIdstringrequired

    Possible values: non-empty

    Example: style_1
    styleNamestringnullable
  • ]
  • statusstring

    Status of the report, e.g. In-Progress, Completed

    Example: completed
    systemUpdatedAtstring

    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
    tagsstring[]nullable

    Labels attached to the report giving other information, e.g. 1st re-inspection

    Example: null
    type objectnullable

    Information on the type of inspection

    typeOfInspectionstring
    Example: FRI
    typeOfInspectionNamestring
    Example: Final Random Inspection
    updatedDatestring

    Date and time the report was last updated

    Example: 2021-06-03 08:27:21.316000+00:00
    vendor objectnullable

    Information on the supplier of the report

    addressstring

    Address of the organization

    Example: 5 Madison Avenue
    citystring

    City of the organization

    Example: New York
    contact objectnullable

    Contact information of the organization

    contactIdstring
    Example: contact_id
    emailstring
    Example: email@email.com
    mobileNumberstring
    Example: 1234567890
    namestring
    Example: Contact Name
    telephoneNumberstring
    Example: 1234567890
    countrystring

    Country of the organization

    Example: US
    localOrganizationIdstringnullable

    Local Custom ID of the organization

    Example: 123
    localOrganizationIdsstring[]nullable

    The list of all connected Local Custom IDs of the organization

    Example: ["123","ABC"]
    namestring

    Name of the organization

    Example: Acme Corp
    organizationIdstring

    Unique Identifier of the organization

    Example: 3123123
    workflowNamestringnullable

    Name of workflow

    Example: DUPRO Apparel workflow
    inspectionMeasurementDimensions object[]

    Measurement dimensions

  • Array [
  • colorstring

    Color of the item

    Example: Blue/Pink
    dimensionIdstring

    Unique identifier of the dimension

    Example: 1a2b3c4d-1a2b-c1d2-b3b2-b76cd21e2a34__00537345__029-02-0590__XL__Blue/Pink__9999__0
    dimensionIndexinteger

    Index of the dimension

    Example: 0
    idstring

    Unique identifier of the item

    Example: 029-02-0590
    inspectionIdstring

    Unique identifier of the report

    Example: 1a2b3c4d-1a2b-c1d2-b3b2-b76cd21e2a34
    itemIdstring

    Unique identifier of the item

    Example: 029-02-0590
    measurementDescriptionstring

    Description of the measurement

    Example: 9999
    occurrencesinteger

    Number of occurrences

    Example: 1
    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    samples object[]
  • Array [
  • namestring

    Sample name of the inspection measurement dimension

    Example: shirt_1
    valuenumbernullable

    sample value

    Example: 1.5
  • ]
  • sizestring

    Size of the item

    Example: XXL
    skuIndexinteger

    Index of the SKU

    Example: 0
    standardnumber

    Expected measure

    Example: 10.5
    styleIdstring

    Unique identifier of the style of the item

    Example: 123456
    tolerancenumbernullable

    Accepted gap between the expected measure (standard) and the actual measure

    Example: 2.1
    toleranceLowernumbernullable

    Accepted lower limit between the expected measure (standard) and the actual measure

    Example: 2.1
    toleranceUppernumbernullable

    Accepted upper limit between the expected measure (standard) and the actual measure

    Example: 2.1
    unitstring

    Unit of the measure, e.g. cm, mm, inch

    Example: cm
  • ]
  • inspectionPhotos object[]

    List of photos taken during the inspection

  • Array [
  • file object

    List of the files

    descriptionstring

    Description of the photo, if any

    Example: photo_1
    fileTypestring

    Type of the file

    Example: image
    rotateAnglestring

    Angle of rotation of the photo

    Example: 0
    sourcestring

    Direct URL to the photo

    Example: https://.../.../.../1a2b3c4d-1a2b-1a2b-1a2b3c4d_eb77a158.jpg
    groupIdstring

    Unique identifier of the group of photo

    inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    itemIdstring

    Unique identifier of the item

    Example: 02112-1851
    labelstring

    Label of the photo

    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    photoIdstring

    Unique identifier of the photo

    statusstring

    Status of the photo

    styleIdstring

    Unique identifier of the style

    Example: 123456
    typestring

    Type of the photo

    Example: image
  • ]
  • inspectionQuestions object[]

    List of questions followed by the inspector

  • Array [
  • groupIdstring

    Unique identifier of the group of question

    Example: 7384b63c-bc99-43f0-b1b5-600959220e19_1e601f70-3c65-4ea8-931f-4976b9c91b3a
    inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    labelstring

    Label of the question

    Example: Do we need to pull a Green sealed sample?
    options object[]

    Options available to answer the question

  • Array [
  • actions object[]

    List of actions per question

  • Array [
  • actionstring

    Action the inspector can/needs to take when responding to the question

    Example: request_picture
    value

    Information related to the action of the question, e.g. Is Mandatory

    Example: mandatory
  • ]
  • failResponseboolean

    Boolean indicating whether the option, if selected, will make the overall inspection result fail

    Example: false
    idstring

    Unique identifier of the option

    Example: chk__97
    selectedboolean

    Boolean indicating whether the option has been selected

    Example: true
    valuestring

    Label of the option displayed to the user

    Example: YES
  • ]
  • organizationIdstring

    Unique identifier of the organization

    Example: null
    questionIdstring

    Unique identifier of the question

    Example: 7384b63c-bc99-43f0-b1b5-600959220e19_5689d212-b001-4ad2-89c7-2c39654d4cc3_SyJivf3CA
    typestring

    Type of the question

    Example: null
  • ]
  • inspectionRFID object[]

    Result of the RFID step taken during the inspection

  • Array [
  • barcodestring

    Barcode of the item

    Example: 123456
    codestring

    Code of the item

    Example: 123
    decodedCodestring

    Decoded code of the item

    Example: 111
    idstring

    Unique identifier of the barcode

    Example: abc-def-123
    inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    matchedboolean

    Indicates whether the barcode of the item matches the expected barcode

    Example: true
    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    photosstring[]

    List of photos taken

  • ]
  • inspectionResult object[]

    Result of each section of the report

  • Array [
  • groupNamestring

    Name of the group of results

    Example: Check In
    includeInReportboolean

    Boolean indicating if the result is included in the report

    Example: true
    inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    resultIdstring

    Unique identifier of the result

    Example: 7384b63c-bc99-43f0-b1b5-600959220e19_6e451830-1d61-4a14-a5e7-03ce20704f52
    statusstring

    Status of the result

    Example: non-applicable
  • ]
  • inspectionSampleSelection object[]

    Details of the sample selection calculation

  • Array [
  • inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    sampleSelectioninteger

    Sample selection

    Example: 13
    sampleSizeinteger

    Sample size

    Example: 13
    totalInspectionQuantityinteger

    Total inspection quantity

    Example: 72
  • ]
  • inspectionSampleSelectionSamples object[]

    Details of the samples selected by the inspector

  • Array [
  • assortmentstring

    Packing type, e.g. Solid, Assortment

    Example: solid
    assortmentQuantitystring

    Assortment available quantity

    Example: 50
    cartonPullinteger

    Number of cartons pulled during the inspection

    Example: 3
    idstring

    Custom ID of the list

    Example: 111
    inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    itemIdstring

    Unique identifier of the item

    Example: 02112-1851
    itemOrderQuantityinteger

    Order quantity of the item

    Example: 50
    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    sampleIdstring

    Unique identifier of the sample

    Example: 00537345__solid__02112-1851
    samplePullinteger

    Number of samples pulled for the item

    Example: 9
    styleIdstring

    Unique identifier of the style of the item

    Example: 123456
    styleOrderQuantityinteger

    Order quantity of the style

    Example: 72
  • ]
  • inspectionSpecialAttentionPoint object[]

    List of special attention points raised by the inspector

  • Array [
  • attentionIdstring

    Unique identifier of the special attention point

    Example: remark-ee79693e-cd81-45df-af2e-1ee4628b4123-2020-01-15-14-25-13-182
    descriptionstring

    Description of the special attention point

    Example: This is a test
    groupstring

    Unique identifier of the special attention point's group

    Example: remark-ee79693e-cd81-45df-af2e-1ee4628b4123-2020-01-15-14-25-13-182
    inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    pictures object[]

    The list of pictures taken for the special attention point

  • Array [
  • rotateAnglestring

    Angle of rotation of the picture

    Example: 0
    sourcestring

    Direct URL to the picture

    Example: https://.../image1.jpg
  • ]
  • typestring

    The type of special attention point

    Example: remark
  • ]
  • inspectionStandards object[]

    Information on the inspection standards followed by the inspector

  • Array [
  • aql object

    Information on the AQL table

    aqlIdstring

    Unique identifier of the AQL table

    Example: 31ade06c-1a0b-11e9-83b2-320fe256275a
    aqlLevelstringnullable

    Inspection level

    Example: ii
    aqlNamestring

    The name of the AQL table

    Example: Packaging
    criticalstring

    The threshold used for critical defects

    Example: 0.010
    majorstring

    The threshold used for major defects

    Example: 2.5
    minorstring

    The threshold used for minor defects

    Example: 2.5
    sourcestring

    The source of the AQL table

    Example: null
    availableQuantityinteger

    Total of available quantity to inspect

    Example: 72
    countedForAql objectnullable

    Number of defects found that counted for AQL per classification

    criticalstring

    The number of critical defects that counted for AQL

    Example: 1
    majorstring

    The number of major defects that counted for AQL

    Example: 0
    minorstring

    The number of minor defects that counted for AQL

    Example: 0
    defectFound object

    Number of defects found per classification, e.g. 0 Minor, 2 Major, 0 Critical

    criticalstring

    The number of critical defects found

    Example: 1
    majorstring

    The number of major defects found

    Example: 0
    minorstring

    The number of minor defects found

    Example: 0
    defectiveUnitActivatebooleannullable

    Boolean indicating whether defective unit was activated

    Example: false
    determineDescstring

    Determine Desc

    Example: AQL Standard
    determineTypestring

    Determine Type

    Example: aqlTable
    determineValueinteger

    Determine Value

    Example: 0
    doubleSamplingboolean

    Boolean indicating whether double sampling was activated

    Example: false
    failReasonstring

    Reason for the failure

    Example: critical
    groupstring

    Group of the defect, e.g. Workmanship, Packaging

    Example: workmanship
    inspectionIdstring

    Unique identifier of the report

    Example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
    maxAllowed object

    List of maximum allowed defect per classification, e.g. 0 Minor, 1 Major, 0 Critical

    criticalstring

    The number of critical defects max allowed

    Example: 0
    majorstring

    The number of major defects max allowed

    Example: 1
    minorstring

    The number of minor defects max allowed

    Example: 1
    maximumSampleSizeinteger

    Maximum sample size

    Example: 8
    minimumSampleSizeinteger

    Minimum sample size

    Example: 13
    noOfDefectiveItemsinteger

    Number of defective items

    Example: 1
    noOfDefectiveUnitsinteger

    Number of defective units

    Example: 2
    organizationIdstring

    Unique identifier of the organization who executed the inspection

    Example: 200373
    packingTypestring

    List of all packing types

    Example: Solid; Assortment
    sampleSizeCategory object[]

    Information on the sample size category

  • Array [
  • productCategorystring

    Unique identifier of the product category

    Example: 124301
    sampleSizeinteger

    Sample size

    Example: 8
  • ]
  • totalDefectsstring

    Total defects found

    Example: 2
    totalItemsinteger

    Total items

    Example: 2
  • ]
  • itemAttributes object[]nullable

    List of item attribute

  • Array [
  • codestringnullable

    Code of item attribute

    Example: GC Apparel
    items object[]nullable

    List of item

  • Array [
  • groupCodestringnullable

    Group code

    itemIdstringnullable

    Item id

    styleIdstringnullable

    Style id

  • ]
  • namestringnullable

    Name of item attribute

    Example: Group Code Apparel
    typestringnullable

    Type of item attribute

    Example: single_choice
  • ]

Authorization: apiKey

name: apiKeytype: apiKeyin: header
curl -L 'https://sight.inspectorio.com/api/v1/reports/:report_id' \
-H 'Accept: application/json' \
-H 'apiKey: <apiKey>'
Request Collapse all
Base URL
https://sight.inspectorio.com
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!