QIMA Logo
API Reference

8 categories • 44 endpoints

  • All APIs

    44


  • Inspection
    v1.0.0

    Create inspection booking asynchronously

    Request

    Request Body

    Content-Type: application/json

    FieldTypeRequiredDescription
    userIdstringYes
    QIMA client user id
    serviceDatestringYes
    Planed inspection date, format should be in dd-MMM-yyyy
    shipDatestringYes
    Planed shipment date, format should be in dd-MMM-yyyy
    serviceTypestringYes
    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"
    bookingTypestringYes
    QIMA inspection type
    previousOrderNumberstringNo
    Previous QIMA inspection reference R-Cloud number, must provide a valid R-Cloud number if it's re-inspection, example value: R-Cloud-xxxx
    referenceNumberstringNo
    Client reference number
    supplierIdstringNo
    QIMA supplier id
    supplierCodestringNo
    Supplier's identification code in client's system, mandatory when supplier name, city id, contact not provided, and must be a valid code
    supplierNamestringNo
    Mandatory when supplier code is not provided
    supplierContactNamestringNo
    Mandatory when supplier code is not provided
    supplierContactPhonestringNo
    Mandatory when supplier code is not provided
    supplierContactEmailstringNo
    Mandatory when supplier code is not provided
    supplierContinentIDstringNo
    Supplier's continent id in QIMA's system, refer to /parameter/v2/continents. Mandatory when supplier code is not provided
    supplierCountryIDstringNo
    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
    supplierProvinceIDstringNo
    Supplier's Province id in QIMA's system, refer to /parameter/v2/country/{countryId}/provinces. Mandatory when supplier code is not provided
    supplierCityIDstringNo
    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
    supplierAddressstringNo
    Mandatory when supplier code is not provided
    supplierProductLinesarrayNo
    Mandatory when supplier code is not provided, get product line from /parameter/v2/product-families API
    supplierAlternateContactNamestringNo
    Supplier's alternative contact name
    supplierAlternateContactPhonestringNo
    Supplier's alternative contact telephone
    supplierAlternateContactEmailstringNo
    Supplier's alternative contact email
    factoryCodestringNo
    Factory's identification code in client's system, mandatory when auto confirm factory is needed and factory other info are not provided
    factoryNamestringNo
    Mandatory when auto confirm factory is needed and factory code is not provided
    factoryContactNamestringNo
    Mandatory when auto confirm factory is needed and factory code is not provided
    factoryContactPhonestringNo
    Mandatory when auto confirm factory is needed and factory code is not provided
    factoryContactEmailstringNo
    Mandatory when auto confirm factory is needed and factory code is not provided
    factoryContinentIDstringNo
    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
    factoryCountryIDstringNo
    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
    factoryProvinceIDstringNo
    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
    factoryCityIDstringNo
    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
    factoryAddressstringNo
    Mandatory when auto confirm factory is needed and factory code is not provided
    factoryPostCodestringNo
    Mandatory when auto confirm factory is needed and factory code is not provided
    factoryProductLinesarrayNo
    Mandatory when auto confirm factory is needed and factory code is not provided, get product line from /parameter/v2/product-families API
    factoryAlternateContactNamestringNo
    Name of the alternative factory contact
    factoryAlternateContactPhonestringNo
    Telephone of the alternative factory contact
    factoryAlternateContactEmailstringNo
    Email of the alternative factory contact
    productsarrayYes
    products[].namestringNo
    Name of the inspection product
    products[].categoryIdstringNo
    Product category id, refer to /parameter/v2/product-categories
    products[].familyIdstringNo
    Product family id, refer to /parameter/v2/product-families
    products[].typeIdstringNo
    Product type id, refer to /parameter/v2/product-types
    products[].prodReferencestringNo
    Product level product reference, please leave this empty when multi-reference booking is enabled in account level
    products[].prodDivisionstringNo
    Division name that this product belongs to in client's company
    products[].poNumberstringNo
    Product level PO number, please leave this empty when multi-reference booking is enabled in account level and fill po number under refs
    products[].prodQuantityintegerNo
    Product level product quantity, please leave this empty when multi-reference booking is enabled in account level and fill product quantity under refs
    products[].expectedFinishedPctintegerNo
    Percentage of the expected production finished productions for inspection
    products[].expectedPackedPctintegerNo
    Percentage of the expected packed production for inspection
    products[].unitPackingstringNo
    Optional field in the product level to define unit packing comments
    products[].outerPackingstringNo
    Optional field in the product level to define outer packing comments
    products[].sampleReferenceClientCommentsstringNo
    Optional field in the product level to define sample comments
    products[].customField1stringNo
    Product level custom field 1 depends on use case
    products[].customField2stringNo
    Product level custom field 2 depends on use case
    products[].customField3stringNo
    Product level custom field 3 depends on use case
    products[].refsarrayNo
    Product reference level info, used when multi-reference booking is enabled in account level
    products[].refs[].poNumberstringNo
    Reference level PO number, fill this when multi-reference booking is enabled in account level
    products[].refs[].skuCodestringNo
    Reference level SKU code, fill this when multi-reference booking is enabled in account level
    products[].refs[].qtyintegerYes
    Reference level product quantity, fill this when multi-reference booking is enabled in account level
    products[].refs[].brandstringNo
    Reference level brand name, fill this when multi-reference booking is enabled in account level
    products[].refs[].customField1stringNo
    Product level custom field 1 depends on use case
    products[].refs[].customField2stringNo
    Product level custom field 2 depends on use case
    products[].refs[].customField3stringNo
    Product level custom field 3 depends on use case
    products[].refs[].customField4stringNo
    Product level custom field 4 depends on use case
    products[].refs[].customField5stringNo
    Product level custom field 5 depends on use case
    products[].refs[].customField6stringNo
    Product level custom field 6 depends on use case
    products[].refs[].customField7stringNo
    Product level custom field 7 depends on use case
    products[].refs[].customField8stringNo
    Product level custom field 8 depends on use case
    products[].refs[].customField9stringNo
    Product level custom field 9 depends on use case
    products[].refs[].customField10stringNo
    Product level custom field 10 depends on use case
    products[].refs[].customField11stringNo
    Product level custom field 11 depends on use case
    products[].refs[].customField12stringNo
    Product level custom field 12 depends on use case
    products[].checkListobjectNo
    products[].checkList.prodSampleLevelstringNo
    Product sample level
    products[].checkList.prodSampleSizeintegerNo
    Product sample size
    products[].checkList.aqlCriticalstringNo
    Allowed AQL in critical level
    products[].checkList.aqlMajorstringNo
    Allowed AQL in major level
    products[].checkList.aqlMinorstringNo
    Allowed AQL in minor level
    products[].checkList.prodMeasurementSampleSizeintegerNo
    Product measurement sample size
    products[].checkList.prodMeasurementSampleLevelstringNo
    Product measurement sample level
    customField1stringNo
    Order level custom field 1 depends on use case
    customField2stringNo
    Order level custom field w depends on use case
    customField3stringNo
    Order level custom field 3 depends on use case
    performInQimaoneintegerNo
    Inspection perform platform type, 0: Within QSP, 1: In QIMAone from QSP, 2: In QIMAone from QIMAone
    Responses

    200
    successfully receive your request, you can call /booking-result API to check booking result

    Content-Type: application/json

    message
    string
    FieldTypeDescription
    messagestring
    FieldTypeDescription
    {
      "message": "successfully receive your request, you can call /booking-result API to check booking result",
      "content": "E97EFEEBCAD647CCAAF4F123E889BC4E"
    }
    POST
    /v1.0/async-inspection
    Request samples

    application/json

    { "userId": "7CCBF38CD28F46C584CF530EE28F9AEF", "serviceDate": "19-Dec-2022", "shipDate": "20-Dec-2022", "serviceType": "1", "bookingType": "General, Textile, Fabric", "previousOrderNumber": "string", "referenceNumber": "Client own reference number", "supplierId": "string", "supplierCode": "string", "supplierName": "string", "supplierContactName": "string", "supplierContactPhone": "string", "supplierContactEmail": "string", "supplierContinentID": "string", "supplierCountryID": "string", "supplierProvinceID": "string", "supplierCityID": "string", "supplierAddress": "string", "supplierProductLines": [ "bigCat1_s2", "bigCat1_s3" ], "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": [ "bigCat1_s2", "bigCat1_s3" ], "factoryAlternateContactName": "string", "factoryAlternateContactPhone": "string", "factoryAlternateContactEmail": "string", "products": [ { "name": "string", "categoryId": "string", "familyId": "string", "typeId": "string", "prodReference": "string", "prodDivision": "Womenswear", "poNumber": "string", "prodQuantity": 1, "expectedFinishedPct": 90, "expectedPackedPct": 100, "unitPacking": "string", "outerPacking": "string", "sampleReferenceClientComments": "string", "customField1": "string", "customField2": "string", "customField3": "string", "refs": [ { "poNumber": "string", "skuCode": "string", "qty": 1, "brand": "string", "customField1": "string", "customField2": "string", "customField3": "string", "customField4": "string", "customField5": "string", "customField6": "string", "customField7": "string", "customField8": "string", "customField9": "string", "customField10": "string", "customField11": "string", "customField12": "string" } ], "checkList": { "prodSampleLevel": "I, II", "prodSampleSize": 125, "aqlCritical": "0", "aqlMajor": "1", "aqlMinor": "3", "prodMeasurementSampleSize": 20, "prodMeasurementSampleLevel": "S3" } } ], "customField1": "string", "customField2": "string", "customField3": "string", "performInQimaone": 0 }

    Response samples

    application/json

    { "message": "successfully receive your request, you can call /booking-result API to check booking result", "content": "E97EFEEBCAD647CCAAF4F123E889BC4E" }