> ## 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.

# List Orders

> Retrieve orders (purchase and sale) associated with your company, each hydrated with the DDS statements linked to it (`ddsReferences`). This is the read-back path for an ERP integration: push orders with `POST /api/orders`, then read them here to collect the TRACES reference and verification number for each order, keyed by your own `orderNumber`.

All query parameters are optional. A request with none returns every order for your company. Malformed parameter values are rejected with `400` rather than ignored, so a polling integration can never silently receive the full set in place of the subset it asked for.



## OpenAPI

````yaml GET /api/orders
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/orders:
    get:
      summary: List Orders
      description: >-
        Retrieve orders (purchase and sale) associated with your company, each
        hydrated with the DDS statements linked to it (`ddsReferences`). This is
        the read-back path for an ERP integration: push orders with `POST
        /api/orders`, then read them here to collect the TRACES reference and
        verification number for each order, keyed by your own `orderNumber`.


        All query parameters are optional. A request with none returns every
        order for your company. Malformed parameter values are rejected with
        `400` rather than ignored, so a polling integration can never silently
        receive the full set in place of the subset it asked for.
      operationId: listOrders
      parameters:
        - name: hasDdsReference
          in: query
          description: >-
            Restrict to orders that already have a DDS statement linked
            (`true`), or to orders that have none yet (`false`). Note this means
            a DDS is *linked*, not that it has been submitted to TRACES — a
            linked but unsubmitted DDS appears with an empty `referenceNumber`.
          schema:
            type: boolean
        - name: orderNumbers
          in: query
          description: >-
            Comma-separated list of order numbers to return, e.g. `ORD-1,ORD-2`.
            Maximum 1000 values. Pass the parameter once — repeating the key is
            rejected rather than silently using only the first value. An empty
            list is rejected with `400`.
          schema:
            type: string
          example: ORD-1,ORD-2
        - name: limit
          in: query
          description: >-
            Maximum number of results to return. Omit to return all orders —
            unlike `/api/articles`, this endpoint applies no default limit.
          schema:
            type: integer
            minimum: 1
        - name: offset
          in: query
          description: >-
            Number of results to skip for pagination. Results are returned in a
            stable total order, so paging with `limit` and `offset` never skips
            or repeats an order.
          schema:
            type: integer
            default: 0
            minimum: 0
      responses:
        '200':
          description: List of orders
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Order'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Order:
      type: object
      properties:
        id:
          type: string
          format: uuid
        orderNumber:
          type: string
        orderDate:
          type: string
          format: date-time
        orderType:
          $ref: '#/components/schemas/OrderType'
        supplier:
          $ref: '#/components/schemas/Supplier'
        totalVolume:
          type: number
          description: Sum of all order line quantities
        lines:
          type: array
          items:
            $ref: '#/components/schemas/OrderLine'
        ddsReferences:
          type: array
          description: DDS statements linked to this order
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              referenceNumber:
                type: string
              verificationNumber:
                type: string
    OrderType:
      type: string
      enum:
        - purchase
        - sale
      description: >-
        `purchase` = inbound order from a supplier, `sale` = outbound order to a
        customer
    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'
    OrderLine:
      type: object
      properties:
        id:
          type: string
          format: uuid
        article:
          $ref: '#/components/schemas/Article'
        quantity:
          type: number
          description: >-
            Net mass in kilograms. Derived from `pieceCount × weightPerPieceKg`
            when the line was created with `pieceCount` instead of `quantity`.
        pieceCount:
          type:
            - number
            - 'null'
          description: >-
            Number of pieces, when the line was quantified by piece count rather
            than net mass.
        volumeM3:
          type:
            - number
            - 'null'
          description: >-
            Volume in m³. Feeds the EUDR DDS supplementary unit (MTQ) for HS
            codes that require it.
        dryWeight90Kg:
          type:
            - number
            - 'null'
          description: >-
            Kilograms of 90 %-dry substance. Feeds the EUDR DDS supplementary
            unit (KSD) for wood-pulp HS codes.
    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
    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'
    ArticleType:
      type: string
      enum:
        - purchase
        - sale
      description: >-
        `purchase` = inbound article from a supplier, `sale` = outbound article
        you sell
    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.
    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
    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:
    BadRequest:
      description: Invalid request data
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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>`.

````