API Reference

8 categories • 44 endpoints

44

Audit
3

Search audit reports

/user/{userId}/audit-reports

Create an audit order

Get audit report details

/user/{userId}/audit-reports/{reportId}

Authentication
3

Get token

Refresh token

Revoke authentication token

File
2

Upload file

/user/{userId}/doc-type/{docType}/source/{sourceId}/file

Download a file by ID

/user/{userId}/file/{fileId}

Inspection
6

Get inspection order details

/user/{userId}/inspection-order/{orderId}

Search inspection booking orders

/user/{userId}/inspection-orders

Cancel an inspection booking

/user/{userId}/inspection/{orderId}

Create an inspection booking

/v1.0/inspection

Create inspection booking asynchronously

/v1.0/async-inspection

Get async booking result by request ID

/booking-result/{requestId}

Lab Testing
8

Confirm a lab testing booking order

/v1.1/lt/booking/order/confirm

Confirm a lab testing inquiry order

/v1.1/lt/inquiry/order/confirm

Search lab testing orders

/v1.2/lt/orders

Create a lab testing order

/v1.2/lt/orders

Get lab testing order details

/v1.2/lt/orders/{orderId}

Update a lab testing order

/v1.2/lt/orders/{orderId}

Upload attachments to a lab testing order

/v1.2/lt/orders/{orderId}/attachments

Get lab testing order test results

/v1.2/lt/order-results/{orderId}

Parameter
13

Get countries by continent

/parameter/v2/continent/{continentId}/countries

Get all continents

/parameter/v2/continents

Get all countries

/parameter/v2/countries

Get cities by country

/parameter/v2/country/{countryId}/cities

Get provinces by country

/parameter/v2/country/{countryId}/provinces

Search cities in a country by name

/parameter/v2/country/{countryId}/searchCities

Get all product categories

/parameter/v2/product-categories

Get all product families

/parameter/v2/product-families

Get full product taxonomy tree

/parameter/v2/product-tree

Get all product types

/parameter/v2/product-types

Search cities in a province by name

/parameter/v2/province/{provinceId}/searchCities

Get the lists of available sample levels

/parameter/v2/sample-levels

Search countries by name

/parameter/v2/searchCountries

Report
3

Get inspection PDF report file info

/user/{userId}/report/{productId}/pdf-info

Search inspection reports

/user/{userId}/reports

Get inspection interactive report details

/user/{userId}/interactive-report/{productId}

Supplier
6

Confirm inspection date and factory

/order/v2/{orderId}/factory

Create a new supplier

/user/v2/{userId}/supplier

Get supplier details

/user/v2/{userId}/supplier/{supplierId}

Update a supplier

/user/v2/{userId}/supplier/{supplierId}

Search suppliers

/user/v2/{userId}/suppliers

Delete one or more suppliers

/user/v2/{userId}/suppliers/{supplierIds}

Quick Actions

Getting Started Documentation

Lab Testing

v1.0.0

Upload attachments to a lab testing order

Request

Query Parameters

Name	Type	Location	Required	Description
orderId	string	path	Yes	LT order id
Idempotency-Key	string	header	Yes	Unique key to prevent duplicate upload requests.
files	array	formData	Yes	One or more files to upload.
sourceId	string	query	No	Source id passed to AIMS. Defaults to the order ID if not provided.
fileLabel	string	query	No	Attachment label. Defaults to "Client Document for Review" if not provided.
fileDescription	string	query	No	Optional description for the uploaded attachment(s).

Responses

200

Attachments uploaded successfully. Returns upload result details for each file.

Content-Type: application/json

400

Bad request — orderId, files, or Idempotency-Key header is missing.

Content-Type: application/json

403

Forbidden — invalid LT order or the user has no access.

Content-Type: application/json

409

Conflict — duplicate request is already being processed.

Content-Type: application/json

500

Internal server error.

Content-Type: application/json

POST

/v1.2/lt/orders/{orderId}/attachments

Request samples

application/json

{}

Response samples

application/json

[ { "id": "string", "label": "string", "fileName": "string", "fileSize": 1, "description": "string", "fileHashcode": "string", "sourceId": "string", "status": "string", "message": "string", "createTime": "string", "updateTime": "string", "createdBy": "string", "updatedBy": "string" } ]