Creating a Vendor Process by Using APIs

This topic explains how to create a vendor process request by using the Vendor Process APIs. Before you submit the process creation request, retrieve the required data by calling the following endpoints in sequence.

Prerequisites

Users must know the process type for which they want to create the vendor process request.

Context

Procedure

  1. The client application retrieves the list of process types enabled for the site by using the processTypes endpoint.
    GET {{runtime_URL}}/supplierdatapagination/v4/prod/processes/processTypes
  2. The client application retrieves the intake form template for the selected process type by using the templates endpoint.

    Replace the processType path parameter with the value returned by the processTypes endpoint.

    GET {{runtime_URL}}/supplierdatapagination/v4/prod/processes/processTypes}/templates

    The response returns the questionAnswers configured for the intake form. Store this information because you must map it to the answers section of the process creation request.

  3. The client application retrieves the modular questionnaire details by using the modularQuestionnaireRequests endpoint.

    Provide the templateId returned by the templates endpoint together with the required matrix values.

    POST {{runtime_URL}}/supplierdatapagination/v4/prod/processes/modularQuestionnairesRequests

    The response returns the questionnaires structure required to construct the process creation request. This step assumes that the application already has the vendor information for which the process is being created.

  4. The client application creates the vendor process by using the processCreateRequests endpoint.

    Submit the request using the questionnaire data retrieved from the templates and modularQuestionnaireRequests endpoints.

    POST {{runtime_URL}}/supplierdatapagination/v4/prod/processes/processCreateRequests

    Recipient Association Rules for Questionnaires

    The recipient associated with a questionnaire is determined as follows:

    External Questionnaires

    The recipient is determined in the following order of precedence:
    1. The recipient specified for the questionnaire.

    2. If no questionnaire recipient is specified, the recipient specified for the supplier.

    3. If neither a questionnaire recipient nor a supplier recipient is specified, the supplier's primary contact.

    Internal Questionnaires

    The recipient is determined in the following order of precedence:

    1. The recipient specified for the questionnaire.

    2. If no questionnaire recipient is specified, the questionnaire initiator.