ImportYeti
Suppliers
GET

Get an overseas supplier profile by slug

1 per record

Return the full profile for an overseas supplier using its URL slug. Resolve names via supplier search first.

Related:Profile an overseas supplier

Parameters#

Path parameters

  • supplierstringrequired

    ImportYeti supplier URL slug — the hyphenated segment from the website path /supplier/... (e.g. yiwu-yida-import-and-export-co-ltd), not the supplier display or legal name. To resolve a name to a slug, use GET /supplier/search. Slugs use lowercase letters, digits, and hyphens; letter casing in this parameter is normalized. Underscores are accepted in place of hyphens.

Query parameters

  • 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#

The full overseas supplier profile — names, shipment volume, contacts, and US buyers they ship to.

Response shape
{
  "requestCost": 1,
  "creditsRemaining": 9998.5,
  "data": {
    "title": "Damco India",
    "also_known_names": ["Damco India Private Limited", "Damco India Private Ltd"],
    "address": "International Financial Center Tower 2 40-41 Fl Jl Jend Sudirman Kav 22-23 Jakarta 12920 Indonesia",
    "address_country": "Indonesia",
    "address_country_code": "ID",
    "website": "jalandhar.144004.india",
    "other_websites": [{"website": "huda.part-1.plot", "frequency": 2}],
    "phone_number": "015427834073000"
    // …16 more fields
  },
  "executionTime": "224ms"
}

Top-level fields#

  • data — the result object for this endpoint
  • requestCost — Data credits used for this call (0 if none)
  • creditsRemaining — Your data credit balance after the call
  • executionTime — How long the request took

Fields in data#

FieldExample
24 fields
  • titlestringDamco India
  • also_known_namesstring[]["Damco India Private Limited", "Damco India Private Ltd"]
  • addressstringInternational Financial Center Tower 2 40-41 Fl Jl Jend Sudirman Kav 22-23 Jakarta 12920 Indonesia
  • address_countrystringIndonesia
  • address_country_codestringID
  • websitestringjalandhar.144004.india
  • [{"website": "huda.part-1.plot", "frequency": 2}]

    website, frequency

  • phone_numberstring015427834073000
  • total_shipmentsnumber79574

    The company's total shipments on record, independent of the filters in this query.

  • countrystringIndia
  • country_codestringIN
  • carriers_per_countryobject

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.