Production orders API
General:
Basics:
Parameters in the url should all be encoded and all data sent should be UTF-8
MAX number of requests per minute is set to 200.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.
Headers:
There are 2 ways to be authenticated when using this API. in both ways you add headers to the request.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.
store: <<STORE>> user_id: <<USER_ID>> user_token: <<USER_TOKEN>> api_key: <<API_KEY>> Accept: application/json Content-Type: application/json
Errors:
Code | Description |
---|---|
900001 | Credentials don't match |
900101 | Common error |
900429 | Too many requests |
903001 | Error when getting production order |
903002 | Error when creating a production order |
903003 | Error when updating a production order |
903004 | Error when getting customer order |
{ "errorCode" : 900101, "errorMessage" : "Something went wrong on the server", "errorField" : null, "errorData" : null }
Production orders API:
Customer orders
Create production order from customer order
POSTUrl: /customer_order/{customer_order_id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Create production order from an existing customer order
Body:
Successfull response:
{ "finishedAmount": 2467.904149955339, "orderId": 5436, "endDate": 1746811072599, "prReference": "prReference", "customerOrderId": 2644, "workHours": 4003.236228353567, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 376.994094173827, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7739.447261400109, "partAmount": 6103.834227027345, "totalReserved": 2858.257556082544 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5969.0058279275845, "name": "name", "comment": "comment", "finishDate": 1746811072599, "storeState": 8527, "state": "0", "articles": [{ "waste": "0", "amount": 2134.392956956089, "articleName": "articleName", "productionOrderId": 2979, "articleId": "articleId", "accuracy": 3434.0837475827934, "finished": 8685.343677164565, "time": 6295.599821216185, "status": 7151 }], "startDate": 1746811072599, "reserveInDepth": "false" }
Print pickinglist
GETUrl: /{order_id}/pickinglist/print
Headers:
Accept: application/pdf or application/json
Print pickinglist of flat articles for production order
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
filter_non_available | false | ||
article_images | false | ||
order | asc | asc,desc | |
sort_column | art | art,name,supplier,supplier_art |
Production orders
Get batch and serial for a production order
GETUrl: /{order_id}/batch
Headers:
Accept: application/json or application/xml
Get batches and serial numbers for all the articles in a production order
Body:
Successfull response:
{ "countBatch": 1901, "batches": [{ "deliveredAmount": 1002.5958419786396, "serialNr": "serialNr", "bestBefore": 6665, "batchId": "batchId", "orderedAmount": 3717.5576286380983 }], "articleId": "articleId", "countSerial": 6576 }
Get production order for id
GETUrl: /{order_id}
Headers:
Accept: application/json or application/xml
Get production order based on id
Body:
Successfull response:
{ "finishedAmount": 2999.5942360933714, "orderId": 2281, "endDate": 1746811072600, "prReference": "prReference", "customerOrderId": 7028, "workHours": 8582.551386565217, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 634.0311962834954, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9122.086572246384, "partAmount": 9323.357934599564, "totalReserved": 1351.8717504106826 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7164.119280003971, "name": "name", "comment": "comment", "finishDate": 1746811072600, "storeState": 7388, "state": "0", "articles": [{ "waste": "0", "amount": 4514.43678440136, "articleName": "articleName", "productionOrderId": 4842, "articleId": "articleId", "accuracy": 9510.262245865582, "finished": 9730.985439302074, "time": 3849.18781191952, "status": 5408 }], "startDate": 1746811072600, "reserveInDepth": "false" }
Get production orders for state
GETUrl: /state/{state}
Headers:
Accept: application/json or application/xml
Get a list of production orders based on state
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
from | 0 | ||
to | 0 | ||
page | 0 | ||
limit | 50 | ||
sort_column | start_date | start_date,end_date | |
order | desc | asc,desc |
Body:
Successfull response:
{ "ordersCount": 394, "pages": 8966, "pageSize": 439, "orders": [{ "finishedAmount": 5867.3633654533605, "orderId": 6937, "endDate": 1746811072600, "prReference": "prReference", "customerOrderId": 8955, "workHours": 4518.361605744609, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9274.624460856889, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8983.837819644643, "partAmount": 8041.3240942221555, "totalReserved": 4192.099091633189 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9457.711346255719, "name": "name", "comment": "comment", "finishDate": 1746811072600, "storeState": 5780, "state": "0", "articles": [{ "waste": "0", "amount": 3640.710986781247, "articleName": "articleName", "productionOrderId": 706, "articleId": "articleId", "accuracy": 3544.1088361834827, "finished": 9076.84573281314, "time": 5470.688155403046, "status": 4417 }], "startDate": 1746811072600, "reserveInDepth": "false" }], "page": 849 }
Get production orders for customer order
GETUrl: /customer_order/{order_id}
Headers:
Accept: application/json or application/xml
Get a list of production orders connected to a customer order
Body:
Successfull response:
{ "ordersCount": 7783, "pages": 7928, "pageSize": 3143, "orders": [{ "finishedAmount": 6186.158779303355, "orderId": 1695, "endDate": 1746811072600, "prReference": "prReference", "customerOrderId": 3308, "workHours": 8915.207339016457, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7112.6397264912675, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1091.965229479639, "partAmount": 4547.462064101377, "totalReserved": 3788.288845636274 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9520.828164384657, "name": "name", "comment": "comment", "finishDate": 1746811072600, "storeState": 9294, "state": "0", "articles": [{ "waste": "0", "amount": 9600.699517173702, "articleName": "articleName", "productionOrderId": 966, "articleId": "articleId", "accuracy": 1697.4574639092255, "finished": 4807.80290822092, "time": 1273.3399091678189, "status": 1572 }], "startDate": 1746811072600, "reserveInDepth": "false" }], "page": 5284 }
Get production orders with article
GETUrl: /article/{article_id : .+}
Headers:
Accept: application/json or application/xml
Get a list of production orders that contains a specific article
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
max_state | |||
page | 0 | ||
limit | 50 | ||
sort_column | start_date | start_date,end_date | |
order | desc | asc,desc |
Body:
Successfull response:
{ "ordersCount": 4963, "pages": 588, "pageSize": 4472, "orders": [{ "finishedAmount": 2527.4674457757083, "orderId": 2667, "endDate": 1746811072600, "prReference": "prReference", "customerOrderId": 913, "workHours": 4654.765397714918, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1936.4503937397103, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6866.252769597209, "partAmount": 6095.048606941978, "totalReserved": 5064.897642985961 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4157.296845011319, "name": "name", "comment": "comment", "finishDate": 1746811072600, "storeState": 8403, "state": "0", "articles": [{ "waste": "0", "amount": 6134.5070311135605, "articleName": "articleName", "productionOrderId": 9875, "articleId": "articleId", "accuracy": 1262.044650350207, "finished": 7655.732559051621, "time": 6696.843410027916, "status": 2645 }], "startDate": 1746811072600, "reserveInDepth": "false" }], "page": 4746 }
Get flat products
GETUrl: /{order_id}/products/flat
Headers:
Accept: application/json or application/xml
Get a flat list of products for a production order based on id
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
query | |||
supplier | |||
order | asc | asc,desc | |
sort_column | art | art,name,supplier,supplier_art |
Body:
Successfull response:
{"articles": [{ "supplierName": "supplierName", "amount": 8648.666937791839, "articleName": "articleName", "supplierId": 1566, "purchasePriceMisc": 1209.7838676088534, "articleId": "articleId", "purchasePrice": 1177.7014846683587, "partAmount": 6182.085222738499, "stockplace": "stockplace", "unit": "unit", "reserved": 809.1363547602715, "purchasePriceShipment": 7840.569423235299, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 6157.019371587943, "orderId": 3354, "poRef": "poRef", "state": 9293, "deliveryDate": 1746811072600 }] }]}
Get po-ref for production order
GETUrl: /pr_ref/next_id
Headers:
Accept: application/json or application/xml
Get the next unique po-ref for production order
Get production orders between states
GETUrl: /production_orders_state
Headers:
Accept: application/json or application/xml
Get a list of production orders between two states
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
state_from | 0,1,2,3 | ||
state_to | 0,1,2,3 | ||
page | 0 | ||
limit | 20 | ||
query |
Body:
Successfull response:
{ "finishedAmount": 4658.175615936993, "orderId": 8568, "endDate": 1746811072601, "prReference": "prReference", "customerOrderId": 902, "workHours": 3106.2733970450495, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9421.957783245454, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8533.782080195831, "partAmount": 2361.4325493121423, "totalReserved": 6.514373479054036 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9109.26393423746, "name": "name", "comment": "comment", "finishDate": 1746811072601, "storeState": 7459, "state": "0", "articles": [{ "waste": "0", "amount": 3563.973313044837, "articleName": "articleName", "productionOrderId": 3052, "articleId": "articleId", "accuracy": 3505.553611911283, "finished": 8969.782406460632, "time": 578.6413280085478, "status": 6276 }], "startDate": 1746811072601, "reserveInDepth": "false" }
Add production order
POSTUrl:
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Add a new production order
Body:
{ "finishedAmount": 2632.1271730335384, "orderId": 5450, "endDate": 1746811072601, "prReference": "prReference", "customerOrderId": 6647, "workHours": 6165.984844833734, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 820.934648904289, "name": "name", "comment": "comment", "finishDate": 1746811072601, "storeState": 1422, "state": "0", "startDate": 1746811072601, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 7063.522730193948, "orderId": 4891, "endDate": 1746811072601, "prReference": "prReference", "customerOrderId": 8808, "workHours": 3466.8154946321515, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5981.380186277815, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8531.87099699335, "partAmount": 9692.0069760079, "totalReserved": 8650.813608382561 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1464.0656237174333, "name": "name", "comment": "comment", "finishDate": 1746811072601, "storeState": 23, "state": "0", "articles": [{ "waste": "0", "amount": 924.056838767171, "articleName": "articleName", "productionOrderId": 4998, "articleId": "articleId", "accuracy": 3746.877070572815, "finished": 6231.978353622048, "time": 1084.9204714681937, "status": 9378 }], "startDate": 1746811072601, "reserveInDepth": "false" }
Add article for production order
POSTUrl: /{order_id}/article
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Add a new article for production order
Body:
{ "waste": "0", "amount": 7772.3810050212805, "articleName": "articleName", "productionOrderId": 9722, "articleId": "articleId", "finished": 7699.800083134393, "time": 1730.7906225377901, "status": 6275 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2162.395317119976, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3921.7937707847004, "partAmount": 3754.245170583209, "totalReserved": 6319.1858085685335 }] }], "articles": [{ "waste": "0", "amount": 2847.249041929951, "articleName": "articleName", "productionOrderId": 3202, "articleId": "articleId", "accuracy": 8010.61580239859, "finished": 584.0821133854135, "time": 9822.916107446295, "status": 7755 }] }
Update production order
PUTUrl: /{id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Update an existing production order
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
startProduction | false |
Body:
{ "finishedAmount": 1780.084707232804, "orderId": 4992, "endDate": 1746811072601, "prReference": "prReference", "customerOrderId": 8725, "workHours": 7287.920235340036, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 167.11383304834348, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9622.105107014457, "partAmount": 141.64972992684045, "totalReserved": 4468.847178044869 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5387.837270763638, "name": "name", "comment": "comment", "finishDate": 1746811072601, "storeState": 8395, "state": "0", "articles": [{ "waste": "0", "amount": 4982.830029912128, "articleName": "articleName", "productionOrderId": 213, "articleId": "articleId", "accuracy": 8279.923936166972, "finished": 7926.010242161851, "time": 4626.202639344401, "status": 1775 }], "startDate": 1746811072601, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 5786.888010684234, "orderId": 7564, "endDate": 1746811072601, "prReference": "prReference", "customerOrderId": 3240, "workHours": 7841.057607029302, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9471.938887941478, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1628.1651067232017, "partAmount": 3983.9133679010906, "totalReserved": 1904.6891778261543 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9.915426827311613, "name": "name", "comment": "comment", "finishDate": 1746811072601, "storeState": 7729, "state": "0", "articles": [{ "waste": "0", "amount": 3375.9574454950503, "articleName": "articleName", "productionOrderId": 8990, "articleId": "articleId", "accuracy": 8616.042835814658, "finished": 9967.501981571066, "time": 5764.2661698553775, "status": 5681 }], "startDate": 1746811072601, "reserveInDepth": "false" }
Update article for production order
PUTUrl: /{id}/article
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Update an article for production order
Body:
{ "waste": "0", "amount": 4261.365595388908, "articleName": "articleName", "productionOrderId": 1706, "articleId": "articleId", "accuracy": 4897.485566594868, "finished": 5325.32764248823, "time": 450.2601728656286, "status": 1010 }
Successfull response:
{ "finishedAmount": 1120.222352522382, "orderId": 6219, "endDate": 1746811072602, "prReference": "prReference", "customerOrderId": 8573, "workHours": 6493.919888892428, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4668.859073258504, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1697.7729993433422, "partAmount": 6615.935765470944, "totalReserved": 1280.3366363912628 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 782.396512039617, "name": "name", "comment": "comment", "finishDate": 1746811072602, "storeState": 2650, "state": "0", "articles": [{ "waste": "0", "amount": 8536.365317646327, "articleName": "articleName", "productionOrderId": 1694, "articleId": "articleId", "accuracy": 1869.6543413490263, "finished": 9819.555248041283, "time": 3321.6271222590444, "status": 9704 }], "startDate": 1746811072602, "reserveInDepth": "false" }
Update article with traceability for production order
PUTUrl: /{id}/article/{article_id : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Update an article for production order with traceability
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
waste |
Body:
{ "amount": 9782.718757703638, "partTraceability": [{ "amount": 8830.763366972827, "serial": [{}], "articleId": "articleId", "batch": "batch" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 8178, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 1134.2100971460545, "orderId": 5024, "endDate": 1746811072602, "prReference": "prReference", "customerOrderId": 9737, "workHours": 9440.78302085731, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6856.907063575541, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8522.727353461283, "partAmount": 1233.0747769950813, "totalReserved": 7939.845940005435 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9447.89332092498, "name": "name", "comment": "comment", "finishDate": 1746811072602, "storeState": 851, "state": "0", "articles": [{ "waste": "0", "amount": 8793.48844655001, "articleName": "articleName", "productionOrderId": 4778, "articleId": "articleId", "accuracy": 8661.755205448364, "finished": 5571.37220141301, "time": 4196.0560423621655, "status": 6216 }], "startDate": 1746811072602, "reserveInDepth": "false" }
Cancel production order
PUTUrl: /{id}/cancel
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Update production order state to cancelled
Body:
Successfull response:
{ "finishedAmount": 9608.650876538404, "orderId": 2267, "endDate": 1746811072602, "prReference": "prReference", "customerOrderId": 7332, "workHours": 5536.759037742361, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5269.223977991324, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6987.559039137384, "partAmount": 1428.5264762263905, "totalReserved": 1006.8903060815481 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4925.019775836721, "name": "name", "comment": "comment", "finishDate": 1746811072602, "storeState": 6900, "state": "0", "articles": [{ "waste": "0", "amount": 1958.0222936039704, "articleName": "articleName", "productionOrderId": 292, "articleId": "articleId", "accuracy": 8030.00225880894, "finished": 9220.16989791771, "time": 4553.071323383039, "status": 4850 }], "startDate": 1746811072602, "reserveInDepth": "false" }
Finish production order
PUTUrl: /{id}/finish
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Update production order state to finished
Body:
Successfull response:
{ "finishedAmount": 2207.9636684917846, "orderId": 9907, "endDate": 1746811072602, "prReference": "prReference", "customerOrderId": 9014, "workHours": 9990.424911325055, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9994.437192943453, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2544.8570520512903, "partAmount": 3242.089331949566, "totalReserved": 9848.918975925042 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6671.579595125606, "name": "name", "comment": "comment", "finishDate": 1746811072602, "storeState": 479, "state": "0", "articles": [{ "waste": "0", "amount": 5020.8094768245455, "articleName": "articleName", "productionOrderId": 8756, "articleId": "articleId", "accuracy": 3546.719217009301, "finished": 4341.617700650566, "time": 9680.789862067715, "status": 2325 }], "startDate": 1746811072602, "reserveInDepth": "false" }
Remove production order article
DELETEUrl: /{order_id}/article/{article_id : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Remove article from an existing production order
Body:
Successfull response:
{ "finishedAmount": 4411.482376078895, "orderId": 369, "endDate": 1746811072603, "prReference": "prReference", "customerOrderId": 1604, "workHours": 9741.454900473167, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 616.5937065113902, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5929.385780226978, "partAmount": 8786.353342665623, "totalReserved": 8356.859497657533 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8694.302576024891, "name": "name", "comment": "comment", "finishDate": 1746811072603, "storeState": 7934, "state": "0", "articles": [{ "waste": "0", "amount": 1804.7758526327373, "articleName": "articleName", "productionOrderId": 6777, "articleId": "articleId", "accuracy": 8574.160712447963, "finished": 7003.255166696326, "time": 3488.8656226110015, "status": 615 }], "startDate": 1746811072603, "reserveInDepth": "false" }
Classes:
FlatBundledArticle
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for a single article within the bundled article | R,W | ||||
articleName | String | R,W | |||||
reserved | Double | R,W | |||||
amount | Double | R,W | |||||
partAmount | Double | R,W | |||||
purchasePrice | Double | R,W | |||||
purchasePriceMisc | Double | R,W | |||||
purchasePriceShipment | Double | R,W | |||||
supplierId | Long | R,W | |||||
supplierName | String | R,W | |||||
supplierArticleId | String | R,W | |||||
unit | String | R,W | |||||
stockplace | String | R,W | |||||
purchaseOrders | List | R,W |
FlatBundledArticlePurchaseOrder
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
orderId | Long | R,W | |||||
poRef | String | R,W | |||||
ordered | Double | R,W | |||||
state | int | R,W | |||||
deliveryDate | Date | R,W |
FlatBundledArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R |
PartTraceability
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R,W | |||||
amount | double | R,W | |||||
batch | String | R,W | |||||
serial | List | R,W |
ProductionOrder
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
orderId | Long | When updating a production order (PUT) | R,W | ||||
prReference | String | Unique ProductionOrder-id which the customer can decide themselves | R,W | ||||
customerOrderId | Long | POST | must point to an existing customerOrder | R,W | |||
customerOrderExternalId | String | R,W | |||||
internalReference | String | R,W | |||||
name | String | R,W | |||||
comment | String | R,W | |||||
startDate | Date | R,W | |||||
endDate | Date | R,W | |||||
finishDate | Date | R,W | |||||
workHours | Double | R,W | |||||
state | Integer | Write only with POST | 0 | NEW = 0, DEVELOPING = 1, FINISHED = 2, CANCELLED = 3 |
R,W | ||
reserveInDepth | Boolean | Flag to indicate if reservation should be done on only first layer of bundled articles, or if it should be done on all simple articles in all layers | false | R,W | |||
storeState | Integer | R,W | |||||
totalAmount | Double | R,W | |||||
finishedAmount | Double | R,W | |||||
articles | List | List of ProductionOrderArticles | R | ||||
singleArticles | List | List of ProductionOrderSingleArticles | R |
ProductionOrderArticle
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
productionOrderId | long | R,W | |||||
articleId | String | R,W | |||||
articleName | String | R,W | |||||
time | Double | R,W | |||||
amount | Double | R,W | |||||
finished | Double | R,W | |||||
waste | Double | Total number of produced is finished plus waste | 0 | R,W | |||
status | int | R,W | |||||
accuracy | Double | Percentage on accuracy of the production result. A positive accuracy describes a general overproduction, while a negative accuracy describes waste in production | R |
ProductionOrderArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R | |||||
parts | List | R |
ProductionOrderArticleTraceability
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for bundled article | R,W | ||||
batch | String | Batch for bundled article | R,W | ||||
serial | String | Serial number for bundled article | R,W | ||||
amount | double | Amount to be produced for bundled article | R,W | ||||
bestBefore | Long | Best before for bundled article | R,W | ||||
barcode | String | Barcode for bundled article | R,W | ||||
partTraceability | List | List of traceability for all parts in the bundled article | R,W | ||||
limitPartAmounts | Boolean | Set flag to true if we want to limit part amounts to ordered amount when overproducing | false | R,W |
ProductionOrderBatchResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R | |||||
countBatch | int | R | |||||
countSerial | int | R | |||||
batches | List | R |
ProductionOrderProductBatch
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
batchId | String | R,W | |||||
serialNr | String | R,W | |||||
orderedAmount | Double | R,W | |||||
deliveredAmount | Double | R,W | |||||
bestBefore | Long | R,W |
ProductionOrderRef
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
prReference | String | Next available purchase order reference | R |
ProductionOrderSingleArticleGroup
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R,W | |||||
singleArticles | List | R,W |
ProductionOrderSingleArticleReserved
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for the bundled article | R,W | ||||
singleArticleId | String | Article id for a single article within the bundled article | R,W | ||||
singleArticleName | String | R,W | |||||
totalReserved | Double | R,W | |||||
totalAmount | Double | R,W | |||||
partAmount | Double | R,W | |||||
purchasePrice | Double | R,W | |||||
hasStockValue | Boolean | R,W |
ProductionOrdersResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
page | int | R | |||||
pages | int | R | |||||
pageSize | int | R | |||||
ordersCount | int | R | |||||
orders | List | R |