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": 5201.644467770365, "orderId": 8765, "endDate": 1756577018767, "prReference": "prReference", "customerOrderId": 7091, "workHours": 8169.838245578724, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6745.913541241719, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9951.080819458552, "partAmount": 8661.76725693679, "totalReserved": 6527.807554152429 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8611.322616370997, "name": "name", "comment": "comment", "finishDate": 1756577018767, "storeState": 2545, "state": "0", "articles": [{ "waste": "0", "amount": 6234.883078687222, "articleName": "articleName", "productionOrderId": 2905, "articleId": "articleId", "accuracy": 5052.633859235867, "finished": 6922.143777891136, "time": 4065.1716396489624, "status": 6458 }], "startDate": 1756577018767, "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": 7967, "batches": [{ "deliveredAmount": 1320.4512161947068, "serialNr": "serialNr", "bestBefore": 51, "batchId": "batchId", "orderedAmount": 6220.319001277965 }], "articleId": "articleId", "countSerial": 8660 }
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": 9309.064826090213, "orderId": 4096, "endDate": 1756577018768, "prReference": "prReference", "customerOrderId": 2234, "workHours": 4389.827003135694, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1043.2411725509628, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1829.227200666127, "partAmount": 7615.850931473295, "totalReserved": 8400.612861066515 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1960.6575842469697, "name": "name", "comment": "comment", "finishDate": 1756577018768, "storeState": 8394, "state": "0", "articles": [{ "waste": "0", "amount": 569.6719506111369, "articleName": "articleName", "productionOrderId": 3541, "articleId": "articleId", "accuracy": 929.2261383615896, "finished": 4980.176717377553, "time": 1623.763604754751, "status": 9932 }], "startDate": 1756577018768, "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": 814, "pages": 1987, "pageSize": 1244, "orders": [{ "finishedAmount": 7503.033505666696, "orderId": 5379, "endDate": 1756577018768, "prReference": "prReference", "customerOrderId": 3299, "workHours": 1785.658141282016, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3214.5002417305523, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3618.216451883249, "partAmount": 9613.064633272154, "totalReserved": 9414.932351305508 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4382.346667876052, "name": "name", "comment": "comment", "finishDate": 1756577018768, "storeState": 990, "state": "0", "articles": [{ "waste": "0", "amount": 83.67505098917593, "articleName": "articleName", "productionOrderId": 751, "articleId": "articleId", "accuracy": 2987.1047236153668, "finished": 7561.8551105149745, "time": 1336.401307974312, "status": 3507 }], "startDate": 1756577018768, "reserveInDepth": "false" }], "page": 7788 }
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": 8691, "pages": 5370, "pageSize": 7454, "orders": [{ "finishedAmount": 7465.022807809347, "orderId": 699, "endDate": 1756577018769, "prReference": "prReference", "customerOrderId": 8300, "workHours": 2375.2505630739597, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3913.9345045578298, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8282.286239400515, "partAmount": 5242.558089131497, "totalReserved": 7313.379468933169 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6706.626779051839, "name": "name", "comment": "comment", "finishDate": 1756577018769, "storeState": 3926, "state": "0", "articles": [{ "waste": "0", "amount": 3442.807591844941, "articleName": "articleName", "productionOrderId": 4352, "articleId": "articleId", "accuracy": 2614.7582360421175, "finished": 8517.003924865941, "time": 506.81026329020165, "status": 6408 }], "startDate": 1756577018769, "reserveInDepth": "false" }], "page": 6169 }
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": 7878, "pages": 3728, "pageSize": 1725, "orders": [{ "finishedAmount": 9909.206374151809, "orderId": 1718, "endDate": 1756577018769, "prReference": "prReference", "customerOrderId": 1613, "workHours": 7213.808408935025, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3321.2375599390366, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8175.345650243783, "partAmount": 9635.005323034824, "totalReserved": 7331.843470046304 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6617.73062937681, "name": "name", "comment": "comment", "finishDate": 1756577018769, "storeState": 1235, "state": "0", "articles": [{ "waste": "0", "amount": 8209.656168203046, "articleName": "articleName", "productionOrderId": 1303, "articleId": "articleId", "accuracy": 2243.576821905644, "finished": 6685.055887671655, "time": 2957.7570286398436, "status": 110 }], "startDate": 1756577018769, "reserveInDepth": "false" }], "page": 6796 }
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": 129.12054712538978, "articleName": "articleName", "supplierId": 4355, "purchasePriceMisc": 3353.9176845142624, "articleId": "articleId", "purchasePrice": 742.8332646376623, "partAmount": 1788.9478139498804, "stockplace": "stockplace", "unit": "unit", "reserved": 584.7593378095605, "purchasePriceShipment": 9971.829705123211, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 1286.421587149289, "orderId": 2177, "poRef": "poRef", "state": 595, "deliveryDate": 1756577018769 }] }]}
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": 2327.0306507858572, "orderId": 4943, "endDate": 1756577018770, "prReference": "prReference", "customerOrderId": 8648, "workHours": 279.34365482463977, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9741.24807363013, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9625.873514723082, "partAmount": 1664.4758965172257, "totalReserved": 4446.484628314605 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6154.966880098701, "name": "name", "comment": "comment", "finishDate": 1756577018770, "storeState": 1627, "state": "0", "articles": [{ "waste": "0", "amount": 6828.940626206337, "articleName": "articleName", "productionOrderId": 6179, "articleId": "articleId", "accuracy": 4388.075553253193, "finished": 7167.14330590846, "time": 4608.239685833963, "status": 7880 }], "startDate": 1756577018770, "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": 644.5940661372363, "orderId": 6172, "endDate": 1756577018770, "prReference": "prReference", "customerOrderId": 2477, "workHours": 7693.607762986776, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6108.079816522678, "name": "name", "comment": "comment", "finishDate": 1756577018770, "storeState": 4213, "state": "0", "startDate": 1756577018770, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 2211.917886972857, "orderId": 4720, "endDate": 1756577018770, "prReference": "prReference", "customerOrderId": 5943, "workHours": 4651.371126055342, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1162.9574465630576, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5100.468397859749, "partAmount": 1057.7349052511308, "totalReserved": 4426.652950821509 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8520.961470955954, "name": "name", "comment": "comment", "finishDate": 1756577018770, "storeState": 4491, "state": "0", "articles": [{ "waste": "0", "amount": 707.4437249602206, "articleName": "articleName", "productionOrderId": 9710, "articleId": "articleId", "accuracy": 1165.7047448839464, "finished": 3057.8176329789553, "time": 312.6917076863156, "status": 5308 }], "startDate": 1756577018770, "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": 1591.0056654349646, "articleName": "articleName", "productionOrderId": 4367, "articleId": "articleId", "finished": 687.179814079435, "time": 4238.55304398457, "status": 9724 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6.5115662319481515, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9413.225820723048, "partAmount": 4641.250913114916, "totalReserved": 2984.767963524959 }] }], "articles": [{ "waste": "0", "amount": 2235.0626125871377, "articleName": "articleName", "productionOrderId": 3676, "articleId": "articleId", "accuracy": 7659.98380725037, "finished": 233.65906372914026, "time": 2182.287498891786, "status": 3985 }] }
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": 7084.18774536561, "articleName": "articleName", "productionOrderId": 2210, "articleId": "articleId", "accuracy": 1907.5070612890465, "finished": 9583.474792895197, "time": 808.3116419996817, "status": 6891 }
Successfull response:
{ "finishedAmount": 9440.963107676367, "orderId": 8084, "endDate": 1756577018770, "prReference": "prReference", "customerOrderId": 4903, "workHours": 2515.876693599288, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5201.253275768675, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2261.0893605839387, "partAmount": 8899.266464805407, "totalReserved": 53.856536032944604 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7108.3764863073075, "name": "name", "comment": "comment", "finishDate": 1756577018770, "storeState": 9471, "state": "0", "articles": [{ "waste": "0", "amount": 5379.995958920738, "articleName": "articleName", "productionOrderId": 5903, "articleId": "articleId", "accuracy": 1388.9294265876383, "finished": 4968.247899919369, "time": 8018.791430441682, "status": 126 }], "startDate": 1756577018770, "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": 247.8437361358865, "partTraceability": [{ "amount": 4432.208765261514, "serial": [{}], "articleId": "articleId", "batch": "batch" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 8998, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 4337.246236375949, "orderId": 4323, "endDate": 1756577018771, "prReference": "prReference", "customerOrderId": 2513, "workHours": 9332.575954450424, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5319.439239042827, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7260.929301156961, "partAmount": 2103.118586398235, "totalReserved": 690.4019226223079 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8237.251975195793, "name": "name", "comment": "comment", "finishDate": 1756577018771, "storeState": 5832, "state": "0", "articles": [{ "waste": "0", "amount": 7003.7399654508035, "articleName": "articleName", "productionOrderId": 6436, "articleId": "articleId", "accuracy": 7096.773636192925, "finished": 9624.009392606515, "time": 5227.232628884336, "status": 1345 }], "startDate": 1756577018771, "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": 689.2329155961496, "orderId": 3681, "endDate": 1756577018771, "prReference": "prReference", "customerOrderId": 9452, "workHours": 6499.049864322802, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3742.681215300233, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9130.204307565575, "partAmount": 1656.8679640220141, "totalReserved": 8491.516996053095 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3004.5509650515733, "name": "name", "comment": "comment", "finishDate": 1756577018771, "storeState": 1488, "state": "0", "articles": [{ "waste": "0", "amount": 2707.561373459022, "articleName": "articleName", "productionOrderId": 616, "articleId": "articleId", "accuracy": 423.33210774257554, "finished": 8071.792192642386, "time": 7673.127912627054, "status": 3200 }], "startDate": 1756577018771, "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": 3480.923609355945, "orderId": 2655, "endDate": 1756577018771, "prReference": "prReference", "customerOrderId": 8015, "workHours": 55.2576584399378, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 465.5427559361902, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7370.213554448298, "partAmount": 6163.591930507947, "totalReserved": 5425.397199564574 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8671.684218377693, "name": "name", "comment": "comment", "finishDate": 1756577018771, "storeState": 3747, "state": "0", "articles": [{ "waste": "0", "amount": 6689.679985260412, "articleName": "articleName", "productionOrderId": 5421, "articleId": "articleId", "accuracy": 1399.9765829531418, "finished": 9715.712330400846, "time": 7643.100845795211, "status": 2795 }], "startDate": 1756577018771, "reserveInDepth": "false" }
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": 7184.6581445276615, "orderId": 4267, "endDate": 1756577018771, "prReference": "prReference", "customerOrderId": 6740, "workHours": 7438.017397076521, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6009.376363520381, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7720.597574851621, "partAmount": 1028.4265171783347, "totalReserved": 8775.88778358886 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2721.0289986725766, "name": "name", "comment": "comment", "finishDate": 1756577018771, "storeState": 3861, "state": "0", "articles": [{ "waste": "0", "amount": 9082.313361200353, "articleName": "articleName", "productionOrderId": 1403, "articleId": "articleId", "accuracy": 7307.858012744981, "finished": 7664.577283043782, "time": 6802.743725793416, "status": 2016 }], "startDate": 1756577018771, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 5069.759203281103, "orderId": 7024, "endDate": 1756577018771, "prReference": "prReference", "customerOrderId": 6057, "workHours": 327.4189081565282, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1961.285761674172, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7370.726490013013, "partAmount": 8246.087888330336, "totalReserved": 1777.9372200850096 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7998.1918722216515, "name": "name", "comment": "comment", "finishDate": 1756577018771, "storeState": 7312, "state": "0", "articles": [{ "waste": "0", "amount": 8392.286746775886, "articleName": "articleName", "productionOrderId": 5923, "articleId": "articleId", "accuracy": 1275.2947106762701, "finished": 3851.906023913352, "time": 5983.574852581582, "status": 1191 }], "startDate": 1756577018771, "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": 8085.444745946499, "orderId": 4342, "endDate": 1756577018772, "prReference": "prReference", "customerOrderId": 2074, "workHours": 167.2428646268409, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2652.83409430904, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 649.2023826612336, "partAmount": 5335.343641686383, "totalReserved": 549.3457268619605 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9046.947470434716, "name": "name", "comment": "comment", "finishDate": 1756577018772, "storeState": 5095, "state": "0", "articles": [{ "waste": "0", "amount": 6299.1355196921495, "articleName": "articleName", "productionOrderId": 9300, "articleId": "articleId", "accuracy": 4725.646546839694, "finished": 2467.0852115930998, "time": 984.1443999994115, "status": 8862 }], "startDate": 1756577018772, "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 |