Audit
v1.0.0
Create an audit order
Request
Request Body
Content-Type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
| userId | string | Yes | QIMA client user id |
| serviceDate | string | Yes | Planed inspection date, format should be in dd-MMM-yyyy |
| shipDate | string | Yes | Planed shipment date, format should be in dd-MMM-yyyy |
| serviceType | string | No | QIMA audit service type, mandatory if previousOrderNumber not provided. Here is the mapping, ma: Manufacturing Audit, ea: Ethical Audit, enva: Environmental Audit, dr: Desktop Review, ghp: Food Hygiene Audits, gmp: Food Good Manufacturing Practices Audits, gfsi: Food Certified, ctpat: C-TPAT Audit, stra: Structural Audit Enum: "ma", "ea", "enva", "dr", "ghp", "gmp", "gfsi", "ctpat", "stra" |
| referenceNumber | string | No | Client reference number |
| factoryAreaSqm | integer | Yes | Factory area in SQM |
| totalNumberOfBuilding | string | Yes | Total number of building |
| announcementType | string | No | Audit order announcement type Enum: "Announced", "Semi-Announced", "Un-Announced" |
| workersCount | integer | Yes | The count of workers |
| auditWindowFrom | string | No | Audit window from date, format should be in dd-MMM-yyyy |
| auditWindowTo | string | No | Audit window to date, format should be in dd-MMM-yyyy |
| additionalComment | string | No | The additional comment of audit order |
| supplierCode | string | No | Supplier's identification code in client's system, mandatory when supplier name, city id, contact not provided, and must be a valid code |
| supplierName | string | Yes | Supplier's name |
| supplierContactName | string | Yes | Supplier's contact name |
| supplierContactPhone | string | Yes | Supplier's contact phone |
| supplierContactEmail | string | Yes | Supplier's contact email |
| supplierContinentID | string | Yes | Supplier's continent id in QIMA's system, refer to /parameter/v2/continents. Mandatory when supplier code is not provided |
| supplierCountryID | string | No | Supplier's country id in QIMA's system, refer to /parameter/v2/countries, /parameter/v2/countries or /parameter/v2/continent/{continentId}/countries. Mandatory when supplier code is not provided |
| supplierCityID | string | No | Supplier's city id in QIMA's system, refer to /parameter/v2/country/{countryId}/searchCities, /parameter/v2/province/{provinceId}/searchCities or /parameter/v2/country/{countryId}/cities. Mandatory when supplier code is not provided |
| supplierAddress | string | Yes | Supplier's address |
| supplierPostalCode | string | No | Supplier's postal code |
| specificField | string | No | Audit order specific field |
| supplierProductLines | array | Yes | Supplier product lines, get it from /parameter/v2/product-families API |
| factoryCode | string | No | Factory's identification code in client's system, mandatory when auto confirm factory is needed and factory other info are not provided |
| factoryName | string | No | Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryContactName | string | No | Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryContactPhone | string | No | Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryContactEmail | string | No | Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryContinentID | string | No | Factory's continent id in QIMA's system, refer to /parameter/v2/continents. Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryCountryID | string | No | Factory's country id in QIMA's system, refer to /parameter/v2/countries. Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryProvinceID | string | No | Factory's province id in QIMA's system, refer to /parameter/v2/country/{countryId}/provinces. Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryCityID | string | No | Factory's city id in QIMA's system, refer to /parameter/v2/country/{countryId}/searchCities. Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryAddress | string | No | Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryPostalCode | string | No | Mandatory when auto confirm factory is needed and factory code is not provided |
| factoryProductLines | array | No | Mandatory when auto confirm factory is needed and factory code is not provided, get product line from /parameter/v2/product-families API |
| supplierAlternateContactName | string | No | Supplier's alternative contact name |
| supplierAlternateContactPhone | string | No | Supplier's alternative contact phone |
| supplierAlternateContactEmail | string | No | Supplier's alternative contact email |
| factoryAlternateContactName | string | No | Name of the alternative factory contact |
| factoryAlternateContactPhone | string | No | Phone of the alternative factory contact |
| factoryAlternateContactEmail | string | No | Email of the alternative factory contact |
Responses
200
Audit order created successfully. The `message` field is empty when the factory (if provided) was also confirmed without issues.
Content-Type: application/json
invalidSupplier
boolean| Field | Type | Description |
|---|---|---|
| invalidSupplier | boolean |
draft
object| Field | Type | Description |
|---|---|---|
| draftId | string | Id of the booking draft |
| isAnOrderNotADraft | boolean | Indicate is this booking is in editing status. Draft means the booking is being edited. |
| draftSteps | array | Can be ignored |
| draftSteps[].current | boolean | |
| draftSteps[].done | boolean | |
| draftSteps[].label | string | |
| draftSteps[].visited | boolean |
orderGeneralInfo
object| Field | Type | Description |
|---|---|---|
| orderId | string | Order id, primary key of the inspection order |
| orderPlacer | string | The username of account who placed the booking |
| status | string | Order status value of the booking, mapping between value and text are 5=DRAFT, 20=WAITING_FOR_VALIDATION, 21=WAITING_FOR_MORE_INF, 25=WAITING_FOR_FEEDBACK, 30=WAITING_FOR_ALLOCATION, 40=WAITING_FOR_INSPECTION, 50=WAITING_FOR_REPORT_VALIDATION, 60=FINISHED, 70=CANCELLED, 80=SERVICE_CUT |
| statusText | string | Order status text of the booking |
| serviceType | string | QIMA inspection service type value 1: PSI (Pre-Shipment Inspection), 2: IPC (Initial Production Check), 3: DUPRO (During Production Inspection) , 4: CLC (Container Loading Check), 6: PM (Production Monitoring), 8: SR (Sample Review), 21: SC (Sample Collection) |
| serviceTypeText | string | QIMA inspection service type text |
| bookingDate | string | Date of the inspection booking is placed, in format dd-MMM-yyyy |
| bookingDateUnixTimestamp | integer | Date of the inspection booking is placed in unix timestamp |
| orderNumber | string | QIMA booking order number, like R-Cloud-xx |
| companyId | string | Company id in QIMA system |
| userId | string | QIMA client user id |
| parentCompanyId | string | Parent company id in QIMA system |
| allowChangeInspectionDate | boolean | Indicate if in this order is supplier is allowed to change inspection date |
| supplierValidateCode | string | Code for supplier to fill when confirming inspection date and location via link in confirmation email |
| clientRefNb | string | Reference number client can use for referencing with QIMA's inspection booking |
| expectedInspectionDate | string | Original expected inspection date from client, in dd-MMM-yyyy format |
| expectedInspectionDateUnixTimestamp | integer | Original expected inspection date from client, in unix timestamp format |
| actualInspectionDate | string | Actual inspection date confirmed with factory, in dd-MMM-yyyy format |
| actualInspectionDateUnixTimestamp | integer | Actual inspection date confirmed with factory, in unix timestamp format |
| expectedShipDate | string | Original expected shipment date from client, in dd-MMM-yyyy format |
| expectedShipDateUnixTimestamp | integer | Original expected shipment date from client, in unix timestamp format |
| bookFromPreOrder | string | Previous inspection booking id, need to provide when place re-inspection |
| copyAllMailTo | array | Email addresses that all email related to order and reports will be copied to |
| copyReportMailTo | array | Email addresses that all report related to order and reports will be copied to |
| inspectionMethod | object | |
| inspectionMethod.id | string | Id of this system parameter |
| inspectionMethod.classification | string | Type of this system parameter |
| inspectionMethod.key | string | Key name of this system parameter |
| inspectionMethod.value | string | Value name of this system parameter |
| inspectionMethod.text | string | Displaying name of this system parameter |
| inspectionMethod.description | string | Displaying description of this system parameter |
| inspectionMethod.createTime | string | Creation time of this system parameter |
| inspectionMethod.updateTime | string | Update time of this system parameter |
| inspectionMethod.sequence | integer | Sequence of this system parameter when under same classification |
| container20 | integer | Number of containers (20 inches) - for Container Loading Check (CLC) only |
| container40 | integer | Number of containers (40 inches) - for Container Loading Check (CLC) only |
| container40HQ | integer | Number of containers (60 inches) - for Container Loading Check (CLC) only |
| customField1 | string | Custom field 1 depends on use case |
| customField2 | string | Custom field 2 depends on use case |
| customField3 | string | Custom field 3 depends on use case |
| performInQimaone | integer | Inspection perform platform type, 0: Within QSP, 1: In QIMAone from QSP, 2: In QIMAone from QIMAone |
| lcnumber | string | |
| confirmed | boolean | |
| icneeded | boolean | |
| lcappName | string | |
| lcappAddress | string | |
| lcbeneName | string | |
| lcbeneAddress | string |
orderExtra
object| Field | Type | Description |
|---|---|---|
| orderId | string | Order id, primary key of the inspection order |
| cancelable | boolean | Indicate currently if this booking can be cancelled |
| editable | boolean | Indicate currently if this booking can be modified |
| isReInspection | boolean | Indicate if this inspection is re-inspection |
| followUp | boolean | Indicate if audit is a follow-up audit, when this booking is an audit booking |
| originalNbReinsp | string | The original order number if this booking is an re-inspection |
| reInspectionInstruction | string | The original order number if this booking is an re-inspection |
| nbOfInspectors | integer | Inspectors count assigned to this inspection |
| prevOrderType | string | Previous service type |
| prevOrderStatus | string | Previous order status |
| prevServiceDate | string | Previous service date |
| prevServiceDateText | string | Previous service date, the value could be "Confidential", date, or a time window. |
| multiSupplierOrder | boolean | |
| quickBooking | boolean |
orderFactory
object| Field | Type | Description |
|---|---|---|
| id | string | Id of the factory in this booking |
| factoryId | string | Id of the factory in client's account |
| factoryCode | string | Factory's identification code in client's system |
| factoryName | string | Name of the factory |
| factoryNameCN | string | Chinese name of the factory |
| factoryMGRName | string | Name of the factory contact |
| factoryMGRMobile | string | Mobile phone number of the factory contact |
| factoryMGRNumber | string | Telephone phone number of the factory contact |
| factoryMGREmail | array | Emails of the the factory contact |
| factoryOtherMobile | string | Mobile phone of the alternative factory contact |
| factoryOtherName | string | Name of the alternative factory contact |
| factoryOtherNumber | string | Telephone number of the alternative factory contact |
| factoryOtherEmail | array | Emails of the the alternative factory contact |
| factoryAddress | string | Address of the factory |
| factoryCity | string | City of the factory |
| factoryProvince | string | Province of the factory |
| factoryCountry | string | Country of the factory |
| factoryContinent | string | Continent of the factory |
| factoryPostCode | string | Post code of the factory |
| factoryProductLines | array | Product lines of the factory |
| nbOfWorkers | integer | Number of the workers in the factory |
| isMutiLocation | boolean | Indicate if this inspection needs to be done in multiple factories |
| ext1 | string | Customer fields 1 of the factory info in this booking |
| ext2 | string | Customer fields 2 of the factory info in this booking |
| ext3 | string | Customer fields 3 of the factory info in this booking |
| factoryCityId | string | City id of the factory in QIMA system |
orderSupplier
object| Field | Type | Description |
|---|---|---|
| orderId | string | Id of the order |
| id | string | Id of the supplier in this booking |
| supplierCode | string | Supplier's identification code in client's system |
| supplierName | string | Name of the supplier |
| supplierNameCN | string | Chinese name of the factory |
| supplierMGRName | string | Name of the factory contact |
| supplierMGRMobile | string | Mobile phone number of the factory contact |
| supplierMGRNumber | string | Telephone phone number of the factory contact |
| supplierMGREmail | array | Emails of the the factory contact |
| supplierOtherName | string | Name of the alternative factory contact |
| supplierOtherMobile | string | Mobile phone of the alternative factory contact |
| supplierOtherNumber | string | Telephone number of the alternative factory contact |
| supplierOtherEmail | array | Emails of the the alternative factory contact |
| supplierAddress | string | Address of the factory |
| supplierCity | string | City of the factory |
| supplierPostCode | string | Post code of the factory |
| supplierCountry | string | Country of the factory |
| supplierContinentID | string | Continent id of the factory in QIMA system |
| supplierProductLines | array | Product lines of the factory |
| supplierId | string | Id of the supplier in client's account |
| ext1 | string | Customer fields 1 of the factory info in this booking |
| ext2 | string | Customer fields 2 of the factory info in this booking |
| ext3 | string | Customer fields 3 of the factory info in this booking |
| isActive | string | Indicate if this supplier still can be selected for service |
orderAuditGeneral
object| Field | Type | Description |
|---|---|---|
| orderId | string | Id of the order |
| sampleSize | string | The size of sample, when >=500 pass 1, else pass 0 |
| contactFactoryOrNot | boolean | Pass 1 to psi if true, else 0 |
| generalComment | string | General comment |
| guidelines | integer | The guidelines of audit, ai ethical: 0, smeta 2 pillar: 1, smeta 4 pillar: 2 |
| totalNumberOfBuilding | integer | Total number of building |
| factoryAreaSqm | integer | Factory Area in SQM |
| additionalComment | string | Additional comment |
| poNumber | string | The number of PO |
| announcementType | string | Audit order announcement type |
| auditWindowFrom | string | Audit window from date, format should be in dd-MMM-yyyy |
| auditWindowTo | string | Audit window to date, format should be in dd-MMM-yyyy |
| auditWindowUnAvailableDays | array | The unavailable days of audit window |
| auditDivision | string | The division of audit |
| prodName | string | The name of product |
| clientAuditProgram | string | Client audit program |
| additiveFactors | string | Additive factors |
orderAuditFieldsList
array<object>| Field | Type | Description |
|---|---|---|
| id | string | The id of order audit fields |
| orderId | string | The id of order |
| fieldType | string | The type of field, 1 : mandatory; 2 : optional; 3 : specific, 4 : EA_SA8000; 5 : EA_SMETA |
| fieldId | string | The id of field |
| specificField | string | Audit order specific field |
| weight | string | The weight of audit order |
| selected | boolean | If true then pass 1 to psi, else pass 0 |
| fieldName | string | The name of field |
| description | string | Description |
| classification | string | Classification |
| fieldVersion | integer | The version of field |
auditGuidelineOtherFields
array<object>| Field | Type | Description |
|---|---|---|
| fieldName | string | The name of field |
| refValue | string | Id to parm_classified_keyvalue |
| textValue | string | Text value |
{
"message": "",
"content": {
"invalidSupplier": false,
"orderGeneralInfo": {
"orderId": "2E1C54F73CD44CA89224EF484977233D",
"orderPlacer": "apiuser001",
"status": "20",
"statusText": "WAITING_FOR_VALIDATION",
"serviceType": "9",
"serviceTypeText": "EA",
"orderNumber": "Q2600365241-PP",
"companyId": "23EC09AB0F3C46BBA4F79718DCED16D0",
"userId": "4C6E94072DFC4918B60752F701DE544A",
"clientRefNb": "2107-0-02026",
"confirmed": false
},
"orderAuditGeneral": {
"orderId": "2E1C54F73CD44CA89224EF484977233D",
"sampleSize": "1",
"guidelines": 0,
"announcementType": "Semi-Announced"
}
}
}202
Audit order was created, but the factory confirmation step reported an issue. The `content` shape is identical to the `200` response above; only `message` (and `orderGeneralInfo.confirmed`) differ.
Content-Type: application/json
invalidSupplier
boolean| Field | Type | Description |
|---|---|---|
| invalidSupplier | boolean |
draft
object| Field | Type | Description |
|---|---|---|
| draftId | string | Id of the booking draft |
| isAnOrderNotADraft | boolean | Indicate is this booking is in editing status. Draft means the booking is being edited. |
| draftSteps | array | Can be ignored |
| draftSteps[].current | boolean | |
| draftSteps[].done | boolean | |
| draftSteps[].label | string | |
| draftSteps[].visited | boolean |
orderGeneralInfo
object| Field | Type | Description |
|---|---|---|
| orderId | string | Order id, primary key of the inspection order |
| orderPlacer | string | The username of account who placed the booking |
| status | string | Order status value of the booking, mapping between value and text are 5=DRAFT, 20=WAITING_FOR_VALIDATION, 21=WAITING_FOR_MORE_INF, 25=WAITING_FOR_FEEDBACK, 30=WAITING_FOR_ALLOCATION, 40=WAITING_FOR_INSPECTION, 50=WAITING_FOR_REPORT_VALIDATION, 60=FINISHED, 70=CANCELLED, 80=SERVICE_CUT |
| statusText | string | Order status text of the booking |
| serviceType | string | QIMA inspection service type value 1: PSI (Pre-Shipment Inspection), 2: IPC (Initial Production Check), 3: DUPRO (During Production Inspection) , 4: CLC (Container Loading Check), 6: PM (Production Monitoring), 8: SR (Sample Review), 21: SC (Sample Collection) |
| serviceTypeText | string | QIMA inspection service type text |
| bookingDate | string | Date of the inspection booking is placed, in format dd-MMM-yyyy |
| bookingDateUnixTimestamp | integer | Date of the inspection booking is placed in unix timestamp |
| orderNumber | string | QIMA booking order number, like R-Cloud-xx |
| companyId | string | Company id in QIMA system |
| userId | string | QIMA client user id |
| parentCompanyId | string | Parent company id in QIMA system |
| allowChangeInspectionDate | boolean | Indicate if in this order is supplier is allowed to change inspection date |
| supplierValidateCode | string | Code for supplier to fill when confirming inspection date and location via link in confirmation email |
| clientRefNb | string | Reference number client can use for referencing with QIMA's inspection booking |
| expectedInspectionDate | string | Original expected inspection date from client, in dd-MMM-yyyy format |
| expectedInspectionDateUnixTimestamp | integer | Original expected inspection date from client, in unix timestamp format |
| actualInspectionDate | string | Actual inspection date confirmed with factory, in dd-MMM-yyyy format |
| actualInspectionDateUnixTimestamp | integer | Actual inspection date confirmed with factory, in unix timestamp format |
| expectedShipDate | string | Original expected shipment date from client, in dd-MMM-yyyy format |
| expectedShipDateUnixTimestamp | integer | Original expected shipment date from client, in unix timestamp format |
| bookFromPreOrder | string | Previous inspection booking id, need to provide when place re-inspection |
| copyAllMailTo | array | Email addresses that all email related to order and reports will be copied to |
| copyReportMailTo | array | Email addresses that all report related to order and reports will be copied to |
| inspectionMethod | object | |
| inspectionMethod.id | string | Id of this system parameter |
| inspectionMethod.classification | string | Type of this system parameter |
| inspectionMethod.key | string | Key name of this system parameter |
| inspectionMethod.value | string | Value name of this system parameter |
| inspectionMethod.text | string | Displaying name of this system parameter |
| inspectionMethod.description | string | Displaying description of this system parameter |
| inspectionMethod.createTime | string | Creation time of this system parameter |
| inspectionMethod.updateTime | string | Update time of this system parameter |
| inspectionMethod.sequence | integer | Sequence of this system parameter when under same classification |
| container20 | integer | Number of containers (20 inches) - for Container Loading Check (CLC) only |
| container40 | integer | Number of containers (40 inches) - for Container Loading Check (CLC) only |
| container40HQ | integer | Number of containers (60 inches) - for Container Loading Check (CLC) only |
| customField1 | string | Custom field 1 depends on use case |
| customField2 | string | Custom field 2 depends on use case |
| customField3 | string | Custom field 3 depends on use case |
| performInQimaone | integer | Inspection perform platform type, 0: Within QSP, 1: In QIMAone from QSP, 2: In QIMAone from QIMAone |
| lcnumber | string | |
| confirmed | boolean | |
| icneeded | boolean | |
| lcappName | string | |
| lcappAddress | string | |
| lcbeneName | string | |
| lcbeneAddress | string |
orderExtra
object| Field | Type | Description |
|---|---|---|
| orderId | string | Order id, primary key of the inspection order |
| cancelable | boolean | Indicate currently if this booking can be cancelled |
| editable | boolean | Indicate currently if this booking can be modified |
| isReInspection | boolean | Indicate if this inspection is re-inspection |
| followUp | boolean | Indicate if audit is a follow-up audit, when this booking is an audit booking |
| originalNbReinsp | string | The original order number if this booking is an re-inspection |
| reInspectionInstruction | string | The original order number if this booking is an re-inspection |
| nbOfInspectors | integer | Inspectors count assigned to this inspection |
| prevOrderType | string | Previous service type |
| prevOrderStatus | string | Previous order status |
| prevServiceDate | string | Previous service date |
| prevServiceDateText | string | Previous service date, the value could be "Confidential", date, or a time window. |
| multiSupplierOrder | boolean | |
| quickBooking | boolean |
orderFactory
object| Field | Type | Description |
|---|---|---|
| id | string | Id of the factory in this booking |
| factoryId | string | Id of the factory in client's account |
| factoryCode | string | Factory's identification code in client's system |
| factoryName | string | Name of the factory |
| factoryNameCN | string | Chinese name of the factory |
| factoryMGRName | string | Name of the factory contact |
| factoryMGRMobile | string | Mobile phone number of the factory contact |
| factoryMGRNumber | string | Telephone phone number of the factory contact |
| factoryMGREmail | array | Emails of the the factory contact |
| factoryOtherMobile | string | Mobile phone of the alternative factory contact |
| factoryOtherName | string | Name of the alternative factory contact |
| factoryOtherNumber | string | Telephone number of the alternative factory contact |
| factoryOtherEmail | array | Emails of the the alternative factory contact |
| factoryAddress | string | Address of the factory |
| factoryCity | string | City of the factory |
| factoryProvince | string | Province of the factory |
| factoryCountry | string | Country of the factory |
| factoryContinent | string | Continent of the factory |
| factoryPostCode | string | Post code of the factory |
| factoryProductLines | array | Product lines of the factory |
| nbOfWorkers | integer | Number of the workers in the factory |
| isMutiLocation | boolean | Indicate if this inspection needs to be done in multiple factories |
| ext1 | string | Customer fields 1 of the factory info in this booking |
| ext2 | string | Customer fields 2 of the factory info in this booking |
| ext3 | string | Customer fields 3 of the factory info in this booking |
| factoryCityId | string | City id of the factory in QIMA system |
orderSupplier
object| Field | Type | Description |
|---|---|---|
| orderId | string | Id of the order |
| id | string | Id of the supplier in this booking |
| supplierCode | string | Supplier's identification code in client's system |
| supplierName | string | Name of the supplier |
| supplierNameCN | string | Chinese name of the factory |
| supplierMGRName | string | Name of the factory contact |
| supplierMGRMobile | string | Mobile phone number of the factory contact |
| supplierMGRNumber | string | Telephone phone number of the factory contact |
| supplierMGREmail | array | Emails of the the factory contact |
| supplierOtherName | string | Name of the alternative factory contact |
| supplierOtherMobile | string | Mobile phone of the alternative factory contact |
| supplierOtherNumber | string | Telephone number of the alternative factory contact |
| supplierOtherEmail | array | Emails of the the alternative factory contact |
| supplierAddress | string | Address of the factory |
| supplierCity | string | City of the factory |
| supplierPostCode | string | Post code of the factory |
| supplierCountry | string | Country of the factory |
| supplierContinentID | string | Continent id of the factory in QIMA system |
| supplierProductLines | array | Product lines of the factory |
| supplierId | string | Id of the supplier in client's account |
| ext1 | string | Customer fields 1 of the factory info in this booking |
| ext2 | string | Customer fields 2 of the factory info in this booking |
| ext3 | string | Customer fields 3 of the factory info in this booking |
| isActive | string | Indicate if this supplier still can be selected for service |
orderAuditGeneral
object| Field | Type | Description |
|---|---|---|
| orderId | string | Id of the order |
| sampleSize | string | The size of sample, when >=500 pass 1, else pass 0 |
| contactFactoryOrNot | boolean | Pass 1 to psi if true, else 0 |
| generalComment | string | General comment |
| guidelines | integer | The guidelines of audit, ai ethical: 0, smeta 2 pillar: 1, smeta 4 pillar: 2 |
| totalNumberOfBuilding | integer | Total number of building |
| factoryAreaSqm | integer | Factory Area in SQM |
| additionalComment | string | Additional comment |
| poNumber | string | The number of PO |
| announcementType | string | Audit order announcement type |
| auditWindowFrom | string | Audit window from date, format should be in dd-MMM-yyyy |
| auditWindowTo | string | Audit window to date, format should be in dd-MMM-yyyy |
| auditWindowUnAvailableDays | array | The unavailable days of audit window |
| auditDivision | string | The division of audit |
| prodName | string | The name of product |
| clientAuditProgram | string | Client audit program |
| additiveFactors | string | Additive factors |
orderAuditFieldsList
array<object>| Field | Type | Description |
|---|---|---|
| id | string | The id of order audit fields |
| orderId | string | The id of order |
| fieldType | string | The type of field, 1 : mandatory; 2 : optional; 3 : specific, 4 : EA_SA8000; 5 : EA_SMETA |
| fieldId | string | The id of field |
| specificField | string | Audit order specific field |
| weight | string | The weight of audit order |
| selected | boolean | If true then pass 1 to psi, else pass 0 |
| fieldName | string | The name of field |
| description | string | Description |
| classification | string | Classification |
| fieldVersion | integer | The version of field |
auditGuidelineOtherFields
array<object>| Field | Type | Description |
|---|---|---|
| fieldName | string | The name of field |
| refValue | string | Id to parm_classified_keyvalue |
| textValue | string | Text value |
{
"message": "Supplier confirm audit order failed!Confirm audit failed. Cannot confirm audit because of the factory service is down!",
"content": {
"invalidSupplier": false,
"orderGeneralInfo": {
"orderId": "2E1C54F73CD44CA89224EF484977233D",
"orderPlacer": "apiuser001",
"status": "20",
"statusText": "WAITING_FOR_VALIDATION",
"serviceType": "9",
"serviceTypeText": "EA",
"orderNumber": "Q2600365241-PP",
"companyId": "23EC09AB0F3C46BBA4F79718DCED16D0",
"userId": "4C6E94072DFC4918B60752F701DE544A",
"clientRefNb": "2107-0-02026",
"confirmed": false
},
"orderAuditGeneral": {
"orderId": "2E1C54F73CD44CA89224EF484977233D",
"sampleSize": "1",
"guidelines": 0,
"announcementType": "Semi-Announced"
}
}
}400
ServiceDate and ShipDate cannot be null, and announceType should be legal
Content-Type: application/json
{
"message": "[serviceDate can't be empty]",
"content": ""
}500
Error happened when create audit order
Content-Type: application/json
POST
/v1.0/auditRequest samples
application/json
{
"userId": "4C6E94072DFC4918B60752F701DE544A",
"serviceDate": "10-Oct-2026",
"shipDate": "10-Oct-2026",
"serviceType": "ea",
"referenceNumber": "2107-0-02026",
"factoryAreaSqm": 1,
"totalNumberOfBuilding": "3",
"announcementType": "Semi-Announced",
"workersCount": 1,
"auditWindowFrom": "10-Oct-2026",
"auditWindowTo": "12-Oct-2026",
"additionalComment": "test",
"supplierCode": "SF-TL90",
"supplierName": "Sample Supplier Co.",
"supplierContactName": "Supplier Manager",
"supplierContactPhone": "13800000001",
"supplierContactEmail": "supplier.contact@example.com",
"supplierContinentID": "24865671",
"supplierCountryID": "23424781",
"supplierCityID": "12687656",
"supplierAddress": "LuoHuQu ChunFenglu 999",
"supplierProductLines": [
"bigCat1_s2",
"bigCat1_s3"
],
"factoryCode": "SF-99-i56",
"factoryName": "Sample Factory Co.",
"factoryContactName": "Factory Manager",
"factoryContactPhone": "13800000004",
"factoryContactEmail": "factory.manager@example.com",
"factoryContinentID": "24865671",
"factoryCountryID": "23424781",
"factoryProvinceID": "12578019",
"factoryCityID": "12687656",
"factoryAddress": "LuoHuQu ChunFenglu 777",
"factoryPostalCode": "511464",
"factoryProductLines": [
"bigCat1_s2",
"bigCat1_s3"
],
"supplierAlternateContactName": "Alternate Supplier Contact",
"supplierAlternateContactPhone": "13800000002",
"supplierAlternateContactEmail": "supplier.alt@example.com",
"factoryAlternateContactName": "Alternate Factory Contact",
"factoryAlternateContactPhone": "13800000003",
"factoryAlternateContactEmail": "factory.alt@example.com"
}
Response samples
application/json
{
"message": "",
"content": {
"invalidSupplier": false,
"orderGeneralInfo": {
"orderId": "2E1C54F73CD44CA89224EF484977233D",
"orderPlacer": "apiuser001",
"status": "20",
"statusText": "WAITING_FOR_VALIDATION",
"serviceType": "9",
"serviceTypeText": "EA",
"orderNumber": "Q2600365241-PP",
"companyId": "23EC09AB0F3C46BBA4F79718DCED16D0",
"userId": "4C6E94072DFC4918B60752F701DE544A",
"clientRefNb": "2107-0-02026",
"confirmed": false
},
"orderAuditGeneral": {
"orderId": "2E1C54F73CD44CA89224EF484977233D",
"sampleSize": "1",
"guidelines": 0,
"announcementType": "Semi-Announced"
}
}
}