QIMA Logo
API Reference

8 categories • 44 endpoints

  • All APIs

    44

    • Quick Actions
    Getting StartedDocumentation
    Lab Testing
    v1.0.0

    Update a lab testing order

    Request
    Query Parameters
    NameTypeLocationRequiredDescription
    orderIdstringpathYesLT order id
    Request Body

    Content-Type: application/json

    Order update information

    FieldTypeRequiredDescription
    generalInformationobjectNo
    generalInformation.bookingRefNostringYes
    Product reference number
    generalInformation.submissionTypestringYes
    Submission type
    generalInformation.requestTurnAroundTimestringNo
    Request turn around time
    generalInformation.accreditationRequiredstringNo
    Accreditation required
    generalInformation.descriptionstringNo
    Description
    generalInformation.supplierIdstringNo
    Supplier ID
    generalInformation.officeIdstringNo
    Office ID
    generalInformation.programIdstringNo
    Program ID
    productobjectNo
    Product booking details for standard API
    product.productNamestringYes
    Product name
    product.purchaseOrderNostringNo
    Client purchase order number
    product.skustringNo
    Product SKU
    product.materialsstringNo
    Product model number
    product.ageGradestringNo
    Age grade
    product.distributionRegionsarrayNo
    Distribution regions
    product.distributionCountriesarrayNo
    Distribution countries
    product.originCountriesarrayNo
    Origin countries
    product.manufacturerFactoryNamestringNo
    Manufacturer factory name
    product.agencyNamestringNo
    Agency name
    product.buyerNamestringNo
    Buyer name
    product.shipmentDatestringNo
    Shipment date
    additionalRecipientsobjectNo
    additionalRecipients.reportEmailTostringNo
    Report email to
    additionalRecipients.reportEmailCCstringNo
    Report email cc
    additionalRecipients.invoiceEmailTostringNo
    Invoice email to
    additionalRecipients.invoiceEmailCCstringNo
    Invoice email cc
    additionalRecipients.quotationEmailTostringNo
    Quotation email to
    additionalRecipients.quotationEmailCCstringNo
    Quotation email cc
    customFieldsarrayNo
    Custom fields
    customFields[].modulestringNo
    Module
    customFields[].labelstringNo
    Label
    customFields[].valuestringNo
    Value
    Responses
    200
    Lab testing order updated successfully. Returns the updated order details.

    Content-Type: application/json

    generalInformation
    object
    FieldTypeDescription
    orderIdstringOrder ID
    qimaRefNostringLab order number
    bookingRefNostringProduct reference number
    testDatestringTest start date
    reportDatestringReport due date
    statusstringOrder status
    clientstringCompany name
    clientIdstringCompany ID
    supplierstringSupplier name
    supplierIdstringSupplier ID
    submitterstringSubmitter
    submitterIdstringSubmitter ID
    programstringProgram
    programIdstringProgram ID
    FieldTypeDescription
    productNamestringProduct name
    purchaseOrderNostringClient purchase order number
    skustringProduct SKU
    materialsstringProduct model number
    ageGradestringAge grade
    programstringProgram
    programIdstringProgram ID
    distributionRegionsarrayDistribution regions
    distributionCountriesarrayDistribution countries
    originCountriesarrayOrigin countries
    manufacturerFactoryNamestringManufacturer factory name
    agencyNamestringAgency name
    buyerNamestringBuyer name
    shipmentDatestringShipment date
    bookingRemarkstringBooking remark
    FieldTypeDescription
    testIdstringTest id
    clientTestIdstringTest id in client system
    testNamestringTest name
    testResultstringTest result
    FieldTypeDescription
    modulestringModule
    labelstringLabel
    valuestringValue
    FieldTypeDescription
    methodstringMethod
    carrierstringCarrier
    trackingNostringTracking number
    remarksstringRemarks
    inspectionOrderReferencestringInspection order reference
    FieldTypeDescription
    reportEmailTostringReport email to
    reportEmailCCstringReport email cc
    invoiceEmailTostringInvoice email to
    invoiceEmailCCstringInvoice email cc
    quotationEmailTostringQuotation email to
    quotationEmailCCstringQuotation email cc
    FieldTypeDescription
    labelstringLabel
    subLabelstringSub label
    fileNamestringFile name
    descriptionstringDescription
    urlstringUrl
    createdDatestringCreated date
    PUT
    /v1.2/lt/orders/{orderId}
    Request samples

    application/json

    { "generalInformation": { "bookingRefNo": "BK-2024-001500", "submissionType": "Testing", "requestTurnAroundTime": "3 days", "accreditationRequired": "Yes", "description": "New product testing order for children's toy", "supplierId": "SUP-67890", "officeId": "OFF-001", "programId": "PROG-001" }, "product": { "productName": "Children's Toy", "purchaseOrderNo": "PO123456", "sku": "SKU123456", "materials": "ModelX", "ageGrade": "3+", "distributionRegions": "['China', 'Japan']", "distributionCountries": "['Japan', 'United States']", "originCountries": "['China']", "manufacturerFactoryName": "ManufacturerX", "agencyName": "AgencyX", "buyerName": "BuyerX", "shipmentDate": "2025-01-01" }, "additionalRecipients": { "reportEmailTo": "reports@example.com", "reportEmailCC": "manager@example.com", "invoiceEmailTo": "finance@example.com", "invoiceEmailCC": "accounting@example.com", "quotationEmailTo": "sales@example.com", "quotationEmailCC": "sales-manager@example.com" }, "customFields": [ { "module": "string", "label": "string", "value": "string" } ] }
    Response samples

    application/json

    { "generalInformation": { "orderId": "string", "qimaRefNo": "string", "bookingRefNo": "string", "testDate": "string", "reportDate": "string", "status": "string", "client": "string", "clientId": "string", "supplier": "string", "supplierId": "string", "submitter": "string", "submitterId": "string", "program": "string", "programId": "string" }, "product": { "productName": "Children's Toy", "purchaseOrderNo": "PO123456", "sku": "SKU123456", "materials": "ModelX", "ageGrade": "1-3", "program": "ProgramX", "programId": "123456", "distributionRegions": "['US', 'CA']", "distributionCountries": "['US', 'CA']", "originCountries": "['US', 'CA']", "manufacturerFactoryName": "ManufacturerX", "agencyName": "AgencyX", "buyerName": "BuyerX", "shipmentDate": "2025-01-01", "bookingRemark": "Booking remark" }, "tests": [ { "testId": "string", "clientTestId": "string", "testName": "string", "testResult": "string" } ], "customFields": [ { "module": "string", "label": "string", "value": "string" } ], "sampleCollection": [ { "method": "string", "carrier": "string", "trackingNo": "string", "remarks": "string", "inspectionOrderReference": "string" } ], "additionalRecipients": { "reportEmailTo": "reports@example.com", "reportEmailCC": "manager@example.com", "invoiceEmailTo": "finance@example.com", "invoiceEmailCC": "accounting@example.com", "quotationEmailTo": "sales@example.com", "quotationEmailCC": "sales-manager@example.com" }, "attachments": [ { "label": "string", "subLabel": "string", "fileName": "string", "description": "string", "url": "string", "createdDate": "string" } ] }