ImportYeti
PowerQuery
GET

Rank Mexico import suppliers

1 per 10 records

Aggregate Mexico import declarations into a ranked list of foreign suppliers.

Parameters#

Query parameters

28 parameters
  • page_sizenumberoptionaldefault 10

    Number of returned results

  • offsetnumberoptionaldefault 0

    Results starting position

  • start_datestringoptionaldefault 01/01/2021
  • end_datestringoptionaldefault 08/31/2026
  • pagenumberoptional

    Page number (1-indexed). Takes precedence over offset.

  • company_namestringoptional
  • supplier_namestringoptional
  • product_descriptionstringoptional

    Supports boolean operators and wildcards

    AND / OR / NOTwildcards * ?
  • weightstringoptional

    Supports ranges

    ranges [a TO b]
  • company_total_shipmentsstringoptional

    Supports ranges

    ranges [a TO b]
  • supplier_total_shipmentsstringoptional

    Supports ranges

    ranges [a TO b]
  • who_pays_freightstringoptionaldefault Foreign entity

    Foreign entity / Mexico entity

    one ofForeign entityMexico entity

fields, exclude, and format work the same way on every endpoint — Response shaping has worked examples.

Response#

A volume-ranked list of foreign suppliers on Mexico import declarations.

Response shape
{
  "requestCost": 1,
  "creditsRemaining": 9998.5,
  "data": {
    "data": [
      {
        "supplier_name": "Arconic Global Rolled Products Alumax Mill Products",
        "total_shipments": 12589,
        "name_variations": ["Arconic Global Rolled Products Alumax Mill Products, Inc"],
        "supplier_country_code": "MX",
        "supplier_country": "Mexico",
        "customs_offices": ["170 - Matamoros, Tamaulipas", "521 - Aeropuerto Internacional General Mariano Escobedo, Apodaca, Nuevo Leon"],
        "product_descriptions": ["Rollo Aluminio", "Rollo Aluminio Aleado", "Laminas Aluminio"],
        "incoterms": ["DAP", "DDP", "DPU"]
        // …2 more fields
      }
    ],
    "totalSuppliers": 59583
  },
  "executionTime": "224ms"
}

Rows are nested one level deeper

PowerQuery routes put the records at data.data — not at data. The total number of matches is on data.totalSuppliers, which is the value you page against. Note that this key is named per route family (totalCount, totalCompanies, totalSuppliers, totalBrokers).

Top-level fields#

  • data — an object holding the result rows (data.data) and the match total (data.totalSuppliers)
  • requestCost — Data credits used for this call (0 if none)
  • creditsRemaining — Your data credit balance after the call
  • executionTime — How long the request took
  • totalSuppliers — Total matching suppliers, not just this page

Fields on each row in data.data#

FieldExample
10 fields
  • supplier_namestringArconic Global Rolled Products Alumax Mill Products
  • total_shipmentsnumber12589

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

  • name_variationsstring[]["Arconic Global Rolled Products Alumax Mill Products, Inc"]
  • supplier_country_codestringMX
  • supplier_countrystringMexico
  • customs_officesstring[]["170 - Matamoros, Tamaulipas", "521 - Aeropuerto Internacional General Mariano Escobedo, Apodaca, Nuevo Leon"]
  • product_descriptionsstring[]["Rollo Aluminio", "Rollo Aluminio Aleado", "Laminas Aluminio"]
  • incotermsstring[]["DAP", "DDP", "DPU"]
  • transport_typesstring[]["Undeclared", "Truck", "Sea"]
  • hs_codesstring[]["761699", "760200", "761610"]

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.