Sign in
Suppliers - Sites

Find suppliers by ID

Find suppliers/sites by their identifiers (supplier ID, customer ID, own site ID, or Prewave ID) with optional source.

This unified endpoint allows you to search for suppliers using any type of identifier from external systems (e.g., SAP, Coupa, DNB). You can search by one or more ID types simultaneously.

Related Endpoints:

  • To get all suppliers with pagination, use GET /public/v2/suppliers/sites.
  • To create a new supplier, use POST /public/v2/suppliers/sites.
  • To create an identifier for a supplier, use POST /public/v2/suppliers/sites/identifiers.
  • To delete an identifier, use DELETE /public/v2/suppliers/sites/identifiers.
  • To deactivate a supplier, use DELETE /public/v2/suppliers/sites.

Search Parameters:

  • supplierId (optional): Search by supplier ID
  • customerId (optional): Search by customer ID
  • ownId (optional): Search by own site ID
  • prewaveId (optional): Search by Prewave ID
  • source (optional): Filter by source system (e.g., "SAP", "Coupa", "PUBLIC_API")

Search Behavior:

  • Multiple ID types: If you provide multiple ID parameters (e.g., both supplierId and customerId), the endpoint returns suppliers that match ANY of the provided IDs (OR logic).
  • Source filtering: If source is provided, only IDs with that exact source are matched. If source is not provided, IDs with any source or without a source (legacy IDs) are matched. Note: source does not apply to prewaveId searches.
  • Multiple results: The same ID can be associated with multiple suppliers/sites in your organization, so the endpoint returns a list.
  • Empty results: Returns an empty list if no suppliers match the search criteria.

Response Format: Returns a list of PublicSupplierDetailV2DTO objects with complete supplier information including:

  • Basic identification (Prewave Target ID, name, LinkedIn ID)
  • Location details (address, city, country code, postal code)
  • Company information (website, description, logo, year founded, size)
  • All supplier IDs, customer IDs, and own site IDs
  • Screening status and monitoring dates
  • Site-group reference
  • Connection contacts count

Use Cases:

  1. Find by single ID type:

    GET /suppliers/sites/find-by-identifier?supplierId=SAP-12345&source=SAP

  2. Find by multiple ID types (returns suppliers matching ANY):

    GET /suppliers/sites/find-by-identifier?supplierId=SAP-12345&customerId=CRM-67890&source=SAP

  3. Find without source filter (matches any source):

    GET /suppliers/sites/find-by-identifier?supplierId=SUP-12345

  4. Find by Prewave ID:

    GET /suppliers/sites/find-by-identifier?prewaveId=12345

Important Notes:

  • At least one ID parameter (supplierId, customerId, ownId, or prewaveId) must be provided
  • The endpoint returns full supplier details (PublicSupplierDetailV2DTO), not just basic info
  • All IDs for each supplier are included in the response (not just the matching ones)
  • Results are ordered alphabetically by name, then by ID for deterministic ordering

Required Permission: ACCESS_PUBLIC_SUPPLIERS

get/public/v2/suppliers/sites/find-by-identifier

Query parameters

supplierIdstring

Supplier ID to search for. Can be combined with customerId, ownId, and/or prewaveId.

customerIdstring

Customer ID to search for. Can be combined with supplierId, ownId, and/or prewaveId.

ownIdstring

Own site ID to search for. Can be combined with supplierId, customerId, and/or prewaveId.

prewaveIdinteger

Prewave ID to search for. Can be combined with supplierId, customerId, and/or ownId.

sourcestring

Optional source system to filter by. If not provided, matches IDs with any source or without a source. Applies to all provided ID parameters.

Response

Successfully found suppliers. Returns empty list if no matches found.

prewaveTargetIdinteger required

Prewave target ID of the supplier

namestring required

Name of the supplier

snamestring nullable

Geonames ID (see https://geonames.org)

linkedInIdstring nullable

LinkedIn ID of the supplier

addressstring nullable

Full address of the supplier

citystring nullable

City of the supplier's location

countryCodestring nullable

ISO 3166-1 alpha-2 country code of the supplier's location

postalCodestring nullable

Postal/ZIP code of the supplier's location

websitestring nullable

Website URL of the supplier

descriptionstring nullable

Description of the supplier

logostring nullable

URL to the logo shown in the supplier profile

yearFoundedinteger nullable

Year the supplier was founded

size'Small' | 'Medium' | 'Large' | 'Very large'
screenedboolean required

Whether the supplier is screened or not

screenedStatus'Required' | 'Pending' | 'Screened' | 'NotPossible'

Screening status of the target

monitoredSincestring date-time nullable

Timestamp when the supplier monitoring started (ISO-8601 UTC)

earliestAlertstring date-time nullable

Timestamp of the earliest alert for the supplier (ISO-8601 UTC)

connectionContactsCountinteger nullable

Number of connection contacts of the supplier

Example response

[
  {
    "prewaveTargetId": 102006215,
    "name": "Acme Corporation",
    "sname": "3191281",
    "linkedInId": "acme-corporation",
    "address": "123 Main St, Vienna, Austria",
    "city": "Vienna",
    "countryCode": "AT",
    "postalCode": "1010",
    "website": "https://www.example.com",
    "description": "Leading manufacturer of electronic components",
    "yearFounded": 1999,
    "supplierIds": [
      {
        "id": "SUP-12345",
        "source": "SAP"
      }
    ],
    "customerIds": [
      {
        "id": "SUP-12345",
        "source": "SAP"
      }
    ],
    "ownIds": [
      {
        "id": "SUP-12345",
        "source": "SAP"
      }
    ],
    "screened": true,
    "screenedStatus": "Screened",
    "monitoredSince": "2023-01-01T12:00:00Z",
    "earliestAlert": "2023-01-01T12:00:00Z",
    "siteGroup": {
      "id": 102006215,
      "name": "Acme Corporation"
    },
    "connectionContactsCount": 5
  }
]