Position Green API: Suppliers

Modified on Tue, 21 Jul at 9:45 AM

TABLE OF CONTENTS

Get Suppliers List
Get Single Supplier
Create New Supplier
Update Supplier
Delete Supplier
Get Email Templates
Send Supplier Email

Check the Supplier section and Email section on our Swagger page.

Get Suppliers List

Retrieves a paginated list of suppliers for the current tenant with optional filtering.

GET https://api.positiongreen.com/v1/suppliers/list

Query Parameters

Name	Type	Description
Id	string (uuid)	Optional unique identifier to filter by a specific supplier.
PrettyId	string	Optional pretty ID to filter by.
YearId	string (uuid)	Optional year identifier to filter suppliers by specific year. Defaults to active year if omitted.

Response Example (200 OK)

{
  "totalCount": 1,
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "globalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Acme Supplier Logistics",
      "yearId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "prettyId": "acme-logistics",
      "parentId": null,
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Get Supplier

Retrieves detailed information about a specific supplier by its prettyId.

GET https://api.positiongreen.com/v1/suppliers

Query Parameters

Name	Type	Description
prettyId*	string	Required. The pretty ID of the supplier to retrieve.

Response Example (200 OK)

{
  "supplierPrettyId": "acme-logistics",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Acme Supplier Logistics",
  "contactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactFirstName": "John",
  "contactLastName": "Doe",
  "contactEmail": "john.doe@acme.com",
  "language": "en"
}

Create New Supplier

Creates a new supplier in Position Green Platform.

POST https://api.positiongreen.com/v1/suppliers

Request Body Parameters

Parameter	Required	Type	Description
supplierPrettyId	No	nullable string	Unique external identifier for the supplier (e.g., `acme-logistics`).
name	No	nullable string	Name of the supplier organization.
contactFirstName	No	nullable string	First name of the main contact person.
contactLastName	No	nullable string	Last name of the main contact person.
contactEmail	No	nullable string	Email address of the main contact person.
tags	No	nullable string[]	Optional list of tags to associate with the supplier.

Response Example (200 OK)

{
  "supplierPrettyId": "acme-logistics",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Update a Supplier

Updates an existing supplier's contact information and tags.

PUT https://api.positiongreen.com/v1/suppliers/{supplierId}

Path Parameters

supplierId*

string (uuid)

Required. The unique identifier of the supplier to update.

Request Body Parameters

Parameter	Required	Type	Description
contactFirstName	No	nullable string	Updated first name of the main contact person.
contactLastName	No	nullable string	Updated last name of the main contact person.
contactEmail	No	nullable string	Updated email address of the main contact person.
tags	No	nullable string[]	Updated array of tags.

Response Example (200 OK)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Delete Supplier

Deletes a supplier from Position Green Platform.

DELETE https://api.positiongreen.com/v1/suppliers/{supplierId}

Path Parameters

supplierId*

string (uuid)

Required. The unique identifier of the supplier to delete.

Responses

200 OK Success	Successfully deleted the supplier.
401 Unauthorized	Authentication required.
404 Not Found	Supplier not found with the specified ID.
500 Server Error	Internal server error occurred during supplier deletion.

Get Email Templates

Retrieves a list of all available email templates for the authenticated tenant, including built-in and custom templates.

GET https://api.positiongreen.com/v1/email/GetEmailTemplates

Response Example (200 OK)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Supplier Questionnaire Invitation",
    "description": "Default template sent when initiating a questionnaire",
    "builtIn": true,
    "type": "SurveyInvitation",
    "localizations": [
      {
        "culture": "en",
        "displayName": "English"
      }
    ]
  }
]

Send Supplier Email

Sends an email to specified supplier recipients using a selected email template.

POST https://api.positiongreen.com/v1/email/SendSupplierEmail

Request Body Parameters

Parameter	Required	Type	Description
emailTemplateId*	Yes	string	The unique identifier of the email template to use.
recipients*	Yes	Recipients[]	List of recipients (at least one required).
fromUserId	No	nullable string (uuid)	Optional user ID to send the email on behalf of.
fromName	Conditional	nullable string	Sender name to display. Required if `fromEmail` is provided.
fromEmail	No	nullable string	Optional sender email address.

Recipients Item Properties

Property	Required	Type	Description
supplierId*	Yes	string (uuid)	The ID of the supplier organization receiving the email.
userId	Conditional	nullable string (uuid)	Required if `recipientType` is set to `UserId`.
questionnaireId	Conditional	nullable string (uuid)	Required for certain survey templates or collaborator recipients.
recipientType	No	string (enum)	Recipient role: `UserId`, `Responsible`, `Collaborators`, or `ResponsibleAndCollaborators`.

Response Example (200 OK)

{
  "sentEmails": 3
}