Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Production

🔒 List productions V3

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: production:read.

Paginated list of productions.

get/api/v3/productions

Query parameters

key'id' | 'documentNumber' | 'documentDate' | 'writeProtection' | 'address.id' | 'project.id' | 'tags' | 'status' | 'internalComment' | 'internalDesignation' | 'productionStartDate' | 'productionEndDate' | 'stockRetrievalDate' | 'stockProvisioningDate' | 'materialReservation' | 'materialRetrieval' | 'resolveMultiLevelBOM' | 'functionTest' | 'createSerialNumbers' | 'recordSubSerialNumbers' | 'printSettings.showTaskDescription' | 'bodyText' | 'preferredWarehouse.id' | 'salesOrder.id' | 'createdAt' | 'updatedAt'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'lessThan' | 'lessThanOrEquals' | 'greaterThan' | 'greaterThanOrEquals'

operator

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn

documentNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

documentDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

writeProtection: equals, notEquals

address.id: equals, notEquals, in, notIn

project.id: equals, notEquals, in, notIn

tags: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

status: equals, notEquals, in, notIn

internalComment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

internalDesignation: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

productionStartDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

productionEndDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

stockRetrievalDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

stockProvisioningDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

materialReservation: equals, notEquals, in, notIn

materialRetrieval: equals, notEquals, in, notIn

resolveMultiLevelBOM: equals, notEquals

functionTest: equals, notEquals

createSerialNumbers: equals, notEquals

recordSubSerialNumbers: equals, notEquals

printSettings.showTaskDescription: equals, notEquals

bodyText: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

preferredWarehouse.id: equals, notEquals, in, notIn

salesOrder.id: equals, notEquals, in, notIn

createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals

sortstring[]

Sort via id, -id, documentNumber, -documentNumber, documentDate, -documentDate, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is -created_at

includestring[]
perPageinteger
Example:15

Number of items per page. Default: 15, Max: 100

pageinteger
Example:1

Page number.

Response

Paginated list of productions.

Example response

{
  "data": [
    {
      "id": "1",
      "documentNumber": "PROD-12345",
      "documentDate": "2024-01-15",
      "status": "draft",
      "address": {
        "id": "42",
        "createdAt": "2025-03-15T09:27:00+01:00",
        "updatedAt": "2025-10-20T14:45:12+01:00"
      },
      "project": {
        "id": "54",
        "name": "Standard Project",
        "abbreviation": "STANDARD"
      },
      "salesOrder": {
        "id": "1"
      },
      "produceProduct": {
        "createdAt": "2025-03-15T09:27:00+01:00",
        "updatedAt": "2025-10-20T14:45:12+01:00"
      },
      "produceQuantity": 10.5,
      "tags": [
        "urgent",
        "quality-check"
      ],
      "internalDesignation": "FB-3860-L",
      "materials": [
        {
          "id": "1",
          "number": "2462-SK-D",
          "name": "Strawberry Jam",
          "description": "Delicious strawberry jam made from fresh strawberries.",
          "quantity": 2,
          "parentLineItem": {
            "id": "1"
          },
          "sort": 1,
          "updatedAt": "2023-10-01T12:00:00Z",
          "createdAt": "2023-10-01T12:00:00Z"
        }
      ],
      "materialReservation": "on_release",
      "materialRetrieval": "single",
      "functionTest": true,
      "stockRetrievalDate": "2024-01-25",
      "stockProvisioningDate": "2024-01-20",
      "productionStartDate": "2024-01-15",
      "productionEndDate": "2024-01-20",
      "bodyText": "Additional production notes",
      "internalComment": "Internal production comment",
      "printSettings": {
        "showTaskDescription": true
      },
      "preferredWarehouse": {
        "id": "1"
      },
      "activity": [],
      "updatedAt": "2023-10-01T12:00:00Z",
      "createdAt": "2023-10-01T12:00:00Z"
    }
  ],
  "meta": {
    "currentPage": 1,
    "from": 1,
    "path": "https://api.example.com/items",
    "perPage": 15,
    "to": 15
  },
  "links": {
    "first": "https://api.example.com/items?page=1",
    "next": "https://api.example.com/items?page=17"
  }
}