> ## Documentation Index
> Fetch the complete documentation index at: https://help.polygon-one.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Artikel auflisten

> Retrieve a paginated list of articles. Supports filtering by article number, HS code, commodity group, article type, and EUDR relevance.



## OpenAPI

````yaml GET /api/articles
openapi: 3.1.0
info:
  title: Polygon One EUDR Compliance API
  description: >-
    API for integrating ERP systems with the Polygon One EUDR Compliance
    Platform. Allows management of Articles, Suppliers, Orders, and Due
    Diligence Statements (DDS).
  version: 1.0.0
servers:
  - url: https://app.polygon-one.com
    description: Production Server
security:
  - bearerAuth: []
paths:
  /api/articles:
    get:
      summary: List Articles
      description: >-
        Retrieve a paginated list of articles. Supports filtering by article
        number, HS code, commodity group, article type, and EUDR relevance.
      operationId: listArticles
      parameters:
        - name: internalArticleNr
          in: query
          description: Filter by internal article number (ERP ID)
          schema:
            type: string
        - name: externalArticleNr
          in: query
          description: Filter by external article number
          schema:
            type: string
        - name: hsCode
          in: query
          description: Filter by HS code
          schema:
            type: string
        - name: commodityGroup
          in: query
          description: Filter by commodity group
          schema:
            $ref: '#/components/schemas/CommodityGroup'
        - name: articleType
          in: query
          description: Filter by article type
          schema:
            $ref: '#/components/schemas/ArticleType'
        - name: eudrRelevant
          in: query
          description: Filter by EUDR relevance
          schema:
            type: boolean
        - name: limit
          in: query
          description: Maximum number of results to return
          schema:
            type: integer
            default: 100
        - name: offset
          in: query
          description: Number of results to skip for pagination
          schema:
            type: integer
            default: 0
      responses:
        '200':
          description: List of articles
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Article'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    CommodityGroup:
      type: string
      enum:
        - cattle
        - cocoa
        - coffee
        - oil_palm
        - rubber
        - soya
        - wood
        - non_relevant
      description: >-
        EUDR-regulated commodity groups. `non_relevant` = article is not covered
        by EUDR.
    ArticleType:
      type: string
      enum:
        - purchase
        - sale
      description: >-
        `purchase` = inbound article from a supplier, `sale` = outbound article
        you sell
    Article:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        internalArticleNr:
          type: string
          description: Internal article number (ERP ID)
        externalArticleNr:
          type:
            - string
            - 'null'
        hsCode:
          type: string
          description: Harmonized System code
        ean:
          type:
            - string
            - 'null'
        shortDescription:
          type:
            - string
            - 'null'
        eudrRelevant:
          type: boolean
          description: Automatically determined from HS code
        articleType:
          $ref: '#/components/schemas/ArticleType'
        commodityGroup:
          $ref: '#/components/schemas/CommodityGroup'
        suppliers:
          type: array
          items:
            $ref: '#/components/schemas/Supplier'
        complianceResults:
          type: array
          items:
            $ref: '#/components/schemas/ComplianceResult'
        countryOfProduction:
          type:
            - string
            - 'null'
    Supplier:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type:
            - string
            - 'null'
        contactName:
          type:
            - string
            - 'null'
        country:
          type: string
        externalSupplierId:
          type:
            - string
            - 'null'
          description: External ID from your ERP system
        address:
          $ref: '#/components/schemas/Address'
        status:
          $ref: '#/components/schemas/SupplierStatus'
        isCompanySelf:
          type: boolean
          description: >-
            True if this supplier represents your own company (for sale
            articles)
        articles:
          type: array
          items:
            $ref: '#/components/schemas/Article'
    ComplianceResult:
      type: object
      properties:
        id:
          type: string
          format: uuid
        supplierArticleId:
          type: string
          format: uuid
        overallStatus:
          $ref: '#/components/schemas/ComplianceStatus'
        geoStatus:
          $ref: '#/components/schemas/ComplianceStatus'
        legalStatus:
          $ref: '#/components/schemas/ComplianceStatus'
        generatedReportUrl:
          type:
            - string
            - 'null'
        generatedAt:
          type:
            - string
            - 'null'
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        details:
          description: Additional error details (e.g. validation issues)
      required:
        - error
    Address:
      type: object
      required:
        - street
        - postalCode
        - city
      properties:
        street:
          type: string
        postalCode:
          type: string
        city:
          type: string
        additional:
          type: string
        validated:
          type: boolean
        latitude:
          type: number
        longitude:
          type: number
    SupplierStatus:
      type: string
      enum:
        - data_incomplete
        - data_complete
        - dds_submitted
      description: Supplier data completeness status
    ComplianceStatus:
      type: string
      enum:
        - compliant
        - non_compliant
        - invalid
        - unknown
        - not_eudr_relevant
        - pending_review
        - not_required_before_cutoff
      description: >-
        `invalid` = geolocation present but rejected as invalid (data-quality
        failure, blocks a compliant verdict until corrected);
        `not_required_before_cutoff` = article placed before the EUDR
        application date and not yet in scope.
  responses:
    Unauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Insufficient permissions for this resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key generated in Settings > API Keys. Include as `Authorization:
        Bearer <key>`.

````