The ELAM ERP Connector is a REST interface through which your ERP system creates orders, variants and components in ELAM and queries the status of orders and products.
The interface works on a request basis: your ERP system (or your middleware) calls ELAM. ELAM does not send messages to your ERP system on its own – you query the current status.
There are three ways to get orders into ELAM:
Important: The token is valid for 30 days and is not renewed automatically. After that, the ERP Connector responds with 401 and the interface stops until a new token is stored. Note the "valid until" date and create a new token in time. The token belongs to the user who created it and carries that user's permissions.
In ELAM, every product is processed and traced individually (lot size 1). Production orders from the ERP system with a lot size greater than 1 are split into individual products on import.
A call to POST /{tenantId}/orders/import creates one production order. Example:
{ "productionOrderNumber": "4711", "variantNumber": "V-100", "quantity": 3 }
If you do not send serial numbers, ELAM generates them using the fixed scheme order number-running number (5 digits). For order 4711 with lot size 3:
Allowed characters: order and serial numbers may contain letters, digits, spaces and - . / : # _ \. Variant and component numbers may contain letters, digits, spaces and - . /.
Note: Importing the same order number again is rejected (error ProductionOrderIdAlreadyUsed). An import never overwrites an existing order. If your system receives this error on a retry, the order has already been created.
You can include one or more bills of material (BOMs) with each order. A BOM picking step in the flowchart loads them by name (see BOM Picking):
Note: The components must already exist in ELAM – import them first (see below), otherwise the order is rejected with the error ComponentsNotFound. Via the ERP Connector, BOMs exist only on the order, not as master data of a variant.
Variants (POST /{tenantId}/variants/import) and components (POST /{tenantId}/components/import) are imported as a list. For both:
You still need to assign imported variants to stations and a flowchart in ELAM Administration.
PUT /{tenantId}/orders/{orderId} adds further products to an existing order. You pass the number of additional products (quantity) and optionally their serial numbers. Without serial numbers, the running number continues: if order 4711 had three products, 4711-00004 etc. are created.
Not possible: changing the variant, order number or BOMs of an order, or reducing the lot size. To do this, delete the order while it has not been started yet and import it again.
PUT /{tenantId}/variants/{variantId} or PUT /{tenantId}/components/{componentId} changes the number, name, comment and scan code of a variant or component.
The searches for orders, products, variants and components support the parameters top, skip, count, filter, search and orderBy (without a $ sign), e.g. ?filter=number eq '4711'. The response contains the results (value) and their total count (odataCount).
GET /{tenantId}/orders returns for each order:
GET /{tenantId}/orders/{orderId}/products returns the products of an order (with ELAM ID, serial number, state and lock). The ERP Connector does not return a good/bad quantity or an end time per order; derive these values from the products.
GET /{tenantId}/products searches products, GET /{tenantId}/products/{productId} returns the details of a product:
Product progress: With the flowchart step "Product progress" you mark points in the process. As soon as a product passes the step, its progress ID appears in the product details. ELAM does not report the progress to your ERP system on its own – query the product details. You enable the step type on the ERP Connector page with the Product Progress switch.
PUT /{tenantId}/products/lock or /unlock locks or unlocks products (list of product IDs). A locked product cannot be started at the station; if it is in progress, the process at the station is stopped. The time and user of the lock are stored.
If the ERP Connector rejects a request, the response contains a key field that states the reason. Evaluate the key, not just the HTTP status – on import and update, business errors are always returned with status 409.
The variant has no stations or no flowchart assigned – usually because it was newly created during the import. Open the variant in ELAM Administration and assign stations and a flowchart.
The token expired after 30 days. Create a new token and store it.
No. The ERP Connector creates data, changes it only on explicit request and never overwrites anything on import. Changes you make to variants or orders in ELAM remain until your ERP system changes them via PUT.
No, not on its own. Your ERP system queries orders and products, e.g. at a fixed interval.
For activation and interface errors, your ELAM contact person or ELAM Support. Please include the time, the address called, the HTTP status and the complete response. For your ERP system and middleware, your own IT or integration partner.
