Canopy's /suppliers API displays key flags and indicators about each supplier record in Canopy.
It does not display any fields of data held on the Supplier Profile. Please refer to the /answers API if you require specific fields of information.
The /suppliers API determines the overall status of the supplier record.
In this article you will learn:
GET data: Structure of the API call
Key fields in the /suppliers API
How to determine if Bank Details have changed
For technical documentation, please following this link
GET data: Structure of the API call
The call using the /suppliers API will require the following components:
| URL | https://stage-api.canopy-sm.com/suppliers |
| x-api-key |
This is a unique key identifying your specific instance of Canopy Please ask your administrator to obtain this from the Canopy Support Team |
| showAll (optional) |
Includes all supplier records, including those that have never been published If this is not included, the API will only pull records of suppliers that have been published at least once |
| startId (optional) |
The UID of the first supplier record you would like to pull If this is not included, the API will pull all supplier records |
| startDate (optional) |
The earliest date when you would like to pull suppliers from, referring to the Last Updated Date in the format yyyy-MM-dd If this is not included, the API will pull all supplier records |
Key fields in the /suppliers API
The table below provides a summary of the key fields available on the /suppliers API.
For a complete list of fields, please refer to the technical documentation available here:
https://api-docs.canopy-sm.com/
| Supplier Status |
The status of the supplier, including ‘Deleted’, ’Rejected’ or ‘Suspended’. Includes the ’Previous Status’, to understand which status the supplier has came from, and the date the supplier moved from their previous status to the current status. Click here for more information about the various Supplier Status states. |
| Requested Date | Date the supplier was originally requested by the Requestor. |
| Submission Date | Date of last submission: i.e. when the supplier last submitted their profile for approval. |
| Publication Date | Date of last publication: i.e. when the profile was last published. |
| Compliance Indicator |
The compliance status of the supplier (i.e. Onboarding, Compliant, Caution, Non-Compliant). Click here for more information about the various Compliance Indicator states. |
| Admin Accounts |
Provides the details of the Supplier Profile Admin(s), regardless of whether the profile is being managed by the supplier or internally. |
| Business Owners |
Provides the details of each of the Business Owners attached to the supplier records. |
| Section Approvals |
For each stage of the approval workflow:
This helps you to determine whether something in the profile recently changed, or if there are unpublished changes awaiting approval. Click here for more information about the approval workflow. |
How to determine if Bank Details have changed
You can use the flags in the /suppliers API to understand if bank details have changed since the profile was last published. There are 4 scenarios to consider, which are outlined below:
1. Supplier is published and their bank details are correct
Last Submitted Date is less than or equal to Last Published Date
2. Bank details have changed since the published record, but the new details not yet been approved
Last Submitted Date is greater than Last Published Date
Bank Verifier “Requires Approval” is YES, i.e. the Bank Verifier has an approval to complete
3. Bank details have changed and been approved, but have not yet been reflected on the published record
Last Submitted Date is greater than Last Published Date
Bank Verifier “Requires Approval” is NO, i.e. the Bank Verifier has completed their approval
Bank Verifier Approval Date is greater than or equal to Last Submitted Date, i.e. approval was completed after submission
4. Bank details on the published record are correct, but the profile is going through re-approval
Last Submitted Date is greater than Last Published Date
Bank Verifier “Requires Approval” is NO, i.e. the Bank Verifier has completed their approval
Bank Verifier Approval Date is less than Last Submitted Date, i.e. approval was never required for the latest submission
For further information, please contact your Administrator.