Get suppliers list
Get the suppliers list for a particular case:
- Get all suppliers from the active year if no parameter is passed.
- Get all suppliers for a specific year when yearId is passed.
- Get a particular supplier if an Id or an external Id (PrettyId) is passed.
GET/suppliers/list
Check the Supplier section on our Swagger page.
Get supplier
Get a supplier from Position Green via an external id (PrettyId)
GET/suppliers
Check the Supplier section on our Swagger page.
Create new supplier
Creates a new supplier in Position Green Platform.
| Parameter | Required | Type | Description |
|---|---|---|---|
| supplierPrettyId | Yes | string | A unique external identifier for the supplier (eg. supplier_1) |
name | Yes | string | Name of the supplier (eg Supplier 1) |
| contactFirstName | Yes | string | First name of the main contact at the supplier |
| contactLastName | Yes | string | Last name of the main contact at the supplier |
| contactEmail | Yes | string | Email of the main contact at the supplier |
| tags | No | Array of strings | A list of tags |
Update a supplier
Updates a supplier's information.
| Parameter | Required | Type | Description |
|---|---|---|---|
| contactFirstName | Yes | string | First name of the main contact at the supplier |
| contactLastName | Yes | string | The last name of the main contact at the supplier |
| contactEmail | Yes | string | Email of the main contact at the supplier |
tags | No | Array of strings | A list of tags |
PUT/suppliers/{supplierId}
Check the Supplier section on our Swagger page.
Delete supplier
Delete a supplier.
DELETE/suppliers/{supplierId}
Check the Supplier section on our Swagger page.
Get Email Templates
Get all email templates.
GET/email/GetEmailTemplates
Check the email section on our Swagger page.
Send Supplier Email
Send emails to suppliers.
| Parameter | Required |
| EmailTemplateId | Yes |
FromUserId | |
| FromEmail | |
| FromName | Yes if FromEmail is set |
| Recipients (array of) | |
| SupplierId | Yes |
| UserId | Yes, if RecipientType = UserId |
| QuestionnaireId | Yes, depending on the type of email template or if any RecipientType with collaborators is selected |
| RecipientType | Yes, any of: |
| UserId |
| Responsible | |
| Collaborators | |
| ResponsibleAndCollaborators |
POST/email/SendSupplierEmail
Check the email section on our Swagger page.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article