Skip to main content
GET
/
api
/
suppliers
List Suppliers
curl --request GET \
  --url https://app.polygonone.com/api/suppliers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "<string>",
    "contactName": "<string>",
    "country": "<string>",
    "externalSupplierId": "<string>",
    "address": {
      "street": "<string>",
      "postalCode": "<string>",
      "city": "<string>",
      "additional": "<string>",
      "validated": true,
      "latitude": 123,
      "longitude": 123
    },
    "status": "data_incomplete",
    "isCompanySelf": true,
    "articles": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "internalArticleNr": "<string>",
        "externalArticleNr": "<string>",
        "hsCode": "<string>",
        "ean": "<string>",
        "shortDescription": "<string>",
        "eudrRelevant": true,
        "articleType": "purchase",
        "commodityGroup": "cattle",
        "suppliers": "<array>",
        "complianceResults": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "supplierArticleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "overallStatus": "compliant",
            "geoStatus": "compliant",
            "legalStatus": "compliant",
            "generatedReportUrl": "<string>",
            "generatedAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "countryOfProduction": "<string>"
      }
    ]
  }
]

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Response

List of suppliers

id
string<uuid>
name
string
email
string | null
contactName
string | null
country
string
externalSupplierId
string | null

External ID from your ERP system

address
object
status
enum<string>

Supplier data completeness status

Available options:
data_incomplete,
data_complete,
dds_submitted
isCompanySelf
boolean

True if this supplier represents your own company (for sale articles)

articles
object[]