Skip to main content
GET
/
api
/
dds-statements
List DDS Statements
curl --request GET \
  --url https://app.polygonone.com/api/dds-statements \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceNumber": "<string>",
    "verificationNumber": "<string>",
    "status": "draft",
    "type": "import",
    "source": "internal",
    "country": "<string>",
    "submittedOn": "2023-11-07T05:31:56Z",
    "declaration": true,
    "fullName": "<string>",
    "notes": "<string>",
    "totalVolume": 123,
    "totalAssignedVolume": 123,
    "totalRemainingVolume": 123,
    "errorMessage": "<string>",
    "articles": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ddsStatementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "supplierArticleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "volume": 123,
        "assignedVolume": 123,
        "remainingVolume": 123,
        "article": {
          "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": [
            {
              "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": "<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>"
        },
        "supplier": {
          "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": "<array>"
        }
      }
    ],
    "orders": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "orderNumber": "<string>",
        "orderDate": "2023-11-07T05:31:56Z",
        "orderType": "purchase",
        "supplier": {
          "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": "<array>"
        },
        "totalVolume": 123,
        "lines": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "article": {
              "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": [
                {
                  "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": "<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>"
            },
            "quantity": 123
          }
        ],
        "ddsReferences": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "referenceNumber": "<string>",
            "verificationNumber": "<string>"
          }
        ]
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

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

Response

List of DDS statements

​
id
string<uuid>
​
referenceNumber
string | null

TRACES reference number (assigned after submission)

​
verificationNumber
string | null

TRACES verification number (assigned after validation)

​
status
enum<string>

DDS lifecycle status. draft → processing → submitted → validated (success) or rejected/failed (error). external = imported from another system.

Available options:
draft,
processing,
submitted,
validated,
rejected,
under_control,
correction_requested,
deleted,
failed,
external
​
type
enum<string>

import = goods entering the EU, export = goods leaving the EU, trade = intra-EU trade, domestic_production = produced within the EU

Available options:
import,
export,
trade,
domestic_production
​
source
enum<string>

internal = created in Polygon One, external = imported/linked from another system

Available options:
internal,
external
​
country
string | null
​
submittedOn
string<date-time> | null
​
declaration
boolean
​
fullName
string | null
​
notes
string | null
​
totalVolume
number
​
totalAssignedVolume
number
​
totalRemainingVolume
number
​
errorMessage
string | null

Error message if submission failed

​
articles
object[]
​
orders
object[]

Orders assigned to this DDS statement