Skip to main content
PATCH
/
api
/
articles
/
{id}
Update Article
curl --request PATCH \
  --url https://app.polygonone.com/api/articles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": {
    "name": "<string>",
    "shortDescription": "<string>",
    "internalArticleNr": "<string>",
    "externalArticleNr": "<string>",
    "ean": "<string>",
    "hsCode": "<string>",
    "articleType": "purchase"
  },
  "supplierIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "success": true,
  "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>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Body

application/json
fields
object

Article fields to update

supplierIds
string<uuid>[]

Replace all supplier associations with this list of supplier IDs

Response

Updated successfully

success
boolean
article
object