Skip to main content
POST
/
api
/
articles
Create Article
curl --request POST \
  --url https://app.polygonone.com/api/articles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "internalArticleNr": "<string>",
  "hsCode": "<string>",
  "shortDescription": "<string>",
  "externalArticleNr": "<string>",
  "ean": "<string>",
  "articleType": "purchase",
  "supplierId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "supplierName": "<string>",
  "supplierEmail": "jsmith@example.com"
}
'
{
  "imported": [
    {}
  ],
  "failed": [
    {
      "error": "<string>"
    }
  ],
  "skipped": 123
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Article name

internalArticleNr
string
required

Internal article number (must be unique per company)

hsCode
string
required

HS code — EUDR relevance and commodity group are determined automatically

shortDescription
string
externalArticleNr
string
ean
string
articleType
enum<string>

Defaults to purchase. Sale articles are automatically linked to your company as supplier.

Available options:
purchase,
sale
supplierId
string<uuid>

Link to an existing supplier. Required for purchase articles if supplierName is not provided.

supplierName
string

Supplier name. Used to find or create a supplier if supplierId is not provided. Required for purchase articles if supplierId is not provided.

supplierEmail
string<email>

Optional supplier contact email. Used when creating a new supplier via supplierName.

Response

Batch import result

imported
object[]

Successfully imported items

failed
object[]

Items that failed to import

skipped
integer

Number of skipped (duplicate) items