Rank suppliers by product specialization
Find overseas suppliers most relevant to a product keyword (relevance / specialization ranking).
Parameters#
Path parameters
productstringrequired
Query parameters
page_sizenumberoptionaldefault10Number of returned results
offsetnumberoptionaldefault0Results starting position
countriesstringoptionalComma-separated list of supplier countries
exclude_countriesstringoptionalComma-separated list of supplier countries to exclude
fieldsstringoptionalComma-separated list of fields to keep on each returned record, e.g.
bol_number,arrival_date,supplier_name. Everything else is omitted. Names that the record does not carry are ignored. The envelope (requestCost,creditsRemaining,executionTime,totalCount) is always returned in full. Cannot be combined withexclude. Omit for the full record.excludestringoptionalComma-separated list of fields to drop from each returned record, e.g.
containers,shipping_rate. Every other field is kept. Cannot be combined withfields. Omit for the full record.formatstringoptionaldefaultjsonResponse encoding. Defaults to
json. Passtoonto receive TOON — the same data in a compact, token-efficient text form intended for LLM prompts. Error responses are always JSON.one ofjsontoon
fields, exclude, and format work the same way on every endpoint — Response shaping has worked examples.
Response#
A ranked list of overseas suppliers most relevant to that product keyword.
{
"requestCost": 1,
"creditsRemaining": 9998.5,
"data": [
{
"supplier_link": "/supplier/grand-step-hk",
"supplier_name": "Grand Step Hk",
"matching_shipments": 2664,
"specialization": 89.04,
"supplier_country_code": "CN",
"supplier_address": "Flat/Rm 807 8/F Harbour Crystal 100 Granville Road Tsim Sha Tsui",
"supplier_total_shipments": 2992,
"supplier_experience": 3.3
// …5 more fields
}
],
"executionTime": "224ms"
}Top-level fields#
data— an array of matching recordsrequestCost— Data credits used for this call (0 if none)creditsRemaining— Your data credit balance after the callexecutionTime— How long the request took
Fields on each item in data#
supplier_linkstring/supplier/grand-step-hksupplier_namestringGrand Step Hkmatching_shipmentsnumber2664How many of this supplier's shipments matched the product you searched.
specializationnumber89.04supplier_country_codestringCNsupplier_addressstringFlat/Rm 807 8/F Harbour Crystal 100 Granville Road Tsim Sha Tsuisupplier_total_shipmentsnumber2992supplier_experiencenumber3.3product_descriptionstring[]["Ladies Shoes", "Shoes", "Department Store Merch Ladies Shoes Solid Wood"]customer_companiesstring[]["Mia Shoes", "Torrid Merchandising", "Volar Fashion"]total_customersnumber30weightnumber18465831
Errors#
Failures come back as JSON with a statusCode and message. The ones worth handling here are 401 (bad or missing key), 403 (out of credits), and 404 (no such record). See all error responses.