v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Production

🔒 Create production 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:create.

Create a new production.

post/api/v3/productions

Request body

productionStartDatestring date

Production start date

productionEndDatestring date

Production end date

produceQuantitynumber float

Quantity of the product to produce

functionTestboolean

Whether function testing is required

createSerialNumbersboolean

Whether to create serial numbers

recordSubSerialNumbersboolean

Whether to record sub-serial numbers

materialReservation'instant' | 'onRelease' | 'onStart'

Material reservation method

materialRetrieval'single' | 'collective'

Material retrieval method

documentDatestring date

Document creation date

stockRetrievalDatestring date

Stock retrieval date

stockProvisioningDatestring date

Stock provisioning date

bodyTextstring

Body text for production notes

internalDesignationstring

Internal designation for production

internalCommentstring

Internal comment for production

resolveMultiLevelBOMboolean

Whether to resolve multi-level bill of materials

tagsstring[]

Tags for categorizing the production

Example request

{
  "preferredWarehouse": {
    "id": "42"
  },
  "address": {
    "id": "13"
  },
  "project": {
    "id": "13"
  },
  "salesOrder": {
    "id": "13"
  },
  "productionStartDate": "2024-01-15",
  "productionEndDate": "2024-01-20",
  "produceProduct": {
    "id": "13"
  },
  "produceQuantity": 100,
  "functionTest": true,
  "materialReservation": "onRelease",
  "materialRetrieval": "collective",
  "documentDate": "2024-01-10",
  "stockRetrievalDate": "2024-01-25",
  "stockProvisioningDate": "2024-01-20",
  "bodyText": "Additional production notes",
  "internalDesignation": "Internal production reference",
  "internalComment": "Internal production comment",
  "printSettings": {
    "showTaskDescription": true
  },
  "tags": [
    "urgent",
    "quality-check"
  ]
}

Response

Create a new production.

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"
  }
}