Skip to main content

CapaCqpProduct

One inspected Style / Item and its failed Inline CQPs

cqpFormIdstringnullable

Business ID of the CQP form the CQPs were captured against (cqpFormId of the CQP Integration API)

Example: cqpform-2024-001
cqps object[]

Failed Inline CQPs of this Style / Item, in capture order

  • Array [
  • addedOnSiteboolean

    true when the inspector added the CQP during the inspection instead of inheriting it

    Example: false
    attachments object[]

    Self-assessment attachments

  • Array [
  • idstring<uuid>required

    Regenerated when the aggregate is replaced with PUT.

    fileUrlstring<uri>

    Possible values: <= 500 characters

    fileNamestring

    Possible values: <= 255 characters

    fileContentTypestring

    Possible values: <= 200 characters

    createdAtstring<date-time>required
    updatedAtstring<date-time>required
  • ]
  • commentstringnullable

    Supplier self-assessment note

    Example: Pull test passed on pre-production samples.
    comments object[]

    Comments on the CQP in the CAPA

  • Array [
  • attachments object[]

    List of attachments on the comment

  • Array [
  • fileNamestringnullable

    File name of the attachment

    Example: photo.jpg
    fileUrlstringnullable

    URL of the attachment

    Example: https://.../file.jpg
  • ]
  • createdDatestring<date-time>nullable

    Date the comment was created

    Example: 2021-05-25T13:58:26+00:00
    emailstringnullable

    Email of the user who posted the comment

    firstNamestringnullable

    First name of the user who posted the comment

    Example: John
    lastNamestringnullable

    Last name of the user who posted the comment

    Example: Doe
    messagestringnullable

    Comment message

    organizationNamestringnullable

    Organization of the user who posted the comment

    Example: Acme Corp
  • ]
  • correctiveAction object

    Corrective action recorded in the CAPA

    detailsstringnullable

    Details on the corrective action

    Example: Rework on the defective units
    valuestringnullable

    An action in the corrective list

    Example: Rework Units
    cqcsstring[]

    Names of the linked CQCs (CQP groups), as the CQP Integration API returns them

    Example: ["Trims"]
    cqpTypeCQPType

    CQP type

    Possible values: [safety, functional, regulation]

    descriptionstringnullable

    CQP description

    Example: Zipper pull must withstand 70 N pull test.
    executionResult objectnullable

    Inspector result captured during inspection execution; null until the result is uploaded

    attachments object[]

    Inspector evidence (photos, videos)

  • Array [
  • fileContentTypestringnullable

    MIME type of the file

    Example: image/jpeg
    fileNamestringnullable

    File name

    Example: evidence-1.jpg
    fileUrlstring<uri>

    URL of the file

    Example: https://.../evidence-1.jpg
    mediaTypestringnullable

    Kind of evidence

    Possible values: [photo, video]

    Example: photo
  • ]
  • capturedAtstring<date-time>nullable

    When the result was captured

    Example: 2026-09-24T03:00:00+00:00
    commentstringnullable

    Inspector comment

    Example: Zipper pull detached on 2 of 8 samples.
    inspectionTypestringnullable

    Inspection type code of the inspection the result was captured on

    Example: INLINE
    naReasonstringnullable

    Reason given when the outcome is na; null otherwise

    outcomeCqpOutcome

    Recorded outcome

    Possible values: [pass, fail, customer_requirement_fail, na]

    idstring<uuid>

    Identifier of this CQP entry on the inspection; the key the corrective actions and comments are attached to

    Example: 11aa2bb3-4cc5-4dd6-8ee7-9ff0a1b2c3d4
    mitigations object[]

    Mitigations as captured on the inspection

  • Array [
  • idstring<uuid>required

    Regenerated when the aggregate is replaced with PUT.

    controlLayerTypeControlLayerType

    Possible values: [product_spec, material, production_process]

    productionStepProductionStep

    Possible values: [material_preparation, cutting, forming_molding, printing_dyeing, sewing, assembly, surface_finishing, washing, finishing, labeling, packing, other]

    specificationstring
    productionControlCheckstring
    qualityControlCheckstring
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
  • ]
  • namestringnullable

    CQP name as captured on the inspection

    Example: Zipper pull strength
    preventativeActionstringnullable

    Preventive action recorded in the CAPA

    Example: Add calibration to the shift checklist.
    previousStageResult objectnullable

    The PPM stage this CQP was inherited from; null when it was not inherited or the PPM inspection is not visible to the caller

    inspectionDatestring<date-time>nullable

    Date the PPM inspection was uploaded

    Example: 2026-08-20T00:00:00+00:00
    inspectionIdstring<uuid>

    Identifier of the PPM inspection (usable with the report endpoints)

    Example: c04a5b6c-7d8e-4f9a-8b0c-1d2e3f4a5b6c
    inspectionTypestringnullable

    Inspection type code of the PPM inspection

    Example: PPM
    outcomestringnullable

    Outcome recorded on the PPM entry, if any; the values of CqpOutcome. PPM rows normally carry a review status, not an outcome, so this is usually null

    Possible values: [pass, fail, customer_requirement_fail, na, null]

    statusCQPStatus

    Review status of the PPM entry

    Possible values: [pending, reviewed]

    reviewNote objectnullable

    Brand / retailer review note recorded on the CQP

    attachments object[]

    Review note attachments

  • Array [
  • idstring<uuid>required

    Regenerated when the aggregate is replaced with PUT.

    fileUrlstring<uri>

    Possible values: <= 500 characters

    fileNamestring

    Possible values: <= 255 characters

    fileContentTypestring

    Possible values: <= 200 characters

    createdAtstring<date-time>required
    updatedAtstring<date-time>required
  • ]
  • commentstringnullable

    Review note text

    Example: Reviewed at PPM, mitigation accepted.
    rootCausestringnullable

    Root cause recorded in the CAPA

    Example: Bar-tack machine out of calibration.
    sourceCqpIdstring<uuid>nullable

    Identifier of the Style / Item library CQP this entry was created from (id of the CQP Integration API); null for a CQP added on site

    Example: 00ff1ee2-3dd4-4cc5-9bb6-7aa8f9e0d1c2
    sourceSnapshotIdstring<uuid>nullable

    Identifier of the PPM CQP entry this entry was inherited from; null when it was not inherited

    Example: b31d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f
    statusCQPStatus

    Review status of the CQP entry

    Possible values: [pending, reviewed]

    verifications object[]

    Verifications as captured on the inspection

  • Array [
  • idstring<uuid>required

    Regenerated when the aggregate is replaced with PUT.

    stageTypeVerificationStage

    Possible values: [pre_production, during_production, post_production]

    methodTypeVerificationMethod

    Possible values: [certified_lab_test, process_verification_checklist, inspection]

    inspectionTypesstring[]

    Possible values: <= 50 characters

    acceptanceCriteriastring
    assignedToVerificationAssignedTo

    Possible values: [third_party, brand_retailer, supplier_factory]

    createdAtstring<date-time>required
    updatedAtstring<date-time>required
  • ]
  • ]
  • customIdstringnullable

    Custom ID of the Style / Item in the client's system, the custom_id used by the CQP Integration API

    Example: KM-STYLE-001
    entityTypestring

    Type of the inspected entity, in the vocabulary of the CQP Integration API (product = Style)

    Possible values: [product, item]

    Example: product
    namestringnullable

    Name of the Style / Item

    Example: Men's zip hoodie
    totalFailedinteger

    Number of failed Inline CQPs on this Style / Item

    Example: 1
    CapaCqpProduct
    {
    "cqpFormId": "cqpform-2024-001",
    "cqps": [
    {
    "addedOnSite": false,
    "attachments": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fileUrl": "string",
    "fileName": "string",
    "fileContentType": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "comment": "Pull test passed on pre-production samples.",
    "comments": [
    {
    "attachments": [
    {
    "fileName": "photo.jpg",
    "fileUrl": "https://.../file.jpg"
    }
    ],
    "createdDate": "2021-05-25T13:58:26+00:00",
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "message": "string",
    "organizationName": "Acme Corp"
    }
    ],
    "correctiveAction": {
    "details": "Rework on the defective units",
    "value": "Rework Units"
    },
    "cqcs": [
    "Trims"
    ],
    "cqpType": "safety",
    "description": "Zipper pull must withstand 70 N pull test.",
    "executionResult": {
    "attachments": [
    {
    "fileContentType": "image/jpeg",
    "fileName": "evidence-1.jpg",
    "fileUrl": "https://.../evidence-1.jpg",
    "mediaType": "photo"
    }
    ],
    "capturedAt": "2026-09-24T03:00:00+00:00",
    "comment": "Zipper pull detached on 2 of 8 samples.",
    "inspectionType": "INLINE",
    "naReason": "string",
    "outcome": "pass"
    },
    "id": "11aa2bb3-4cc5-4dd6-8ee7-9ff0a1b2c3d4",
    "mitigations": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "controlLayerType": "product_spec",
    "productionStep": "material_preparation",
    "specification": "string",
    "productionControlCheck": "string",
    "qualityControlCheck": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "name": "Zipper pull strength",
    "preventativeAction": "Add calibration to the shift checklist.",
    "previousStageResult": {
    "inspectionDate": "2026-08-20T00:00:00+00:00",
    "inspectionId": "c04a5b6c-7d8e-4f9a-8b0c-1d2e3f4a5b6c",
    "inspectionType": "PPM",
    "outcome": "pass",
    "status": "pending"
    },
    "reviewNote": {
    "attachments": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fileUrl": "string",
    "fileName": "string",
    "fileContentType": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "comment": "Reviewed at PPM, mitigation accepted."
    },
    "rootCause": "Bar-tack machine out of calibration.",
    "sourceCqpId": "00ff1ee2-3dd4-4cc5-9bb6-7aa8f9e0d1c2",
    "sourceSnapshotId": "b31d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
    "status": "pending",
    "verifications": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "stageType": "pre_production",
    "methodType": "certified_lab_test",
    "inspectionTypes": [
    "string"
    ],
    "acceptanceCriteria": "string",
    "assignedTo": "third_party",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ]
    }
    ],
    "customId": "KM-STYLE-001",
    "entityType": "product",
    "name": "Men's zip hoodie",
    "totalFailed": 1
    }