Products
GET

Rank suppliers by product specialization

1 per 10 records

Find overseas suppliers most relevant to a product keyword (relevance / specialization ranking).

Parameters#

Path parameters

  • productstringrequired

Query parameters

  • page_sizenumberoptionaldefault 10

    Number of returned results

  • offsetnumberoptionaldefault 0

    Results starting position

  • countriesstringoptional

    Comma-separated list of supplier countries

  • exclude_countriesstringoptional

    Comma-separated list of supplier countries to exclude

  • fieldsstringoptional

    Comma-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 with exclude. Omit for the full record.

  • excludestringoptional

    Comma-separated list of fields to drop from each returned record, e.g. containers,shipping_rate. Every other field is kept. Cannot be combined with fields. Omit for the full record.

  • formatstringoptionaldefault json

    Response encoding. Defaults to json. Pass toon to 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.

Response shape
{
  "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 records
  • requestCostData credits used for this call (0 if none)
  • creditsRemainingYour data credit balance after the call
  • executionTimeHow long the request took

Fields on each item in data#

FieldExample
13 fields
  • supplier_namestringGrand Step Hk
  • matching_shipmentsnumber2664

    How many of this supplier's shipments matched the product you searched.

  • specializationnumber89.04
  • supplier_country_codestringCN
  • supplier_addressstringFlat/Rm 807 8/F Harbour Crystal 100 Granville Road Tsim Sha Tsui
  • supplier_total_shipmentsnumber2992
  • supplier_experiencenumber3.3
  • product_descriptionstring[]["Ladies Shoes", "Shoes", "Department Store Merch Ladies Shoes Solid Wood"]
  • customer_companiesstring[]["Mia Shoes", "Torrid Merchandising", "Volar Fashion"]
  • total_customersnumber30
  • weightnumber18465831

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.