Manufacturing

Production processes

The production processes operations of the Core API.

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

Method	Path	Operation
GET	`/api/v1/processes/{processId}`	Get production process
PUT	`/api/v1/processes/{processId}`	Update production process
DELETE	`/api/v1/processes/{processId}`	Delete production process
POST	`/api/v1/processes`	Create production process
POST	`/api/v1/processes/{processId}/activate`	Activate production process

Get production process

GET/api/v1/processes/{processId}

Access. Send a bearer token or an API key. The caller needs the Products view permission.

Parameters

Name	In	Type	Required	Description
`processId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ProductionProcessResponse.

Request

curl -X GET "https://api.miridia.io/api/v1/processes/{processId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productTitle": "string",
    "productCode": "string",
    "title": "string",
    "description": "string",
    "status": "Draft",
    "revisionNumber": 0,
    "effectiveDate": "2026-09-29T08:00:00Z",
    "expiryDate": "2026-09-29T08:00:00Z",
    "steps": [
      {}
    ]
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Update production process

PUT/api/v1/processes/{processId}

Access. Send a bearer token or an API key. The caller needs the Products modify permission.

Parameters

Name	In	Type	Required	Description
`processId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape UpdateProductionProcessCommand.

Field	Type	Required	Description
`id`	`string (uuid)`	No
`productId`	`string (uuid)`	No
`title`	`string`	No
`description`	`string`	No
`status`	`enum ProcessStatus`	No	One of: `Draft`, `Active`, `Blocked`, `Superseded`.
`revisionNumber`	`integer (int32)`	No
`effectiveDate`	`string (date-time)`	No
`expiryDate`	`string (date-time)`	No
`steps`	`ProcessStepRequest[]`	No

Response

200. Returns a SingleResult envelope. The data field is ProductionProcessResponse.

Request

curl -X PUT "https://api.miridia.io/api/v1/processes/{processId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "status": "Draft",
  "revisionNumber": 0,
  "effectiveDate": "2026-09-29T08:00:00Z",
  "expiryDate": "2026-09-29T08:00:00Z",
  "steps": [
    {
      "stepNumber": 0,
      "title": "string",
      "instructions": "string",
      "expectedDurationMinutes": 0,
      "equipmentRequired": "string",
      "sortOrder": 0,
      "consumes": [
        {}
      ]
    }
  ]
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productTitle": "string",
    "productCode": "string",
    "title": "string",
    "description": "string",
    "status": "Draft",
    "revisionNumber": 0,
    "effectiveDate": "2026-09-29T08:00:00Z",
    "expiryDate": "2026-09-29T08:00:00Z",
    "steps": [
      {}
    ]
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Delete production process

DELETE/api/v1/processes/{processId}

Access. Send a bearer token or an API key. The caller needs the Products delete permission.

Parameters

Name	In	Type	Required	Description
`processId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X DELETE "https://api.miridia.io/api/v1/processes/{processId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Create production process

POST/api/v1/processes

Access. Send a bearer token or an API key. The caller needs the Products modify permission.

Request body

Send JSON with the shape CreateProductionProcessCommand.

Field	Type	Required	Description
`productId`	`string (uuid)`	No
`title`	`string`	No
`description`	`string`	No
`status`	`enum ProcessStatus`	No	One of: `Draft`, `Active`, `Blocked`, `Superseded`.
`revisionNumber`	`integer (int32)`	No
`effectiveDate`	`string (date-time)`	No
`expiryDate`	`string (date-time)`	No
`steps`	`ProcessStepRequest[]`	No

Response

200. Returns a SingleResult envelope. The data field is ProductionProcessResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/processes" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "string",
  "description": "string",
  "status": "Draft",
  "revisionNumber": 0,
  "effectiveDate": "2026-09-29T08:00:00Z",
  "expiryDate": "2026-09-29T08:00:00Z",
  "steps": [
    {
      "stepNumber": 0,
      "title": "string",
      "instructions": "string",
      "expectedDurationMinutes": 0,
      "equipmentRequired": "string",
      "sortOrder": 0,
      "consumes": [
        {}
      ]
    }
  ]
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productTitle": "string",
    "productCode": "string",
    "title": "string",
    "description": "string",
    "status": "Draft",
    "revisionNumber": 0,
    "effectiveDate": "2026-09-29T08:00:00Z",
    "expiryDate": "2026-09-29T08:00:00Z",
    "steps": [
      {}
    ]
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Activate production process

POST/api/v1/processes/{processId}/activate

Access. Send a bearer token or an API key. The caller needs the Products modify permission.

Parameters

Name	In	Type	Required	Description
`processId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is ProductionProcessResponse.

Request

curl -X POST "https://api.miridia.io/api/v1/processes/{processId}/activate" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productTitle": "string",
    "productCode": "string",
    "title": "string",
    "description": "string",
    "status": "Draft",
    "revisionNumber": 0,
    "effectiveDate": "2026-09-29T08:00:00Z",
    "expiryDate": "2026-09-29T08:00:00Z",
    "steps": [
      {}
    ]
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Models

The operations on this page use these object types. Select a type to see its fields.

ProcessStepMaterialRequest

Field	Type	Description
`componentProductId`	`string (uuid)`

ProcessStepMaterialResponse

Field	Type	Description
`id`	`string (uuid)`
`componentProductId`	`string (uuid)`
`componentTitle`	`string`
`componentCode`	`string`
`componentSku`	`string`
`componentType`	`enum ProductType`	One of: `FinishedGood`, `RawMaterial`, `Component`, `Consumable`, `Service`.

ProcessStepRequest

Field	Type	Description
`stepNumber`	`integer (int32)`
`title`	`string`
`instructions`	`string`
`expectedDurationMinutes`	`number (double)`
`equipmentRequired`	`string`
`sortOrder`	`integer (int32)`
`consumes`	`ProcessStepMaterialRequest[]`	Optional component products this step consumes (soft hint).

ProcessStepResponse

Field	Type	Description
`id`	`string (uuid)`
`stepNumber`	`integer (int32)`
`title`	`string`
`instructions`	`string`
`expectedDurationMinutes`	`number (double)`
`equipmentRequired`	`string`
`sortOrder`	`integer (int32)`
`consumes`	`ProcessStepMaterialResponse[]`

ProductionProcessResponse

Field	Type	Description
`id`	`string (uuid)`
`productId`	`string (uuid)`
`productTitle`	`string`
`productCode`	`string`
`title`	`string`
`description`	`string`
`status`	`enum ProcessStatus`	One of: `Draft`, `Active`, `Blocked`, `Superseded`.
`revisionNumber`	`integer (int32)`
`effectiveDate`	`string (date-time)`
`expiryDate`	`string (date-time)`
`steps`	`ProcessStepResponse[]`

Bills of material

The bills of material operations of the Core API.

Work orders

The work orders operations of the Core API.