Introduction

Welcome to supplier.io APIs! Here you’ll find comprehensive information for integrating with our API endpoints. We’ve tried to make this documentation user-friendly and example-filled, but if you have any questions, please contact your account representative. The fastest way to get your integration up and running is to use our quickstart guide, which walks through your entire integration step-by-step. You’ll integrate API into your site or app and use it to retrieve the data you need from our database.

Overview

API keys and access

To gain access to the supplier.io API, please request an account key from your account representative. Once you’ve received the signup process and acknowledged our terms, we’ll provide a live customerID, secret, and public_key.

API protocols

The API uses GET and POST requests to communicate and HTTP response codes to indicate status and errors. All responses come in standard JSON. The API is served over HTTPS TLS v1.2+ to ensure data privacy; HTTP and HTTPS with TLS versions below 1.2 are not supported. All requests must include a Content-Type of application/json and the body must be valid JSON.

API host

https://api.supplierio.com/supplier (Development)
https://api.supplier.io/supplier (Production)


The Sandbox and Development environments are unrestricted and support only test Items. All testing should be done in our Sandbox and Development environments. All activities in the Production environment will be billed. When you’re getting ready to launch into Production, please request Production API access.

Endpoints

Search
/GetSearchDetail
/GetMatch
/GetMatchWithQuality
/GetBestMatch
/SubmitMatch
/GetMatchResults


Suppliers
/GetSupplierDetail
/GetSuppliers

Storing supplier.io API identifiers

It’s important to properly handle supplier.io identifiers returned by the API endpoints. supplier.io identifiers let you associate API and supplier details with your requests, and will help our Support team resolve your issues faster and more accurately. Here are some best practices for handling our API identifiers.

supplier_id

supplier_ids are the core identifiers that map to records in the supplier.io database. You should persist them in your application storage. Note, however, that supplier_ids are frequently retired and replaced with new supplier_ids. The response always returns the latest supplier_id. If it has changed from your original request, you should update it in your application storage.

customerID

If you are using the API across multiple clients, the customerID identifies the client for each request.

Breaking changes

We strive to avoid making any breaking changes to our API, but we do make changes over time that may result in changes to the data that you pull from supplier.io.

We consider the following changes to be backward compatible:

  • Adding new API endpoints
  • Adding new options parameters to existing endpoints
  • Adding new data elements to existing response schemas
  • Adding new error_types and error_codes
  • Adding new webhook_types and webhook_codes
  • Changing the length or content of any API identifier

Search


The API supports two types of searches:

  • Database Search: Search requests run a query against the database based on the provided search parameters and filters.
  • Matches: Match requests attempt to identify a specific supplier based on the provided criteria.

GetSearchDetail

This method returns the result of search against supplier.io database.

Input
Field Required Description Default Value
APIKEY Yes Used for API authentication.
customerID Yes Assigned Customer ID. Used to validate customer's access to the API.
  • If access is no longer valid, the API returns an error of “Expired Contract.”
  • If customer id is not known, the API returns error of “Invalid Customer ID.”
customerName Yes Assigned Customer Name
searchQuery No Accepts string as a keyword search. *
startRecord No The start record number for search results. 0
rowCount No Number of records need to fetch and it is used with startRecord parameter. 10
organizationName No Filter Results by Supplier Name.
location No Geocodes to limits search by location. Format: longitude, latitude
locationDistance No Distance from entered location to limit search results. Used with location. Field is ignored if location parameter is blank. 25
locationUnit No Distance Unit(in miles or kilometer). Used with location. Field is ignored if location parameter is blank. miles
state No Filter Results by State
country No Filter Results by Country(ISO 3166-1 alpha-3 country code) USA
naicsCode No Filter Results by 6-digit NAICS Code(s)
sicCode No Filter Results by 4-digit SIC Code(s)
diversityClassification No Filter Results by Diversity Classification. Values:
  • MBE
  • WBE
  • SDB
  • DBE
  • 8A
  • HUBZONE
  • SDVET
  • VET
  • DISABLED
  • SBE
  • LGBT
  • HBCU
  • ABILITYONE
  • ANC
  • SC-SDB
  • WOSB
  • EDWOSB
  • ACDBE
  • EDGE
  • Aboriginal
    		•
    ethnicity No Filter Results by Ethnicity. Values (format may change):
  • AFRICAN AMERICAN
  • HISPANIC AMERICAN
  • ASIAN AMERICAN
  • NATIVE AMERICAN
  • ASIAN PACIFIC AMERICAN
  • ASIAN SUBCONTINENT AMERICAN
    		•
    employee No Filter Results by Number of Employees. Values (format may change):
  • 1-10
  • 11-50
  • 51-200
  • 201-500
  • 501-1,000
  • 1,001-5,000
  • 5,001-10,000
  • 10,000+
    		•
    revenue No Filter Results by Company Revenues. Values (format may change):
  • Less than $500K
  • $500K-1M
  • $1M-10M
  • $10M-50M
  • $50M-$100M
  • $100M-500M
  • $500M-1B
  • $1B-10B
  • $10B-50B
  • $50B+
    		•
    Using Filters
    • Multiple filters may be used simultaneously and each filter can accept multiple values.
    • If multiple filter fields are used, an AND operator is applied across all the filters.
    • If multiple values are used for a filter, an OR operator is applied across all the values.
    • Multiple values for a filter must be separated using a vertical bar (|).
    Examples:
    • Multiple Filters with single values: State=IL&Employee=1-10
    • Multiple Filters with multiple values: State=IL|NJ&Employee=1-10
    Results Example
    {  
   "results":{  
      "Error":null,
      "SearchQuery":"*",
      "startRecord":"0",
      "rowCount":"10",
      "TotalRecords":"5000+",
      "Results":[  
         {  
            "SupplierID":"100001530",
            "SupplierName":"VILLAGES APARTMENTS, THE",
            "Address":"1100 N 6TH ST OFC",
            "City":"WACO",
            "State":"TX",
            "Zip":"76707",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001531",
            "SupplierName":"SPRING CITY ELECTRICAL MANUFACTURING CO",
            "Address":"1 S MAIN ST",
            "City":"SPRING CITY",
            "State":"PA",
            "Zip":"19475",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001532",
            "SupplierName":"PIONEER BUILDING MATERIALS INC",
            "Address":"321 DENTON AVE",
            "City":"NEW HYDE PARK",
            "State":"NY",
            "Zip":"11040",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001533",
            "SupplierName":"FLUID MECHANISMS OF HAUPPAUGE INC",
            "Address":"225 ENGINEERS RD",
            "City":"HAUPPAUGE",
            "State":"NY",
            "Zip":"11788",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001534",
            "SupplierName":"ART PRECISION METAL PRODUCTS INC",
            "Address":"1465 STRONG AVE S",
            "City":"COPIAGUE",
            "State":"NY",
            "Zip":"11726",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001538",
            "SupplierName":"ROSENBERG HOUSING GROUP INC",
            "Address":"125 E 23RD ST",
            "City":"NEW YORK",
            "State":"NY",
            "Zip":"10010",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001539",
            "SupplierName":"STEFAN SYDOR OPTICS INC",
            "Address":"31 JET VW DR",
            "City":"ROCHESTER",
            "State":"NY",
            "Zip":"14624",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001540",
            "SupplierName":"BUDSGUNSHOP.COM LLC",
            "Address":"1105 INDUSTRY RD",
            "City":"LEXINGTON",
            "State":"KY",
            "Zip":"40505",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001541",
            "SupplierName":"TEDCO INDUSTRIES INC",
            "Address":"4730 HOLLINS FRY RD",
            "City":"HALETHORPE",
            "State":"MD",
            "Zip":"21227",
            "Country":"USA"
         },
         {  
            "SupplierID":"100001542",
            "SupplierName":"ALMAG PLATING CORP",
            "Address":"1800 CHERRY HL RD",
            "City":"BALTIMORE",
            "State":"MD",
            "Zip":"21230",
            "Country":"USA"
         }
      ],
      "Facets":{  
         "State":[  
            {  
               "Value":"CA",
               "count":"5000+"
            },
            {  
               "Value":"VA",
               "count":"5000+"
            },
            {  
               "Value":"TX",
               "count":"5000+"
            },
            {  
               "Value":"FL",
               "count":"5000+"
            },
            {  
               "Value":"NY",
               "count":"5000+"
            },
            {  
               "Value":"MD",
               "count":"5000+"
            },
            {  
               "Value":"PA",
               "count":"5000+"
            },
            {  
               "Value":"IL",
               "count":"5000+"
            },
            {  
               "Value":"NJ",
               "count":"5000+"
            },
            {  
               "Value":"GA",
               "count":"5000+"
            }
         ],
         "NAICS":[  
            {  
               "Value":"541330",
               "count":"5000+"
            },
            {  
               "Value":"541511",
               "count":"5000+"
            },
            {  
               "Value":"541512",
               "count":"5000+"
            },
            {  
               "Value":"236220",
               "count":"5000+"
            },
            {  
               "Value":"541611",
               "count":"5000+"
            },
            {  
               "Value":"541519",
               "count":"5000+"
            },
            {  
               "Value":"541690",
               "count":"5000+"
            },
            {  
               "Value":"238210",
               "count":"5000+"
            },
            {  
               "Value":"236210",
               "count":"5000+"
            },
            {  
               "Value":"541990",
               "count":"5000+"
            }
         ],
         "SIC":[  
            {  
               "Value":"7389",
               "count":"5000+"
            },
            {  
               "Value":"8742",
               "count":"5000+"
            },
            {  
               "Value":"1531",
               "count":"5000+"
            },
            {  
               "Value":"8748",
               "count":"5000+"
            },
            {  
               "Value":"8711",
               "count":"5000+"
            },
            {  
               "Value":"7371",
               "count":"5000+"
            },
            {  
               "Value":"7373",
               "count":"5000+"
            },
            {  
               "Value":"1799",
               "count":"5000+"
            },
            {  
               "Value":"6531",
               "count":"5000+"
            },
            {  
               "Value":"8299",
               "count":"5000+"
            }
         ],
         "Revenue":[  
            {  
               "Value":"Less than $500K",
               "count":"5000+"
            },
            {  
               "Value":"$1M-10M",
               "count":"5000+"
            },
            {  
               "Value":"$500K-1M",
               "count":"5000+"
            },
            {  
               "Value":"$10M-50M",
               "count":"5000+"
            },
            {  
               "Value":"$50M-$100M",
               "count":"1410"
            },
            {  
               "Value":"$100M-500M",
               "count":"868"
            },
            {  
               "Value":"$1B-10B",
               "count":"114"
            },
            {  
               "Value":"$500M-1B",
               "count":"100"
            },
            {  
               "Value":"$10B-50B",
               "count":"8"
            }
         ],
         "Employees":[  
            {  
               "Value":"1-10",
               "count":"5000+"
            },
            {  
               "Value":"11-50",
               "count":"5000+"
            },
            {  
               "Value":"51-200",
               "count":"5000+"
            },
            {  
               "Value":"201-500",
               "count":"2044"
            },
            {  
               "Value":"501-1,000",
               "count":"257"
            },
            {  
               "Value":"1,001-5,000",
               "count":"116"
            },
            {  
               "Value":"5,001-10,000",
               "count":"3"
            },
            {  
               "Value":"10,000+",
               "count":"2"
            }
         ],
         "DiversityCategory":[  
            {  
               "Value":"SMALL",
               "count":"5000+"
            },
            {  
               "Value":"MINORITY-OWNED",
               "count":"5000+"
            },
            {  
               "Value":"WOMEN-OWNED",
               "count":"5000+"
            },
            {  
               "Value":"VETERAN-OWNED",
               "count":"5000+"
            },
            {  
               "Value":"SELF CERTIFIED SDB",
               "count":"5000+"
            },
            {  
               "Value":"WOMEN-OWNED SMALL",
               "count":"5000+"
            },
            {  
               "Value":"DISADVANTAGED BUSINESS",
               "count":"5000+"
            },
            {  
               "Value":"SERVICE-DISABLED VETERAN-OWNED",
               "count":"5000+"
            },
            {  
               "Value":"ECONOMICALLY DISADVANTAGED WOSB",
               "count":"5000+"
            },
            {  
               "Value":"8(A) PROGRAM",
               "count":"5000+"
            }
         ],
         "Ethnicity":[  
            {  
               "Value":"AFRICAN AMERICAN",
               "count":"5000+"
            },
            {  
               "Value":"HISPANIC AMERICAN",
               "count":"5000+"
            },
            {  
               "Value":"ASIAN AMERICAN",
               "count":"5000+"
            },
            {  
               "Value":"ASIAN PACIFIC AMERICAN",
               "count":"5000+"
            },
            {  
               "Value":"NATIVE AMERICAN",
               "count":"5000+"
            },
            {  
               "Value":"ASIAN SUBCONTINENT AMERICAN",
               "count":"5000+"
            }
         ]
      }
   }
}
    Try it
    Query
    API result

    GetMatch

    This method returns a list of potential matches. All matches are considered High or Medium quality matches (see definitions). Each search may return multiple match results.

    Input
    Field Required Description Default Value
    APIKEY Yes Used for API authentication.
    customerID Yes Assigned Customer ID. Used to validate customer's access to the API.
    • If access is no longer valid, the API returns an error of “Expired Contract.”
    • If customer id is not known, the API returns error of “Invalid Customer ID.”
    customerName Yes Assigned Customer Name
    supplierName Yes Supplier name or doing business as name. Examples:
    • "ABC Company"
    • "John Smith International Systems"
    If a supplier has multiple names, provide only one name in each search. Avoid concatenating multiple names. The following are examples of company names that will reduce probability of matches :
    • "ABC Company doing business as ABC Co"
    • "John Smith International Systems dba JSI Systems"
    For suppliers with multiple names, consider conducting multiple searches with each name separately if a match with is not found with the primary name.
    address Yes Supplier's address. Where possible, provide physical addresses instead of P.O. Box addresses. Examples:
    • "5600 N Main Street"
    • "101 Second Street Ste 100"
    city Yes City associated with the address. Examples:
    • "Chicago"
    • "Los Alamos"
    state Yes State associated with the address. Provide the two letter State code if country is USA/CAN. Examples:
    • Good(USA): "CA"
    • Bad(USA):"California"
    • Good(GBR):"London"
    country No Country associated with the address(ISO 3166-1 alpha-3 country code). Examples:
    • "USA"
    • "CAN"
    		USA
    Results Example
    {
  "results": {
    "Error": null,
    "Suppliers": [
      {
        "Name": "MAYS CHEMICAL CO.",
        "Address": "5611 e 71st st",
        "City": "indianapolis",
        "State": "in",
        "SupplierId": "102267873",
        "Diversity": MINORITY-OWNED
      },
      {
        "Name": "MAYS CHEMICAL CO.",
        "Address": "5611 e 71st st",
        "City": "indianapolis",
        "State": "in",
        "SupplierId": "102267892",
        "Diversity": WOMEN-OWNED
      },
      {
        "Name": "MAYS CHEMICAL CO.",
        "Address": "5611 e 71st st",
        "City": "indianapolis",
        "State": "in",
        "SupplierId": "102267902",
        "Diversity": [
          "MINORITY-OWNED"
        ]
      }
    ]
  }
}
    Try it
    Query
    API result

    GetMatchWithQuality

    This method returns a list of potential matches with match quality equal or greater than the specified quality. Each search may return multiple match results.

    Input
    Field Required Description Default Value
    APIKEY Yes Used for API authentication.
    customerID Yes Assigned Customer ID. Used to validate customer's access to the API.
    • If access is no longer valid, the API returns an error of “Expired Contract.”
    • If customer id is not known, the API returns error of “Invalid Customer ID.”
    customerName Yes Assigned Customer Name
    supplierName Yes Supplier name or doing business as name. Examples:
    • "ABC Company"
    • "John Smith International Systems"
    If a supplier has multiple names, provide only one name in each search. Avoid concatenating multiple names. The following are examples that will reduce probability of matches :
    • "ABC Company doing business as ABC Co"
    • "John Smith International Systems dba JSI Systems"
    For suppliers with multiple names, consider conducting multiple searches with each name separately if a match with is not found with the primary name.
    address Yes Supplier's address. Where possible, provide physical addresses instead of P.O. Box addresses. Currently, the API only supports US addresses. Examples:
    • "5600 N Main Street"
    • "101 Second Street Ste 100"
    city Yes City associated with the address. Examples:
    • "Chicago"
    • "Los Alamos"
    state Yes State associated with the address. Provide the two letter State code if country is USA/CAN. Examples:
    • Good(USA): "CA"
    • Bad(USA):"California"
    • Good(GBR):"London"
    country No Country associated with the address(ISO 3166-1 alpha-3 country code). Examples:
    • "USA"
    • "CAN"
    		USA
    minimumQuality Yes The minimum match quality to include. Valid values for this field are:
    • High
    • Medium
    • Low
    Match Quality definitions:
    • High: These results are considered to be a match to the input and have a very low probability of false positives.
    • Medium: These results are considered to have a high likelihood of being a match to the provided input. These results have less than 20% probability of false positives.
    • Low: These results are considered to have a high probability of false positives. It is recommended that results are manually reviewed before acceptance.
    Results Example
    {
  "results": {
    "Error": null,
    "Suppliers": [
      {
        "Name": "MAYS CHEMICAL CO.",
        "Address": "5611 e 71st st",
        "City": "indianapolis",
        "State": "in",
        "SupplierId": "102267873",
        "Diversity": MINORITY-OWNED
      },
      {
        "Name": "MAYS CHEMICAL CO.",
        "Address": "5611 e 71st st",
        "City": "indianapolis",
        "State": "in",
        "SupplierId": "102267892",
        "Diversity": WOMEN-OWNED
      },
      {
        "Name": "MAYS CHEMICAL CO.",
        "Address": "5611 e 71st st",
        "City": "indianapolis",
        "State": "in",
        "SupplierId": "102267902",
        "Diversity": [
          "MINORITY-OWNED"
        ]
      }
    ]
  }
}
    Try it
    Query
    API result

    GetBestMatch

    This method returns the details of the best matched supplier. Use this call if you do not want to evaluate potential matches and will accept the match provided as it. In case where there are multiple matches of the same quality, any one of the matches will be randomly returned and the results may not be consistent with future calls with the same input.
    Only High quality results are returned.

    Input
    Field Required Description Default Value
    APIKEY Yes Used for API authentication.
    customerID Yes Assigned Customer ID. Used to validate customer's access to the API.
    • If access is no longer valid, the API returns an error of “Expired Contract.”
    • If customer id is not known, the API returns error of “Invalid Customer ID.”
    customerName Yes Assigned Customer Name
    supplierName Yes Supplier name or doing business as name. Examples:
    • "ABC Company"
    • "John Smith International Systems"
    If a supplier has multiple names, provide only one name in each search. Avoid concatenating multiple names. The following are examples that will reduce probability of matches :
    • "ABC Company doing business as ABC Co"
    • "John Smith International Systems dba JSI Systems"
    For suppliers with multiple names, consider conducting multiple searches with each name separately if a match with is not found with the primary name.
    address Yes Supplier's address. Where possible, provide physical addresses instead of P.O. Box addresses. Currently, the API only supports US addresses. Examples:
    • "5600 N Main Street"
    • "101 Second Street Ste 100"
    city Yes City associated with the address. Examples:
    • "Chicago"
    • "Los Alamos"
    state Yes State associated with the address. Provide the two letter State code if country is USA/CAN. Examples:
    • Good(USA): "CA"
    • Bad(USA):"California"
    • Good(GBR):"London"
    country No Country associated with the address(ISO 3166-1 alpha-3 country code). Examples:
    • "USA"
    • "CAN"
    		USA
    Results Example
    {
  "results": {
    "Error": null,
    "Phone": null,
    "Website": "",
    "Established": "1957",
    "Employee": "51-200",
    "Revenue": "less than $500K",
    "ActualRevenue": null,
    "Actualemployees": null,
    "Ethnicity": null,
    "Ownership": [
      "WBE"
    ],
    "SmallBusinessClassifications": [
      "SBE",
      "WOSB"
    ],
    "NAICS": [
      "541690",
      "313210",
      "314999",
      "315190",
      "315210",
      "315220",
      "315280",
      "315990",
      "316210",
      "316998",
      "325212",
      "326199",
      "332420",
      "339113",
      "339115",
      "423390",
      "423450",
      "423490",
      "423840",
      "423850",
      "423990",
      "424320",
      "424340"
    ],
    "NAICSDescription": [
      "OTHER SCIENTIFIC AND TECHNICAL CONSULTING SERVICES",
      "BROADWOVEN FABRIC MILLS",
      "ALL OTHER MISCELLANEOUS TEXTILE PRODUCT MILLS",
      "OTHER APPAREL KNITTING MILLS",
      "CUT AND SEW APPAREL CONTRACTORS",
      "MEN???S AND BOYS??? CUT AND SEW APPAREL MANUFACTURING",
      "OTHER CUT AND SEW APPAREL MANUFACTURING",
      "APPAREL ACCESSORIES AND OTHER APPAREL MANUFACTURING",
      "FOOTWEAR MANUFACTURING",
      "ALL OTHER LEATHER GOOD AND ALLIED PRODUCT MANUFACTURING",
      "SYNTHETIC RUBBER MANUFACTURING",
      "ALL OTHER PLASTICS PRODUCT MANUFACTURING",
      "METAL TANK (HEAVY GAUGE) MANUFACTURING",
      "SURGICAL APPLIANCE AND SUPPLIES MANUFACTURING",
      "OPHTHALMIC GOODS MANUFACTURING",
      "OTHER CONSTRUCTION MATERIAL MERCHANT WHOLESALERS",
      "MEDICAL, DENTAL, AND HOSPITAL EQUIPMENT AND SUPPLIES MERCHANT WHOLESALERS",
      "OTHER PROFESSIONAL EQUIPMENT AND SUPPLIES MERCHANT WHOLESALERS",
      "INDUSTRIAL SUPPLIES MERCHANT WHOLESALERS",
      "SERVICE ESTABLISHMENT EQUIPMENT AND SUPPLIES MERCHANT WHOLESALERS",
      "OTHER MISCELLANEOUS DURABLE GOODS MERCHANT WHOLESALERS",
      "MEN???S AND BOYS??? CLOTHING AND FURNISHINGS MERCHANT WHOLESALERS",
      "FOOTWEAR MERCHANT WHOLESALERS"
    ],
    "SIC": [
      "3821",
      "3851",
      "5039",
      "5047",
      "5087",
      "5099",
      "5136",
      "5139",
      "2329",
      "2389"
    ],
    "AlternateSupplierNames": [
      "ARBILL SAFETY PRODUCTS"
    ],
    "CertificationDetail": [
      {
        "Classification": "WBE",
        "Agency": "SAM - System for Award Management",
        "ExpirationDate": "4/16/2020 12:00:00 AM",
		"CertificateNumber": ""
      },
      {
        "Classification": "WBE",
        "Agency": "State of New York",
        "ExpirationDate": "",
		"CertificateNumber": ""
      },
      {
        "Classification": "WBE",
        "Agency": "City of New York, NY",
        "ExpirationDate": "6/29/2022 12:00:00 AM",
		"CertificateNumber": ""
      },
      {
        "Classification": "SBE",
        "Agency": "SAM - System for Award Management",
        "ExpirationDate": "4/16/2020 12:00:00 AM",
		"CertificateNumber": ""
      },
      {
        "Classification": "WOSB",
        "Agency": "SAM - System for Award Management",
        "ExpirationDate": "4/16/2020 12:00:00 AM",
		"CertificateNumber": ""
      },
      {
        "Classification": "WOSB",
        "Agency": "WBENC",
        "ExpirationDate": "9/22/2018 12:00:00 AM",
		"CertificateNumber": ""
      }
    ],
    "ContactDetail": [
      {
        "Name": "",
        "Email": "",
        "Title": ""
      },
      {
        "Name": "David Gerhardt",
        "Email": "dgerhardt@arbill.com",
        "Title": "Director of Marketing"
      },
      {
        "Name": "HELP DESK",
        "Email": "help@arbill.com",
        "Title": ""
      },
      {
        "Name": "JULIE COPELAND ",
        "Email": "info@arbill.com",
        "Title": ""
      },
      {
        "Name": "JULIE COPELAND",
        "Email": "jcopeland@arbill.com",
        "Title": ""
      },
      {
        "Name": "Julie Copeland ",
        "Email": "registration@arbill.com",
        "Title": ""
      },
      {
        "Name": "Renee Millett",
        "Email": "rmillett@arbill.com",
        "Title": "Staff Accountant"
      },
      {
        "Name": "ROBYN ZLOTKIN",
        "Email": "rzlotkin@arbill.com",
        "Title": ""
      },
      {
        "Name": "SARAH WEBB",
        "Email": "SWEBB@ARBILL.COM",
        "Title": ""
      }
    ],
    "SupplierID": "102230376",
    "SupplierName": "Arbill Industries",
    "Description": "Provider of safety products, EHS consulting services, safety technology and safety programs. We distribute over 200,000 safety products as well as manufacturer more than 800 SKUs under our highly respected Truline brand. We also offer more than 60 OSHA compliance and safety courses, site assessments and other EHS services. Arbill makes the management of safety programs easy by handling all of the administration. Our safety programs include prescription eyewear, AEDs, footwear, and facility signage and first aid kits. Arbill's proprietary safety technology, Vantage Predictive Analytics, uses leading indicators to identify at risk employees so management can intervene before an injury occurs.",
    "Address": "10450 Drummond Road",
    "City": "Philadelphia,",
    "State": "PA",
    "Zip": "",
    "Country": "USA"
  }
}
    Try it
    Query
    API result

    SubmitMatch

    This function accepts XXX records for bulk processing. It returns a job ID. Once the job is ready it also calls the callback function (if configured) and passes the job ID and number of matches with status. User can use GetMatchResult for getting the results back.
    5000 is the maximum number of records that can be submitted.
    Only quality results are retrieved.

    Input
    Field Required Description Default Value
    APIKEY Yes Used for API authentication.
    customerID Yes Assigned Customer ID. Used to validate customer's access to the API.
    • If access is no longer valid, the API returns an error of “Expired Contract.”
    • If customer id is not known, the API returns error of “Invalid Customer ID.”
    customerName Yes Assigned Customer Name
    Supplier List Yes List of supplier contains following fields:-

    inputSupplierId
    Matched supplier will be returned with the inputSupplierId.

    inputSupplierName
    Supplier name or doing business as name. Examples:
    • "ABC Company"
    • "John Smith International Systems"
    If a supplier has multiple names, provide only one name in each search. Avoid concatenating multiple names. The following are examples that will reduce probability of matches :
    • "ABC Company doing business as ABC Co"
    • "John Smith International Systems dba JSI Systems"
    For suppliers with multiple names, consider conducting multiple searches with each name separately if a match with is not found with the primary name.

    inputAddress
    Supplier's address. Where possible, provide physical addresses instead of P.O. Box addresses. Currently, the API only supports US addresses. Examples:
    • "5600 N Main Street"
    • "101 Second Street Ste 100"

    inputCity
    City associated with the address. Examples:
    • "Chicago"
    • "Los Alamos"

    inputState
    State associated with the address. Provide the two letter State code if country is USA/CAN. Examples:
    • Good(USA): "CA"
    • Bad(USA):"California"
    • Good(GBR):"London"

    inputCountry
    Country associated with the address. Provide the 3 letter Country code (ISO 3166-1 alpha-3 country code). USA is the default value. Examples:
    • "USA"
    • "CAN"
    Request Example
    In Params
KEY                 :        VALUE
------------------------------------------------------------
APIKey              :       b18f18f036104787af0142f7c0fc4e39
customerId          :       98375
customerName        :       Demo

In Body Row JSON
{
    "suppliers" :[{   
        "inputSupplierId":"1",
        "inputSupplierName": "KDL HARDWARE SUPPLY INC",
        "inputAddress": "850 POPLAR PL SOUTH POB 24746",
        "inputCity": "seattle",
        "inputState": "wa",
		"inputCountry": "USA"
        },
        { 
        "inputSupplierId":"2",
        "inputSupplierName": "RF DESIGN AND INTEGRATION INC",
        "inputAddress": "792 HAUNTED LANE",
        "inputCity": "bensalem",
        "inputState": "pa",
		"inputCountry": "USA"
        }
    ]
}
    Results Example
    {
   "StatusCode": 200,
   "Message": null,
   "Data": {
       "JobId": "d653e45de3e040bcad277c4ffe7647f8",
       "NumberOfInputRecord": 2,
       "Status": "Received"
   },
   "Errors": null
}

    GetMatchResults

    This function returns a status of Job created in SubmitMatch Request. It returns a status of job like "Processing", "Error" and no results. If Job is completed it return match results.

    Input
    Field Required Description Default Value
    APIKEY Yes Used for API authentication.
    customerID Yes Assigned Customer ID. Used to validate customer's access to the API.
    • If access is no longer valid, the API returns an error of “Expired Contract.”
    • If customer id is not known, the API returns error of “Invalid Customer ID.”
    customerName Yes Assigned Customer Name
    jobId Yes Returned by SubmitMatch or GetSuppliers
    Results Example
    {
  "StatusCode": 200,
  "Message": null,
  "Data": {
    "JobId": "d653e45de3e040bcad277c4ffe7647f8",
    "NumberOfInputRecord": 2,
    "Status": "Completed",
    "Suppliers": [
  {
    "InputSupplierId": "1",
    "MatchedSuppliers": [{
        "Error": null,
        "Phone": null,
        "Website": "www.kdlhardware.com",
        "Established": null,
        "Employee": "",
        "Revenue": "",
        "ActualRevenue": null,
        "Actualemployees": null,
        "Ethnicity": null,
        "Ownership": [],
        "SmallBusinessClassifications": [
          "8A"
        ],
        "Naics": [
          "423440"
        ],
        "NaicsDescription": [
          "OTHER COMMERCIAL EQUIPMENT MERCHANT WHOLESALERS"
        ],
        "Sic": [],
        "AlternateSupplierNames": [],
        "CertificationDetail": [
          {
            "Classification": "8A",
            "Agency": "Veterans Affairs / Vetbiz",
            "ExpirationDate": "5/29/2022 12:00:00 AM",
			"CertificateNumber": ""
          }
        ],
        "ContactDetail": [],
        "SupplierID": "yYQrlycoPave",
        "SupplierName": "KDL HARDWARE SUPPLY, INC",
        "Description": "Based out of Seattle, WA KDL HARDWARE SUPPLY, INC operates in the Other Commercial Equipment Merchant Wholesalers.",
        "Address": "PO BOX 24746",
        "City": "SEATTLE",
        "State": "WA",
        "Zip": "FALSE",
        "Country": "USA"
        }
    ]
  },
  {
    "InputSupplierId": "Am71PPfO8gYj",
    "MatchedSuppliers": [{
        "Error": null,
        "Phone": null,
        "Website": "rfdesign-int.com",
        "Established": "1997",
        "Employee": "",
        "Revenue": "",
        "ActualRevenue": null,
        "Actualemployees": null,
        "Ethnicity": null,
        "Ownership": [
          "WBE"
        ],
        "SmallBusinessClassifications": [
          "SC-SDB"
        ],
        "Naics": [
          "517911",
          "541690",
          "811213",
          "334220",
          "517312"
        ],
        "NaicsDescription": [
          "TELECOMMUNICATIONS RESELLERS",
          "OTHER SCIENTIFIC AND TECHNICAL CONSULTING SERVICES",
          "COMMUNICATION EQUIPMENT REPAIR AND MAINTENANCE",
          "RADIO AND TELEVISION BROADCASTING AND WIRELESS COMMUNICATIONS EQUIPMENT MANUFACTURING",
          "WIRELESS TELECOMMUNICATIONS CARRIERS (EXCEPT SATELLITE)"
        ],
        "Sic": [],
        "AlternateSupplierNames": [],
        "CertificationDetail": [
          {
            "Classification": "SC-SDB",
            "Agency": "SAM - System for Award Management",
            "ExpirationDate": "2/21/2021 12:00:00 AM",
			"CertificateNumber": ""
          },
          {
            "Classification": "DBE",
            "Agency": "Southeastern Pennsylvania Transportation Authority (SEPTA)",
            "ExpirationDate": "11/30/2018 12:00:00 AM",
			"CertificateNumber": ""
          },
          {
            "Classification": "WBE",
            "Agency": "City of Philadelphia",
            "ExpirationDate": "4/8/2020 12:00:00 AM",
			"CertificateNumber": ""
          },
          {
            "Classification": "DBE",
            "Agency": "PA UCP - Pennsylvania Unified Certification Program",
            "ExpirationDate": "",
			"CertificateNumber": ""
          }
        ],
        "ContactDetail": [
          {
            "Name": "ROBIN ALBERT",
            "Email": "ralbert@rfdesign-int.com",
            "Title": ""
          }
        ],
        "SupplierID": "Am71PPfO8gYj",
        "SupplierName": "R.F. DESIGN & INTEGRATION, INC.",
        "Description": "Wireless Communications Engineering & Installation",
        "Address": "792 HAUNTED LANE",
        "City": "BENSALEM",
        "State": "PA",
        "Zip": "19020",
        "Country": "USA"
      }
    ]
  }
  ],
  "Errors": null
}

    Suppliers

    GetSupplierDetail

    The method returns the supplier information identified by the supplier.io Supplier ID. Results are returned in JSON format.

    Input
    Field Required Description Default Value
    APIKEY Yes Used for API authentication.
    customerID Yes Assigned Customer ID. Used to validate customer's access to the API.
    • If access is no longer valid, the API returns an error of “Expired Contract.”
    • If customer id is not known, the API returns error of “Invalid Customer ID.”
    supplierID Yes supplier.io Suppiler ID for the supplier to be retrieved.
    Results Example
    {  
"results": {
    "Error": null,
    "Phone": null,
    "Website": "",
    "Established": "1957",
    "Employee": "51-200",
    "Revenue": "less than $500K",
    "ActualRevenue": null,
    "Actualemployees": null,
    "Ethnicity": null,
    "Ownership": [
      "WBE"
    ],
    "SmallBusinessClassifications": [
      "SBE",
      "WOSB"
    ],
    "NAICS": [
      "541690",
      "313210",
      "314999",
      "315190",
      "315210",
      "315220",
      "315280",
      "315990",
      "316210",
      "316998",
      "325212",
      "326199",
      "332420",
      "339113",
      "339115",
      "423390",
      "423450",
      "423490",
      "423840",
      "423850",
      "423990",
      "424320",
      "424340"
    ],
    "NAICSDescription": [
      "OTHER SCIENTIFIC AND TECHNICAL CONSULTING SERVICES",
      "BROADWOVEN FABRIC MILLS",
      "ALL OTHER MISCELLANEOUS TEXTILE PRODUCT MILLS",
      "OTHER APPAREL KNITTING MILLS",
      "CUT AND SEW APPAREL CONTRACTORS",
      "MEN???S AND BOYS??? CUT AND SEW APPAREL MANUFACTURING",
      "OTHER CUT AND SEW APPAREL MANUFACTURING",
      "APPAREL ACCESSORIES AND OTHER APPAREL MANUFACTURING",
      "FOOTWEAR MANUFACTURING",
      "ALL OTHER LEATHER GOOD AND ALLIED PRODUCT MANUFACTURING",
      "SYNTHETIC RUBBER MANUFACTURING",
      "ALL OTHER PLASTICS PRODUCT MANUFACTURING",
      "METAL TANK (HEAVY GAUGE) MANUFACTURING",
      "SURGICAL APPLIANCE AND SUPPLIES MANUFACTURING",
      "OPHTHALMIC GOODS MANUFACTURING",
      "OTHER CONSTRUCTION MATERIAL MERCHANT WHOLESALERS",
      "MEDICAL, DENTAL, AND HOSPITAL EQUIPMENT AND SUPPLIES MERCHANT WHOLESALERS",
      "OTHER PROFESSIONAL EQUIPMENT AND SUPPLIES MERCHANT WHOLESALERS",
      "INDUSTRIAL SUPPLIES MERCHANT WHOLESALERS",
      "SERVICE ESTABLISHMENT EQUIPMENT AND SUPPLIES MERCHANT WHOLESALERS",
      "OTHER MISCELLANEOUS DURABLE GOODS MERCHANT WHOLESALERS",
      "MEN???S AND BOYS??? CLOTHING AND FURNISHINGS MERCHANT WHOLESALERS",
      "FOOTWEAR MERCHANT WHOLESALERS"
    ],
    "SIC": [
      "3821",
      "3851",
      "5039",
      "5047",
      "5087",
      "5099",
      "5136",
      "5139",
      "2329",
      "2389"
    ],
    "AlternateSupplierNames": [
      "ARBILL SAFETY PRODUCTS"
    ],
    "CertificationDetail": [
      {
        "Classification": "WBE",
        "Agency": "SAM - System for Award Management",
        "ExpirationDate": "4/16/2020 12:00:00 AM",
		"CertificateNumber": ""
      },
      {
        "Classification": "WBE",
        "Agency": "State of New York",
        "ExpirationDate": "",
		"CertificateNumber": ""
      },
      {
        "Classification": "WBE",
        "Agency": "City of New York, NY",
        "ExpirationDate": "6/29/2022 12:00:00 AM",
		"CertificateNumber": ""
      },
      {
        "Classification": "SBE",
        "Agency": "SAM - System for Award Management",
        "ExpirationDate": "4/16/2020 12:00:00 AM",
		"CertificateNumber": ""
      },
      {
        "Classification": "WOSB",
        "Agency": "SAM - System for Award Management",
        "ExpirationDate": "4/16/2020 12:00:00 AM",
		"CertificateNumber": ""
      },
      {
        "Classification": "WOSB",
        "Agency": "WBENC",
        "ExpirationDate": "9/22/2018 12:00:00 AM",
		"CertificateNumber": ""
      }
    ],
    "ContactDetail": [
      {
        "Name": "",
        "Email": "",
        "Title": ""
      },
      {
        "Name": "David Gerhardt",
        "Email": "dgerhardt@arbill.com",
        "Title": "Director of Marketing"
      },
      {
        "Name": "HELP DESK",
        "Email": "help@arbill.com",
        "Title": ""
      },
      {
        "Name": "JULIE COPELAND ",
        "Email": "info@arbill.com",
        "Title": ""
      },
      {
        "Name": "JULIE COPELAND",
        "Email": "jcopeland@arbill.com",
        "Title": ""
      },
      {
        "Name": "Julie Copeland ",
        "Email": "registration@arbill.com",
        "Title": ""
      },
      {
        "Name": "Renee Millett",
        "Email": "rmillett@arbill.com",
        "Title": "Staff Accountant"
      },
      {
        "Name": "ROBYN ZLOTKIN",
        "Email": "rzlotkin@arbill.com",
        "Title": ""
      },
      {
        "Name": "SARAH WEBB",
        "Email": "SWEBB@ARBILL.COM",
        "Title": ""
      }
    ],
    "SupplierID": "102230376",
    "SupplierName": "Arbill Industries",
    "Description": "Provider of safety products, EHS consulting services, safety technology and safety programs. We distribute over 200,000 safety products as well as manufacturer more than 800 SKUs under our highly respected Truline brand. We also offer more than 60 OSHA compliance and safety courses, site assessments and other EHS services. Arbill makes the management of safety programs easy by handling all of the administration. Our safety programs include prescription eyewear, AEDs, footwear, and facility signage and first aid kits. Arbill's proprietary safety technology, Vantage Predictive Analytics, uses leading indicators to identify at risk employees so management can intervene before an injury occurs.",
    "Address": "10450 Drummond Road",
    "City": "Philadelphia,",
    "State": "PA",
    "Zip": "",
    "Country": "USA"
  }
}
    Try it
    Query
    API result

    GetSuppliers

    This function accepts X SIO IDs or RecallKeys for bulk processing, It returns a job ID. Once the job is ready it also calls the callback function (if configured) and passes the job ID and return status. User can use GetMatchResults using JobID for getting actual results back.
    5000 is the maximum number of records that can be submitted.

    Input
    Field Required Description Default Value
    APIKEY Yes Used for API authentication.
    customerID Yes Assigned Customer ID. Used to validate customer's access to the API.
    • If access is no longer valid, the API returns an error of “Expired Contract.”
    • If customer id is not known, the API returns error of “Invalid Customer ID.”
    customerName Yes Assigned Customer Name
    supplierIds Yes List of Supplier Id or RecallKey
    Request Example
    In Params
KEY                 :        VALUE
------------------------------------------------------------
APIKey              :       b18f18f036104787af0142f7c0fc4e39
customerId          :       98375
customerName        :       Demo

In Body Row JSON
{
    "supplierIds" :[
      "yYQrlycoPave",
      "Am71PPfO8gYj"
    ]
}
    Results Example
    {
   "StatusCode": 200,
   "Message": null,
   "Data": {
       "JobId": "d653e45de3e040bcad277c4ffe7647f8",
       "NumberOfInputRecord": 3,
       "Status": "Received"
   },
   "Errors": null
}