Inhaltsverzeichnis

mes

Manufacturing (MES)

Shop-floor execution — production orders, work centers with live OEE, bills of materials, routings, completion and scrap reporting. The MES endpoints drive and observe what happens on the line: release an order, report finished quantity, log downtime, and read equipment effectiveness in real time.

GET/v1/mes/production-ordersScope: mes:read

List production orders

Returns a cursor-paginated list of production orders. Filter by status or work center; use updated_since for incremental sync.

Query parameters

limitoptional	integerPage size, 1–200 (default 50).
cursoroptional	stringPagination cursor from a previous response.
updated_sinceoptional	stringRFC 3339 timestamp; return orders changed after it.
statusoptional	stringFilter by status: planned, released, in_progress or done.
work_center_idoptional	stringFilter by the assigned work center.

Request

curl "https://api.apusplatform.com/v1/mes/production-orders" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "pro_7f3a",
      "product_sku": "PUMP-A200",
      "quantity": 500,
      "quantity_done": 180,
      "scrap": 4,
      "status": "in_progress",
      "work_center_id": "wc_assembly_1",
      "due_date": "2026-08-01",
      "updated_at": "2026-07-19T08:14:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "crsr_2b71"
}

POST/v1/mes/production-ordersScope: mes:write

Create a production order

Creates a production order in planned status. Release it separately to schedule work on the floor.

Body

product_skurequired	stringSKU of the finished good to produce.
quantityrequired	integerQuantity to produce (positive integer).
due_dateoptional	stringTarget completion date (YYYY-MM-DD).
work_center_idoptional	stringWork center to assign the order to.

Request

curl -X POST "https://api.apusplatform.com/v1/mes/production-orders" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_sku": "PUMP-A200",
    "quantity": 500,
    "due_date": "2026-08-01",
    "work_center_id": "wc_assembly_1"
  }'

Response

{
  "id": "pro_7f3a",
  "product_sku": "PUMP-A200",
  "status": "planned",
  "created_at": "2026-07-20T02:10:00Z"
}

GET/v1/mes/production-orders/{id}Scope: mes:read

Retrieve a production order

Returns a single production order by its id, including progress and scrap counters.

Path parameters

idrequired

stringProduction order id.

Request

curl "https://api.apusplatform.com/v1/mes/production-orders/pro_7f3a" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "id": "pro_7f3a",
  "product_sku": "PUMP-A200",
  "quantity": 500,
  "quantity_done": 180,
  "scrap": 4,
  "status": "in_progress",
  "work_center_id": "wc_assembly_1",
  "due_date": "2026-08-01",
  "released_at": "2026-07-16T01:00:00Z",
  "updated_at": "2026-07-19T08:14:00Z"
}

POST/v1/mes/production-orders/{id}/releaseScope: mes:write

Release a production order

Moves a planned order to released so it can be dispatched to the work center. Consumes component reservations from the BOM.

Path parameters

idrequired

stringProduction order id.

Body

released_byoptional

stringUser id recording the release.

Request

curl -X POST "https://api.apusplatform.com/v1/mes/production-orders/pro_7f3a/release" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "released_by": "usr_ops_12"
  }'

Response

{
  "id": "pro_7f3a",
  "status": "released",
  "released_at": "2026-07-16T01:00:00Z"
}

POST/v1/mes/production-orders/{id}/completionsScope: mes:write

Report a completion

Records a quantity of good (and optionally scrap) finished against a production order. Advances quantity_done; closes the order when it reaches the target.

Path parameters

idrequired

stringProduction order id.

Body

quantityrequired	integerGood quantity completed (positive integer).
scrapoptional	integerScrapped quantity in this report.
work_center_idoptional	stringWork center where the work was done.

Request

curl -X POST "https://api.apusplatform.com/v1/mes/production-orders/cmp_4d81/completions" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "quantity": 120,
    "scrap": 3,
    "work_center_id": "wc_assembly_1"
  }'

Response

{
  "id": "cmp_4d81",
  "production_order_id": "pro_7f3a",
  "quantity": 120,
  "scrap": 3,
  "quantity_done": 180,
  "created_at": "2026-07-19T08:14:00Z"
}

GET/v1/mes/work-centersScope: mes:read

List work centers

Returns work centers with their current status and live OEE (availability × performance × quality).

No parameters.

Request

curl "https://api.apusplatform.com/v1/mes/work-centers" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "wc_assembly_1",
      "name": "Assembly line 1",
      "status": "running",
      "oee": {
        "availability": 0.92,
        "performance": 0.88,
        "quality": 0.97,
        "oee": 0.785
      },
      "updated_at": "2026-07-20T03:00:00Z"
    }
  ]
}

GET/v1/mes/work-centers/{id}Scope: mes:read

Retrieve a work center

Returns a single work center by its id, including its live OEE breakdown.

Path parameters

idrequired

stringWork center id.

Request

curl "https://api.apusplatform.com/v1/mes/work-centers/wc_assembly_1" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "id": "wc_assembly_1",
  "name": "Assembly line 1",
  "status": "running",
  "oee": {
    "availability": 0.92,
    "performance": 0.88,
    "quality": 0.97,
    "oee": 0.785
  },
  "updated_at": "2026-07-20T03:00:00Z"
}

GET/v1/mes/bomsScope: mes:read

List bills of materials

Returns bills of materials. Filter by the finished-good SKU they build.

Query parameters

product_skuoptional

stringFilter by the finished-good SKU.

Request

curl "https://api.apusplatform.com/v1/mes/boms" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "bom_3c9f",
      "product_sku": "PUMP-A200",
      "components": [
        {
          "sku": "MOTOR-1KW",
          "quantity": 1
        },
        {
          "sku": "STEEL-BRKT-08",
          "quantity": 4
        }
      ]
    }
  ]
}

POST/v1/mes/bomsScope: mes:write

Create a bill of materials

Creates a bill of materials for a finished good. Each component references a stocked SKU and a per-unit quantity.

Body

product_skurequired	stringSKU of the finished good this BOM builds.
componentsrequired	arrayComponent lines, each { sku, quantity }.

Request

curl -X POST "https://api.apusplatform.com/v1/mes/boms" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_sku": "PUMP-A200",
    "components": [
      {
        "sku": "MOTOR-1KW",
        "quantity": 1
      },
      {
        "sku": "STEEL-BRKT-08",
        "quantity": 4
      }
    ]
  }'

Response

{
  "id": "bom_3c9f",
  "product_sku": "PUMP-A200",
  "created_at": "2026-07-20T02:10:00Z"
}

GET/v1/mes/boms/{id}Scope: mes:read

Retrieve a bill of materials

Returns a single bill of materials by its id, with its component lines.

Path parameters

idrequired

stringBOM id.

Request

curl "https://api.apusplatform.com/v1/mes/boms/bom_3c9f" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "id": "bom_3c9f",
  "product_sku": "PUMP-A200",
  "components": [
    {
      "sku": "MOTOR-1KW",
      "quantity": 1
    },
    {
      "sku": "STEEL-BRKT-08",
      "quantity": 4
    }
  ]
}

GET/v1/mes/routingsScope: mes:read

List routings

Returns routings — the ordered operations (with standard times) a finished good passes through.

Query parameters

product_skuoptional

stringFilter by the finished-good SKU.

Request

curl "https://api.apusplatform.com/v1/mes/routings" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "rtg_a12b",
      "product_sku": "PUMP-A200",
      "operations": [
        {
          "seq": 10,
          "name": "Machining",
          "work_center_id": "wc_machining_2",
          "std_minutes": 12
        },
        {
          "seq": 20,
          "name": "Assembly",
          "work_center_id": "wc_assembly_1",
          "std_minutes": 8
        }
      ]
    }
  ]
}

POST/v1/mes/work-centers/{id}/downtimeScope: mes:write

Log downtime

Records a downtime event against a work center. Downtime lowers the availability factor of the work center's live OEE.

Path parameters

idrequired

stringWork center id.

Body

reasonrequired	stringDowntime reason code, e.g. tooling-change, breakdown.
minutesrequired	integerDuration of the downtime in minutes (positive integer).

Request

curl -X POST "https://api.apusplatform.com/v1/mes/work-centers/dtm_9a27/downtime" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "tooling-change",
    "minutes": 25
  }'

Response

{
  "id": "dtm_9a27",
  "work_center_id": "wc_assembly_1",
  "reason": "tooling-change",
  "minutes": 25,
  "logged_at": "2026-07-20T03:00:00Z"
}

GET/v1/mes/scrapScope: mes:read

List scrap records

Returns scrap records reported on the floor. Filter by work center and a start timestamp.

Query parameters

work_center_idoptional	stringFilter by the work center that reported the scrap.
fromoptional	stringRFC 3339 timestamp; return scrap logged on or after it.

Request

curl "https://api.apusplatform.com/v1/mes/scrap" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "scr_5b19",
      "production_order_id": "pro_7f3a",
      "work_center_id": "wc_assembly_1",
      "quantity": 3,
      "reason": "misaligned-weld",
      "logged_at": "2026-07-19T08:14:00Z"
    }
  ]
}

Bereit zur Integration?

Erstellen Sie einen API-Client in der Account-Konsole, um Ihre Zugangsdaten zu erhalten, oder sprechen Sie mit einem Integrationsingenieur über Ihren Anwendungsfall.

API-Zugangsdaten erhalten Mit einem Integrationsingenieur sprechen

← PrevPurchasing Next →Finance & Accounting