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

Parameter

v1.0.0

Get all product families

Request

Query Parameters

Name	Type	Location	Required	Description
refresh	string	query	No	Send false when using server cache is fine

Responses

200

Expected data returned

Content-Type: application/json

message

string

Field	Type	Description
message	string

content

array<object>

Field	Type	Description
id	string
categoryName	string
categoryId	string
name	string

{
  "message": null,
  "content": [
    {
      "id": "bigCat8_s6",
      "categoryName": null,
      "categoryId": "bigCat8",
      "name": "Plastic food containers"
    },
    {
      "id": "bigCat6_s7",
      "categoryName": null,
      "categoryId": "bigCat6",
      "name": "Home textile "
    }
  ]
}

404

Error message returned

Content-Type: application/json

GET

/parameter/v2/product-families

Request samples

application/json

{}

Response samples

application/json

{ "message": null, "content": [ { "id": "bigCat8_s6", "categoryName": null, "categoryId": "bigCat8", "name": "Plastic food containers" }, { "id": "bigCat6_s7", "categoryName": null, "categoryId": "bigCat6", "name": "Home textile " } ] }