Skip to main content
GET
/
api
/
orders
/
{id}
Get Order by ID
curl --request GET \
  --url https://app.polygonone.com/api/orders/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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": [
      {
        "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>"
      }
    ]
  },
  "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": "<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>.

Path Parameters

​
id
string<uuid>
required

Response

Order details including lines and DDS references

​
id
string<uuid>
​
orderNumber
string
​
orderDate
string<date-time>
​
orderType
enum<string>

purchase = inbound order from a supplier, sale = outbound order to a customer

Available options:
purchase,
sale
​
supplier
object
​
totalVolume
number

Sum of all order line quantities

​
lines
object[]
​
ddsReferences
object[]

DDS statements linked to this order