Get CAPA
GET/api/v1/capas/:report_id
Get CAPA
Request​
Path Parameters
Responses​
- 200
- 400
- 401
- 422
- 429
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Array [
]
Array [
]
Array [
Array [
Array [
]
]
Array [
Array [
]
]
]
Array [
Array [
]
Array [
Array [
]
]
]
Array [
Array [
]
]
Array [
]
Array [
Array [
Array [
]
]
Array [
Array [
]
]
]
Array [
Array [
]
]
Array [
Array [
Array [
]
]
]
Array [
Array [
Array [
]
]
Array [
Array [
]
]
]
Array [
Array [
]
Array [
Array [
]
]
]
Array [
Array [
Array [
]
]
]
Array [
Array [
Array [
]
]
Array [
Array [
]
]
]
data
object
chatBox
object[]
Chatbox
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
generalInformation
object
General information on CAPA
Actual inspection date
List of assortment IDs
Available quantity of items of purchase orders
CAPA status of the report
Custom ID of the factory in the inspection
Name of the factory in the inspection
Unique identifier of the inspection
inspectionLocation
object
nullable
Location where the inspection took place
Address of the inspected organization
contact
object
Contact information of the organization
Unique identifier of the organization contact
Email address of the organization contact
Mobile number of the organization contact
Name of the organization contact
Telephone number of the organization contact
Country of the inspected organization in 2 characters ISO format
Unique identifier of the inspected organization
Inspection result
Inspection type
Inspector name
List of item IDs
Order quantity of items of purchase orders
List of packing types
productCategories
object[]
nullable
list of product categories
Unique identifier of the product category or product line
Name of the product category or product line
productLines
object[]
nullable
List of product lines
Unique identifier of the product category or product line
Name of the product category or product line
Proposed inspection date
List of style IDs
Custom ID of the supplier in the inspection
Name of the supplier in the inspection
nonConformities
object
Non-Conformity
assembly
object
Assembly section
aql
object
AQL information
AQL ID
Number of Critical defects
Number of Major defects
Number of Minor defects
defectFound
object
Information on the number of defects
Number of Critical defects
Number of Major defects
Number of Minor defects
defects
object[]
Defect details
Affected percentage by the defect
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
Defect category
Defect code
defectItems
object[]
List of defective items
attachments
object[]
List of attachments of defective items
URL of attachments for the CAPA report
Classification of the defective item
Color of the defective item
Custom ID of the defective item
ID of the defective item
Size of the defective item
Style ID of the defective item
Defect name
Preventative action
Root cause of the defect
Total defect items
Total defect units
maxAllowed
object
Maximum number of defect allowed
Number of Critical defects
Number of Major defects
Number of Minor defects
Total number of defects
Total number of defective items
checkList
object[]
Checklist section
attachments
object[]
List of attachments in the questionnaire
URL of attachments for the CAPA report
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
Label of question
Preventative action
Root cause of the defect
measurement
object
Measurement section
aql
object
AQL information
AQL ID
Number of Critical defects
Number of Major defects
Number of Minor defects
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
defectFound
object
Information on the number of defects
Number of Critical defects
Number of Major defects
Number of Minor defects
failedMeasurements
object[]
Failed measurements information
Number of failed measurement found
Measurement Description
Number of occurrences
Standard measurement
Tolerance Lower & Upper of a point of measurement, only use this attribute if your organization has not enabled Unequal Tolerance
Tolerance lower of a point of measurement
Tolerance upper of a point of measurement
maxAllowed
object
Maximum number of defect allowed
Number of Critical defects
Number of Major defects
Number of Minor defects
Preventative action
Root cause of the defect
measurementByDefects
object
Measurement by Defects section
aql
object
AQL information
AQL ID
Number of Critical defects
Number of Major defects
Number of Minor defects
defectFound
object
Information on the number of defects
Number of Critical defects
Number of Major defects
Number of Minor defects
defects
object[]
Defect details
Affected percentage by the defect
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
Defect category
Defect code
defectItems
object[]
List of defective items
attachments
object[]
List of attachments of defective items
URL of attachments for the CAPA report
Classification of the defective item
Color of the defective item
Custom ID of the defective item
ID of the defective item
Size of the defective item
Style ID of the defective item
Defect name
Preventative action
Root cause of the defect
Total defect items
Total defect units
maxAllowed
object
Maximum number of defect allowed
Number of Critical defects
Number of Major defects
Number of Minor defects
Total number of defects
Total number of defective items
moistureCheck
object
Moisture Check section
aql
object
AQL information
AQL ID
Number of Critical defects
Number of Major defects
Number of Minor defects
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
defectFound
object
Information on the number of defects
Number of Critical defects
Number of Major defects
Number of Minor defects
defectItems
object[]
List of defective items that failed the moisture check
components
object[]
Components of items that failed the moisture check
acceptableTolerances
object[]
Acceptable Tolerance information
The bottom range of the acceptable tolerance
The top range of the acceptable tolerance
Unit of the acceptable tolerance in cm,mm,inch
Defect Classification
Name of the component
outOfTolerance
object
Out of Tolerance information
value of the out of acceptable tolerance
ID of the item that failed the moisture check
Type of the defective item
maxAllowed
object
Maximum number of defect allowed
Number of Critical defects
Number of Major defects
Number of Minor defects
Preventative action
Root cause of the defect
Total number of defects
Total number of defective items
packaging
object
Packaging section
aql
object
AQL information
AQL ID
Number of Critical defects
Number of Major defects
Number of Minor defects
defectFound
object
Information on the number of defects
Number of Critical defects
Number of Major defects
Number of Minor defects
defects
object[]
Defect details
Affected percentage by the defect
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
Defect category
Defect code
defectItems
object[]
List of defective items
attachments
object[]
List of attachments of defective items
URL of attachments for the CAPA report
Classification of the defective item
Color of the defective item
Custom ID of the defective item
ID of the defective item
Size of the defective item
Style ID of the defective item
Defect name
Preventative action
Root cause of the defect
Total defect items
Total defect units
maxAllowed
object
Maximum number of defect allowed
Number of Critical defects
Number of Major defects
Number of Minor defects
Packing type
Total number of defects
Total number of defective items
questions
object[]
Questions
Answer of a question in the questionnaire
attachments
object[]
List of attachments in the questionnaire
URL of attachments for the CAPA report
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
Label of question
Preventative action
Root cause of the defect
rfid
object[]
RFID section
Barcode
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
Decrypted Code
Indicate if the code is matched
List of photos
Preventative action
RFID
Root cause of the defect
workmanship
object
Workmanship section
aql
object
AQL information
AQL ID
Number of Critical defects
Number of Major defects
Number of Minor defects
defectFound
object
Information on the number of defects
Number of Critical defects
Number of Major defects
Number of Minor defects
defects
object[]
Defect details
Affected percentage by the defect
comments
object[]
Comment on the actions
attachments
object[]
Attachments in Chatbox
File Name of the attachment in Chatbox
URL of attachments for the CAPA report
Creation date of the message in Chatbox
Email of the contact who posted the message in Chatbox
First Name of the contact who posted the message in Chatbox
Last Name of the contact who posted the message in Chatbox
Message in Chatbox
Organization of the contact who posted the message in Chatbox
correctiveAction
object
Information on the corrective action
Details on the corrective action
An action in the corrective list
Defect category
Defect code
defectItems
object[]
List of defective items
attachments
object[]
List of attachments of defective items
URL of attachments for the CAPA report
Classification of the defective item
Color of the defective item
Custom ID of the defective item
ID of the defective item
Size of the defective item
Style ID of the defective item
Defect name
Preventative action
Root cause of the defect
Total defect items
Total defect units
maxAllowed
object
Maximum number of defect allowed
Number of Critical defects
Number of Major defects
Number of Minor defects
Total number of defects
Total number of defective items
reInspectionDetail
object
Re-inspection details
Comment on the re-inspection
Inspection Type of the re-inspection
Booking ID of the re-inspection
Re-inspection date
shipmentWindow
object
Shipment window
The first date of the shipment window
The last date of the shipment window
Note on the shipment window
{
"data": {
"chatBox": [
{
"attachments": "file1",
"createdDate": "2021-05-25T13:58:26+00:00",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"message": "Please update the status",
"organizationName": "Acme Corp"
}
],
"generalInformation": {
"actualInspectionDate": "2021-05-07T00:00:00+00:00",
"assortmentIds": "A123",
"availableQuantity": "200",
"capaStatus": "Approved",
"factoryId": "F0123",
"factoryName": "Acme Factory",
"inspectionId": "1234902f-5ab4-4f4e-8422-794109d951b4",
"inspectionLocation": {
"address": "1 Madison Avenue",
"contact": {
"contactId": "1122",
"email": "[email protected]",
"mobileNumber": "1234567890",
"name": "John Doe",
"telephoneNumber": "1234567890"
},
"country": "US",
"name": "Acme Corp",
"organizationId": "F000123"
},
"inspectionResult": "pass",
"inspectionType": "TPR",
"inspectorName": "John Doe",
"itemIds": "111-22-123456",
"orderQuantity": "200",
"packingTypes": "Solid",
"productCategories": [
{
"id": "C123",
"name": "Menswear"
}
],
"productLines": [
{
"id": "C123",
"name": "Menswear"
}
],
"proposedInspectionDate": "2021-05-07T00:00:00+00:00",
"styleIds": "S123",
"supplierId": "S0246",
"supplierName": "Padme Supplier"
},
"nonConformities": {
"assembly": {
"aql": {
"aqlId": "123",
"critical": 0,
"major": 1,
"minor": 2
},
"defectFound": {
"critical": 0,
"major": 1,
"minor": 2
},
"defects": [
{
"affectedPercentage": 1,
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"defectCategory": "Construction",
"defectCode": "CON111",
"defectItems": [
{
"attachments": [
{
"url": "https://.../image1.jpg"
}
],
"classification": "Minor",
"color": "black",
"customId": "ITEM123",
"itemId": "111-22-333",
"size": "Medium",
"styleId": "style_1"
}
],
"defectName": "Construction defect",
"preventativeAction": "Advise all staff",
"rootCause": "Wrong carton dimension",
"totalDefectItems": 1,
"totalDefectUnits": 1
}
],
"maxAllowed": {
"critical": 0,
"major": 1,
"minor": 2
},
"totalDefects": 2,
"totalItems": 2
},
"checkList": [
{
"attachments": [
{
"url": "https://.../image1.jpg"
}
],
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"label": "General",
"preventativeAction": "Advise all staff",
"rootCause": "Wrong carton dimension"
}
],
"measurement": {
"aql": {
"aqlId": "123",
"critical": 0,
"major": 1,
"minor": 2
},
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"defectFound": {
"critical": 0,
"major": 1,
"minor": 2
},
"failedMeasurements": [
{
"found": 2,
"measurementDescription": "Chest",
"occurrence": 2,
"sampleName": "tanktop_1",
"standard": 20,
"tolerance": 0.5,
"toleranceLower": 0.5,
"toleranceUpper": 0.5
}
],
"maxAllowed": {
"critical": 0,
"major": 1,
"minor": 2
},
"preventativeAction": "Advise all staff",
"rootCause": "Wrong carton dimension"
},
"measurementByDefects": {
"aql": {
"aqlId": "123",
"critical": 0,
"major": 1,
"minor": 2
},
"defectFound": {
"critical": 0,
"major": 1,
"minor": 2
},
"defects": [
{
"affectedPercentage": 1,
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"defectCategory": "Construction",
"defectCode": "CON111",
"defectItems": [
{
"attachments": [
{
"url": "https://.../image1.jpg"
}
],
"classification": "Minor",
"color": "black",
"customId": "ITEM123",
"itemId": "111-22-333",
"size": "Medium",
"styleId": "style_1"
}
],
"defectName": "Construction defect",
"preventativeAction": "Advise all staff",
"rootCause": "Wrong carton dimension",
"totalDefectItems": 1,
"totalDefectUnits": 1
}
],
"maxAllowed": {
"critical": 0,
"major": 1,
"minor": 2
},
"totalDefects": 2,
"totalItems": 2
},
"moistureCheck": {
"aql": {
"aqlId": "123",
"critical": 0,
"major": 1,
"minor": 2
},
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"defectFound": {
"critical": 0,
"major": 1,
"minor": 2
},
"defectItems": [
{
"components": [
{
"acceptableTolerances": [
{
"from": 0.2,
"to": 1,
"unit": "cm"
}
],
"defectClassification": "Minor",
"name": "Arm",
"outOfTolerance": {
"unit": "cm",
"value": 1.5
}
}
],
"itemId": "ITEM1212",
"type": "General"
}
],
"maxAllowed": {
"critical": 0,
"major": 1,
"minor": 2
},
"preventativeAction": "Advise all staff",
"rootCause": "Wrong carton dimension",
"totalDefects": 2,
"totalItems": 2
},
"packaging": {
"aql": {
"aqlId": "123",
"critical": 0,
"major": 1,
"minor": 2
},
"defectFound": {
"critical": 0,
"major": 1,
"minor": 2
},
"defects": [
{
"affectedPercentage": 1,
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"defectCategory": "Construction",
"defectCode": "CON111",
"defectItems": [
{
"attachments": [
{
"url": "https://.../image1.jpg"
}
],
"classification": "Minor",
"color": "black",
"customId": "ITEM123",
"itemId": "111-22-333",
"size": "Medium",
"styleId": "style_1"
}
],
"defectName": "Construction defect",
"preventativeAction": "Advise all staff",
"rootCause": "Wrong carton dimension",
"totalDefectItems": 1,
"totalDefectUnits": 1
}
],
"maxAllowed": {
"critical": 0,
"major": 1,
"minor": 2
},
"packingType": "string",
"totalDefects": 2,
"totalItems": 2
},
"questions": [
{
"answer": "Yes",
"attachments": [
{
"url": "https://.../image1.jpg"
}
],
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"label": "General",
"preventativeAction": "Advise all staff",
"rootCause": "Wrong carton dimension"
}
],
"rfid": [
{
"barCode": "456",
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"decryptedCode": "123123",
"matched": "true",
"photos": [
"string"
],
"preventativeAction": "Advise all staff",
"rfid": "123",
"rootCause": "Wrong carton dimension"
}
],
"workmanship": {
"aql": {
"aqlId": "123",
"critical": 0,
"major": 1,
"minor": 2
},
"defectFound": {
"critical": 0,
"major": 1,
"minor": 2
},
"defects": [
{
"affectedPercentage": 1,
"comments": "Reviewed",
"correctiveAction": {
"details": "Rework on the defective units",
"value": "Rework Units"
},
"defectCategory": "Construction",
"defectCode": "CON111",
"defectItems": [
{
"attachments": [
{
"url": "https://.../image1.jpg"
}
],
"classification": "Minor",
"color": "black",
"customId": "ITEM123",
"itemId": "111-22-333",
"size": "Medium",
"styleId": "style_1"
}
],
"defectName": "Construction defect",
"preventativeAction": "Advise all staff",
"rootCause": "Wrong carton dimension",
"totalDefectItems": 1,
"totalDefectUnits": 1
}
],
"maxAllowed": {
"critical": 0,
"major": 1,
"minor": 2
},
"totalDefects": 2,
"totalItems": 2
}
},
"reInspectionDetail": {
"comment": "Reviewed",
"inspectionType": "TPR",
"reInspectionBookingId": "9dc7928867dc",
"reInspectionDate": "2021-05-07T00:00:00+00:00"
},
"shipmentWindow": {
"shipmentDateFrom": "2021-05-07T00:00:00+00:00",
"shipmentDateTo": "2021-05-15T00:00:00+00:00",
"shipmentNote": "Acknowledged"
}
}
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Bad Request"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Cannot retrieve session data because of expired token"
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"type": [
"Input type is not valid"
]
},
"message": "Validation error"
}
Rate-limiting Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"message": "Too many requests"
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": "Generic",
"errors": {
"system": [
"Internal error detail message"
]
},
"message": "Internal server error"
}