Use of the Supplier Data API with Pagination vendors Endpoint

The Supplier Data API with Pagination vendors endpoint uses the PATCH method to send qualification and preferred category status update requests to your site in JSON format. You can use it to qualify, disqualify, and set preferred category statuses for suppliers.

The JSON request specifies authentication in the header and status update information in the body.

Method	Endpoint	Description
`PATCH`	{{runtime_url}}/supplierdatapagination/v4/prod/vendors	Updates qualification or preferred category status for the specified combination of commodities, regions, and departments for the specified suppliers.

The JSON requests that the vendors endpoint sends to your site include statusList arrays with statusType of either Preferred or Qualification. statusList arrays include the following name/value pairs or arrays:

Name/Value Pair or Array	Valid Values	Required?
`active`	`TRUE` or `FALSE`. Specifying `FALSE` deactivates the status record.	Yes
`businessUnit`	One or more of the business units or department IDs loaded in your site as master data and used in supplier management projects, separated by semicolons. Note This code must match the department master data loaded in your SAP Ariba strategic sourcing solutions site.	Yes, if departments are enabled in your site.
`category`	One or more of the category IDs loaded in your site as master data and used in supplier management projects, separated by semicolons. Note This code must match the commodity master data loaded in your SAP Ariba strategic sourcing solutions site.	Yes
`endDate`	The end date for the status in ISO format.	No
`erpVendorId`	The ERP vendor ID of the supplier.	Yes
`region`	One or more of the region codes loaded in your site as master data and used in supplier management projects, separated by semicolons. Note This code must match the commodity master data loaded in your SAP Ariba strategic sourcing solutions site.	Yes
`requalificatoinEligibleDate`	The requalification eligibility date for a qualification status in ISO format.	No
`sourceSystem`	The source system associated with the `erpVendorId`	Yes
`startDate`	The start date for the status in ISO format.	No
`status`	The status, which can be one of the following values: Qualification statuses: `NotQualified` `QualificationStarted` `InQualification` `PendingQualificationApproval` `PendingResubmit` `QualificationRestricted` `QualificationRejected` `Disqualified` `Qualified` `Expired` `Cancelled` If you use display mappings to customize what statuses are called in your site, you must still use these values to update qualification statuses. Preferred category statuses: numbers `1` through `5`, where `1` represents the highest level of preferment.	Yes
`statusQualifier`	A string that provides additional information about the status.	No

Every time the vendors endpoint is called, a new statusType array is created. The vendors endpoint can also send multiple statusList arrays with statusType of either Preferred or Qualification consolidated in a JSON request. It is recommended to send the details in a consolidated operation for sending multiple supplier details. A maximum of 1000 statusType arrays in a single PATCH operation. The following example shows a status request body that sets a qualification status for a supplier for all commodities, regions, and departments:

{ 
   "statusList":[ 
      { 
         "active":true,
         "erpVendorId":"1234567",
         "sourceSystem":"SAP",
         "status":"Qualified"
      },
      { 
          "active":true, 
          "erpVendorId":"1234568", 
          "sourceSystem":"SAP", 
           "status":"Qualified" 
     }    
],
   "statusType":"Qualification"
}

Note

In sites that include SAP Ariba Supplier Lifecycle and Performance, you can set qualification statuses for a supplier either automatically using qualification data import or the Supplier Data API with Pagination, or manually using qualification and disqualification projects. SAP Ariba Supplier Lifecycle and Performance is designed to maintain qualifications over the long term using projects, which have questionnaires and workflows. Qualifications set using data import or the Supplier Data API with Pagination don't have associated qualification or disqualification projects. Keep in mind the following behavior:

If a qualification status was set using an approved qualification or disqualification project, you can't use data import or the API to update it. If a supplier was qualified using a qualification project, you must disqualify them using a disqualification project. If a supplier was disqualified using a disqualification project, you must requalify them using a qualification project. If a supplier was qualified using a qualification project with an expiration date and that qualification has expired, you must requalify them using a qualification project.
If a qualification status was set using data import or the API, you can use a qualification or disqualification project to update it. In this case, a qualification manager can start a disqualification or requalification in the supplier's profile. SAP Ariba Supplier Lifecycle and Performance then creates the appropriate qualification or disqualification project based on the specified qualification commodities, regions, and departments. Once that project is created, you can only manage that qualification's status using projects.
The qualification end (expiration) and requalification eligibility dates in qualification data imports or API requests are for information only and don't trigger updates to qualification status. For example, if you use data import or the API to define qualified status with an end date of 1/31/2020, the qualification status doesn't change to expired on 2/1/2020. Since there was no underlying qualification project to set the status, you can't start a project-based requalification for a qualification that you defined using data import or the API and that has since passed the expiration date. The qualification retains the original qualified status unless you update it using another data import or API operation.
Since commodities, regions, and departments are hierarchical, with higher and lower levels, when a supplier is qualified or disqualified for a commodity, region, or department combination, they're also automatically qualified or disqualified for the lower levels of those hierarchy branches. If a supplier is disqualified at a higher level of the hierarchy, you can't qualify them at a lower level. For example, if the supplier is disqualified for apparel in the United States of America, you can't qualify them for shirts in Colorado. However, if a supplier is qualified at a higher level and the qualification isn't project-based, you can use data import or the API to partially disqualify them at a lower level. For example, if the supplier is qualified for apparel in the United States of America, you can disqualify them for shoes in Texas.