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": 3458.5277587941764, "orderId": 4020, "endDate": 1751047304373, "prReference": "prReference", "customerOrderId": 4471, "workHours": 17.31315776229314, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7816.7950193840215, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9871.567272756707, "partAmount": 461.0700583661498, "totalReserved": 2643.5342092653723 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4185.8192782783135, "name": "name", "comment": "comment", "finishDate": 1751047304373, "storeState": 7772, "state": "0", "articles": [{ "waste": "0", "amount": 7353.8845364397475, "articleName": "articleName", "productionOrderId": 3711, "articleId": "articleId", "accuracy": 5409.192092502927, "finished": 6005.30129970296, "time": 6524.934033799441, "status": 1901 }], "startDate": 1751047304373, "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": 7712, "batches": [{ "deliveredAmount": 8535.871541446173, "serialNr": "serialNr", "bestBefore": 3323, "batchId": "batchId", "orderedAmount": 724.5478348291313 }], "articleId": "articleId", "countSerial": 2077 }
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": 341.72498615907875, "orderId": 5964, "endDate": 1751047304374, "prReference": "prReference", "customerOrderId": 5332, "workHours": 8505.317178634872, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7341.502789385487, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6699.467692848067, "partAmount": 5128.998769897682, "totalReserved": 4486.110642338379 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8139.456309585329, "name": "name", "comment": "comment", "finishDate": 1751047304374, "storeState": 1897, "state": "0", "articles": [{ "waste": "0", "amount": 4053.0360716584, "articleName": "articleName", "productionOrderId": 9872, "articleId": "articleId", "accuracy": 2189.0807392532943, "finished": 5189.361904506217, "time": 4581.944749903205, "status": 380 }], "startDate": 1751047304374, "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": 6894, "pages": 2761, "pageSize": 5515, "orders": [{ "finishedAmount": 9579.578801608293, "orderId": 5301, "endDate": 1751047304374, "prReference": "prReference", "customerOrderId": 7718, "workHours": 4836.851808371939, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4020.82995491143, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6154.108788267172, "partAmount": 6923.941572547706, "totalReserved": 3204.019682543485 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6341.218200130212, "name": "name", "comment": "comment", "finishDate": 1751047304374, "storeState": 7382, "state": "0", "articles": [{ "waste": "0", "amount": 1413.0888799609331, "articleName": "articleName", "productionOrderId": 4439, "articleId": "articleId", "accuracy": 5555.1388166347515, "finished": 9199.622425248854, "time": 5155.458853127531, "status": 8594 }], "startDate": 1751047304374, "reserveInDepth": "false" }], "page": 3430 }
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": 3560, "pages": 4550, "pageSize": 9556, "orders": [{ "finishedAmount": 2769.085127836749, "orderId": 2192, "endDate": 1751047304374, "prReference": "prReference", "customerOrderId": 3096, "workHours": 2269.899900275273, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5604.336542001931, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7774.08849636731, "partAmount": 9175.722940546997, "totalReserved": 7383.635949838943 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2722.7845049694765, "name": "name", "comment": "comment", "finishDate": 1751047304374, "storeState": 1285, "state": "0", "articles": [{ "waste": "0", "amount": 228.05395684485143, "articleName": "articleName", "productionOrderId": 380, "articleId": "articleId", "accuracy": 4113.9664022961615, "finished": 1084.0472868691197, "time": 9978.368023955265, "status": 2489 }], "startDate": 1751047304374, "reserveInDepth": "false" }], "page": 1721 }
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": 6844, "pages": 6108, "pageSize": 1156, "orders": [{ "finishedAmount": 1407.3060129628002, "orderId": 9617, "endDate": 1751047304375, "prReference": "prReference", "customerOrderId": 4852, "workHours": 5625.617156284182, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4184.520790397136, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 759.65484343962, "partAmount": 1003.3338998526165, "totalReserved": 748.1547410768674 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2578.2996089443545, "name": "name", "comment": "comment", "finishDate": 1751047304375, "storeState": 3826, "state": "0", "articles": [{ "waste": "0", "amount": 3926.477558734145, "articleName": "articleName", "productionOrderId": 5954, "articleId": "articleId", "accuracy": 6555.759217875086, "finished": 7548.79684528076, "time": 2698.6088643424155, "status": 3532 }], "startDate": 1751047304375, "reserveInDepth": "false" }], "page": 6489 }
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": 7058.3364967196785, "articleName": "articleName", "supplierId": 9625, "purchasePriceMisc": 3527.660853478929, "articleId": "articleId", "purchasePrice": 3347.846112264713, "partAmount": 4899.986515940164, "stockplace": "stockplace", "unit": "unit", "reserved": 9074.193389764847, "purchasePriceShipment": 9901.854986489463, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 3980.015431062843, "orderId": 6887, "poRef": "poRef", "state": 9313, "deliveryDate": 1751047304375 }] }]}
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 order for id
GETUrl: /{order_id}
Headers:
Accept: application/json or application/xml
Get production order based on id
Body:
Successfull response:
{ "finishedAmount": 5691.132853242675, "orderId": 5167, "endDate": 1751047304376, "prReference": "prReference", "customerOrderId": 3420, "workHours": 4707.964623845164, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4953.307125724497, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 219.61786776928284, "partAmount": 8127.147046513524, "totalReserved": 9505.436683720887 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2029.6358021181593, "name": "name", "comment": "comment", "finishDate": 1751047304376, "storeState": 144, "state": "0", "articles": [{ "waste": "0", "amount": 2011.575655576604, "articleName": "articleName", "productionOrderId": 7375, "articleId": "articleId", "accuracy": 6751.481490223306, "finished": 8435.939323655472, "time": 4605.035601868954, "status": 1579 }], "startDate": 1751047304376, "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": 8581.725175969135, "orderId": 7591, "endDate": 1751047304377, "prReference": "prReference", "customerOrderId": 3365, "workHours": 9432.839728072742, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4432.573281472214, "name": "name", "comment": "comment", "finishDate": 1751047304377, "storeState": 3352, "state": "0", "startDate": 1751047304377, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 7430.457095887389, "orderId": 5268, "endDate": 1751047304377, "prReference": "prReference", "customerOrderId": 5738, "workHours": 4739.462509199933, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 774.1569409710858, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 854.6172969641441, "partAmount": 2950.01236442338, "totalReserved": 7083.029918239902 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8480.164726037228, "name": "name", "comment": "comment", "finishDate": 1751047304377, "storeState": 3216, "state": "0", "articles": [{ "waste": "0", "amount": 8049.574981855072, "articleName": "articleName", "productionOrderId": 2591, "articleId": "articleId", "accuracy": 8422.053408151436, "finished": 6610.118564680444, "time": 4429.084902291377, "status": 1519 }], "startDate": 1751047304377, "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": 4655.906820043458, "articleName": "articleName", "productionOrderId": 9900, "articleId": "articleId", "finished": 264.3822908128357, "time": 7768.26755562025, "status": 548 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8343.893215838629, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6096.132396594505, "partAmount": 4572.977931883075, "totalReserved": 3130.5601107415073 }] }], "articles": [{ "waste": "0", "amount": 3756.4738582523037, "articleName": "articleName", "productionOrderId": 3440, "articleId": "articleId", "accuracy": 9144.20041477286, "finished": 9548.467946130446, "time": 3603.954711352432, "status": 8767 }] }
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": 4738.656060906455, "orderId": 5487, "endDate": 1751047304378, "prReference": "prReference", "customerOrderId": 1412, "workHours": 132.89822890979573, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3474.4204056181948, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1246.71925995675, "partAmount": 8929.443237793115, "totalReserved": 4219.107997437739 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5321.3681257801045, "name": "name", "comment": "comment", "finishDate": 1751047304378, "storeState": 3631, "state": "0", "articles": [{ "waste": "0", "amount": 5443.856826972311, "articleName": "articleName", "productionOrderId": 6217, "articleId": "articleId", "accuracy": 7524.331252565081, "finished": 3855.555326684145, "time": 7288.606757705543, "status": 2540 }], "startDate": 1751047304378, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 3321.990155550455, "orderId": 5716, "endDate": 1751047304378, "prReference": "prReference", "customerOrderId": 2179, "workHours": 5742.014560689718, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5247.3421669448235, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3146.87277134156, "partAmount": 5371.67662235458, "totalReserved": 4857.784737215017 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6000.498662226704, "name": "name", "comment": "comment", "finishDate": 1751047304378, "storeState": 8722, "state": "0", "articles": [{ "waste": "0", "amount": 8408.910882887583, "articleName": "articleName", "productionOrderId": 9812, "articleId": "articleId", "accuracy": 3212.15752165649, "finished": 3426.383620529657, "time": 3628.406377736968, "status": 6851 }], "startDate": 1751047304378, "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": 8386.506372310609, "articleName": "articleName", "productionOrderId": 7723, "articleId": "articleId", "accuracy": 3318.844622761712, "finished": 6962.939857026824, "time": 9809.138665028513, "status": 9164 }
Successfull response:
{ "finishedAmount": 6901.896955946309, "orderId": 5019, "endDate": 1751047304378, "prReference": "prReference", "customerOrderId": 2824, "workHours": 2803.8212337556656, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9782.081764763208, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2611.501732166764, "partAmount": 968.6966716649814, "totalReserved": 6694.446387369154 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 783.7946744519942, "name": "name", "comment": "comment", "finishDate": 1751047304378, "storeState": 4696, "state": "0", "articles": [{ "waste": "0", "amount": 6095.9821686426285, "articleName": "articleName", "productionOrderId": 5331, "articleId": "articleId", "accuracy": 1645.158189840321, "finished": 9966.456496268991, "time": 3581.5420355880156, "status": 5003 }], "startDate": 1751047304378, "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": 8437.166608180723, "partTraceability": [{ "amount": 630.5364642653988, "serial": [{}], "articleId": "articleId", "batch": "batch" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 9567, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 2861.4238990514764, "orderId": 3481, "endDate": 1751047304379, "prReference": "prReference", "customerOrderId": 9463, "workHours": 6541.69337758983, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5199.4145060303745, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2835.1197183506183, "partAmount": 527.0681067619365, "totalReserved": 5607.865232096687 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8939.953369510711, "name": "name", "comment": "comment", "finishDate": 1751047304379, "storeState": 4788, "state": "0", "articles": [{ "waste": "0", "amount": 3815.004961185977, "articleName": "articleName", "productionOrderId": 6309, "articleId": "articleId", "accuracy": 4678.969935367333, "finished": 490.13275272605796, "time": 7345.131965601504, "status": 780 }], "startDate": 1751047304379, "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": 1540.8531696930515, "orderId": 4538, "endDate": 1751047304379, "prReference": "prReference", "customerOrderId": 576, "workHours": 4104.4569966294275, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3750.7141095280294, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3630.1725833852106, "partAmount": 9359.856848748377, "totalReserved": 9864.558395240872 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3920.456583012365, "name": "name", "comment": "comment", "finishDate": 1751047304379, "storeState": 1717, "state": "0", "articles": [{ "waste": "0", "amount": 4709.824948979985, "articleName": "articleName", "productionOrderId": 7101, "articleId": "articleId", "accuracy": 7642.1216494761065, "finished": 4390.643725216682, "time": 4683.585245039422, "status": 448 }], "startDate": 1751047304379, "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": 152.3618752506961, "orderId": 301, "endDate": 1751047304379, "prReference": "prReference", "customerOrderId": 5166, "workHours": 1786.9052199377677, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3010.5853179343944, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5970.478575892433, "partAmount": 3791.982865907131, "totalReserved": 229.8264115981885 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7585.107671073669, "name": "name", "comment": "comment", "finishDate": 1751047304379, "storeState": 861, "state": "0", "articles": [{ "waste": "0", "amount": 2326.121456967887, "articleName": "articleName", "productionOrderId": 4929, "articleId": "articleId", "accuracy": 9680.639239471922, "finished": 3925.493170563432, "time": 2626.642155754281, "status": 4998 }], "startDate": 1751047304379, "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": 748.653520739554, "orderId": 2336, "endDate": 1751047304380, "prReference": "prReference", "customerOrderId": 6616, "workHours": 2373.079215530565, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 496.8367554138098, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2103.950103167319, "partAmount": 5765.374046713609, "totalReserved": 4871.677028208187 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5861.176509428716, "name": "name", "comment": "comment", "finishDate": 1751047304380, "storeState": 8517, "state": "0", "articles": [{ "waste": "0", "amount": 3709.284258462735, "articleName": "articleName", "productionOrderId": 8218, "articleId": "articleId", "accuracy": 8863.161392306502, "finished": 8926.943848606188, "time": 7907.980486124507, "status": 6590 }], "startDate": 1751047304380, "reserveInDepth": "false" }
Classes:
FlatBundledArticleDto
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 |
FlatBundledArticlePurchaseOrderDto
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 |
FlatBundledArticlesResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R |
PartTraceabilityDto
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 |
ProductionOrderArticleDto
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 |
ProductionOrderArticlesResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R | |||||
parts | List | R |
ProductionOrderArticleTraceabilityDto
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 |
ProductionOrderBatchResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R | |||||
countBatch | int | R | |||||
countSerial | int | R | |||||
batches | List | R |
ProductionOrderDto
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 |
ProductionOrderProductBatchDto
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 |
ProductionOrderRefDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
prReference | String | Next available purchase order reference | R |
ProductionOrderSingleArticleGroupDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R,W | |||||
singleArticles | List | R,W |
ProductionOrderSingleArticleReservedDto
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 |
ProductionOrdersResponseDto
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 |