Create Inspection

Request
Request Body schema: application/json
userId
required
string

QIMA client user id

serviceDate
required
string

Planed inspection date, format should be in dd-MMM-yyyy

shipDate
required
string

Planed shipment date, format should be in dd-MMM-yyyy

serviceType
required
string

QIMA inspection service type, mandatory if previousOrderNumber not provided. Here is the mapping, 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)

Enum: "1" "2" "3" "4" "6" "7" "8" "21"
bookingType
required
string

QIMA inspection type

previousOrderNumber
string

Previous QIMA inspection reference R-Cloud number, must provide a valid R-Cloud number if it's re-inspection, example value: R-Cloud-xxxx

referenceNumber
string

Client reference number

supplierId
string

QIMA supplier id

supplierCode
string

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

Mandatory when supplier code is not provided

supplierContactName
string

Mandatory when supplier code is not provided

supplierContactPhone
string

Mandatory when supplier code is not provided

supplierContactEmail
string

Mandatory when supplier code is not provided

supplierContinentID
string

Supplier's continent id in QIMA's system, refer to /parameter/v2/continents. Mandatory when supplier code is not provided

supplierCountryID
string

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

supplierProvinceID
string

Supplier's Province id in QIMA's system, refer to /parameter/v2/country/{countryId}/provinces. Mandatory when supplier code is not provided

supplierCityID
string

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

Mandatory when supplier code is not provided

supplierProductLines
Array of strings

Mandatory when supplier code is not provided, get product line from /parameter/v2/product-families API

supplierAlternateContactName
string

Supplier's alternative contact name

supplierAlternateContactPhone
string

Supplier's alternative contact telephone

supplierAlternateContactEmail
string

Supplier's alternative contact email

factoryCode
string

Factory's identification code in client's system, mandatory when auto confirm factory is needed and factory other info are not provided

factoryName
string

Mandatory when auto confirm factory is needed and factory code is not provided

factoryContactName
string

Mandatory when auto confirm factory is needed and factory code is not provided

factoryContactPhone
string

Mandatory when auto confirm factory is needed and factory code is not provided

factoryContactEmail
string

Mandatory when auto confirm factory is needed and factory code is not provided

factoryContinentID
string

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

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

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

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

Mandatory when auto confirm factory is needed and factory code is not provided

factoryPostCode
string

Mandatory when auto confirm factory is needed and factory code is not provided

factoryProductLines
Array of strings

Mandatory when auto confirm factory is needed and factory code is not provided, get product line from /parameter/v2/product-families API

factoryAlternateContactName
string

Name of the alternative factory contact

factoryAlternateContactPhone
string

Telephone of the alternative factory contact

factoryAlternateContactEmail
string

Email of the alternative factory contact

required
Array of objects (InspectionProduct)
customField1
string

Order level custom field 1 depends on use case

customField2
string

Order level custom field w depends on use case

customField3
string

Order level custom field 3 depends on use case

performInQimaone
integer <int32>

Inspection perform platform type, 0: Within QSP, 1: In QIMAone from QSP, 2: In QIMAone from QIMAone

Responses
200

empty message if everything is working

202

Order created but factory not confirmed

400

received data couldn't pass validation, specific field will be given

409

Duplicate booking request found and this request is ignored.

500

failed to create the booking and error is returned

post/v1.0/inspection
Request samples
application/json
{
  • "userId": [
    ],
  • "serviceDate": [
    ],
  • "shipDate": [
    ],
  • "serviceType": [
    ],
  • "bookingType": [
    ],
  • "previousOrderNumber": "string",
  • "referenceNumber": [
    ],
  • "supplierId": "string",
  • "supplierCode": "string",
  • "supplierName": "string",
  • "supplierContactName": "string",
  • "supplierContactPhone": "string",
  • "supplierContactEmail": "string",
  • "supplierContinentID": "string",
  • "supplierCountryID": "string",
  • "supplierProvinceID": "string",
  • "supplierCityID": "string",
  • "supplierAddress": "string",
  • "supplierProductLines": [
    ],
  • "supplierAlternateContactName": "string",
  • "supplierAlternateContactPhone": "string",
  • "supplierAlternateContactEmail": "string",
  • "factoryCode": "string",
  • "factoryName": "string",
  • "factoryContactName": "string",
  • "factoryContactPhone": "string",
  • "factoryContactEmail": "string",
  • "factoryContinentID": "string",
  • "factoryCountryID": "string",
  • "factoryProvinceID": "string",
  • "factoryCityID": "string",
  • "factoryAddress": "string",
  • "factoryPostCode": "string",
  • "factoryProductLines": [
    ],
  • "factoryAlternateContactName": "string",
  • "factoryAlternateContactPhone": "string",
  • "factoryAlternateContactEmail": "string",
  • "products": [
    ],
  • "customField1": "string",
  • "customField2": "string",
  • "customField3": "string",
  • "performInQimaone": [
    ]
}
Response samples
application/json
{
  • "draft": {
    },
  • "orderGeneralInfo": {
    },
  • "orderExtra": {
    },
  • "orderFactory": {
    },
  • "orderSupplier": {
    },
  • "multiOrderSuppliers": [
    ],
  • "multiOrderFactories": [
    ],
  • "products": [
    ]
}