Sign in
latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Suppliers - Sites

Create an identifier for a supplier

Create a new identifier (supplier ID, customer ID, or own site ID) for a supplier using flexible search parameters.

Related Endpoints:

  • To find suppliers by identifier, use GET /public/v2/suppliers/sites/find-by-identifier.
  • To delete an identifier, use DELETE /public/v2/suppliers/sites/identifiers.
  • To create a new supplier, use POST /public/v2/suppliers/sites.
  • To get all suppliers, use GET /public/v2/suppliers/sites.

How It Works:

  1. Find the Supplier: Provide one or more search parameters to identify the supplier:

    • 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 (applies to supplierId, customerId, and ownId)

  2. Create the Identifier: In the request body, specify:

    • type: The type of identifier to create (supplierId, customerId, or ownId)
    • id: The identifier value
    • source: Optional source system (defaults to PUBLIC_API if not provided)

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

Search Behavior:

  • Parameters are combined with OR logic - suppliers matching ANY of the provided identifiers will be found
  • At least one search parameter must be provided
  • If multiple suppliers match, an error is returned (use source parameter to narrow down)
  • If no suppliers match, a 404 error is returned

Request Body: The request body specifies what identifier to create:

  • type: Must be one of: supplierId, customerId, ownId
  • id: The identifier value (e.g., "SUP-12345")
  • source: Optional source system (e.g., "SAP", "Coupa")

Examples:

  1. Create a supplier ID by searching with prewaveId:

    POST /public/v2/suppliers/sites/identifiers?prewaveId=102006215
Body: {"type": "supplierId", "id": "SUP-12345", "source": "SAP"}

  2. Create a customer ID by searching with existing supplier ID:

    POST /public/v2/suppliers/sites/identifiers?supplierId=SUP-12345&source=SAP
Body: {"type": "customerId", "id": "CUST-67890", "source": "SAP"}

  3. Create an own site ID by searching with customer ID:

    POST /public/v2/suppliers/sites/identifiers?customerId=CUST-67890
Body: {"type": "ownId", "id": "OWN-SITE-01", "source": "SAP"}

Important Notes:

  • The combination of identifier value and source must be unique within your organization
  • If the identifier already exists for this supplier, a 409 Conflict error is returned
  • If the identifier exists for a different supplier, a 409 Conflict error is returned
  • All identifier changes are automatically audited

Required Permission: MANAGE_PUBLIC_SUPPLIER_IDS

post/public/v2/suppliers/sites/identifiers

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. Applies to supplierId, customerId, and ownId (not prewaveId).

Request body

type'SUPPLIER_ID' | 'CUSTOMER_ID' | 'OWN_ID' required

Type of identifier

idstring required

The identifier value

sourcestring nullable

Source system of the identifier (e.g., 'SAP', 'Excel', 'Coupa'). Optional - defaults to 'PUBLIC_API' when not provided.

Example request

{
  "type": "SUPPLIER_ID",
  "id": "SUP-12345",
  "source": "SAP"
}

Response

Created - Identifier created successfully.

type'SUPPLIER_ID' | 'CUSTOMER_ID' | 'OWN_ID' required

Type of identifier

idstring required

The identifier value

sourcestring nullable

Source system of the identifier

prewaveTargetIdinteger required

Prewave target ID of the supplier this identifier was added to

Example response

{
  "type": "SUPPLIER_ID",
  "id": "SUP-12345",
  "source": "SAP",
  "prewaveTargetId": 101266998
}