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": 5407.440163901944, "orderId": 3470, "endDate": 1752612042965, "prReference": "prReference", "customerOrderId": 8249, "workHours": 6610.357067328756, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3704.8812917734717, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1504.7631802377382, "partAmount": 7898.296231161555, "totalReserved": 9249.526488985994 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 347.681409317383, "name": "name", "comment": "comment", "finishDate": 1752612042965, "storeState": 8228, "state": "0", "articles": [{ "waste": "0", "amount": 3375.5130277095845, "articleName": "articleName", "productionOrderId": 6925, "articleId": "articleId", "accuracy": 8767.1347789957, "finished": 8785.897914842817, "time": 9891.507162247943, "status": 3757 }], "startDate": 1752612042965, "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": 1846, "batches": [{ "deliveredAmount": 6832.349640029582, "serialNr": "serialNr", "bestBefore": 5004, "batchId": "batchId", "orderedAmount": 4046.2294611427974 }], "articleId": "articleId", "countSerial": 6332 }
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": 4094, "pages": 1922, "pageSize": 4247, "orders": [{ "finishedAmount": 132.00303483879017, "orderId": 1273, "endDate": 1752612042965, "prReference": "prReference", "customerOrderId": 6257, "workHours": 4121.11662716845, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4792.773545467888, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6272.405379149578, "partAmount": 8976.651427489573, "totalReserved": 5038.752408668406 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2103.3681988556773, "name": "name", "comment": "comment", "finishDate": 1752612042965, "storeState": 1400, "state": "0", "articles": [{ "waste": "0", "amount": 3543.580984105287, "articleName": "articleName", "productionOrderId": 3661, "articleId": "articleId", "accuracy": 5787.707834059362, "finished": 1673.3241444881553, "time": 3067.550784600914, "status": 5224 }], "startDate": 1752612042965, "reserveInDepth": "false" }], "page": 9860 }
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": 4739, "pages": 464, "pageSize": 4649, "orders": [{ "finishedAmount": 5176.874437443743, "orderId": 4604, "endDate": 1752612042966, "prReference": "prReference", "customerOrderId": 3330, "workHours": 3226.745906423404, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9846.765817135163, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 435.4658400947098, "partAmount": 6698.214542761958, "totalReserved": 5482.978953230424 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1088.597217384083, "name": "name", "comment": "comment", "finishDate": 1752612042966, "storeState": 2122, "state": "0", "articles": [{ "waste": "0", "amount": 5242.7851274272925, "articleName": "articleName", "productionOrderId": 212, "articleId": "articleId", "accuracy": 5065.662992010936, "finished": 7602.656552505261, "time": 7463.427048615085, "status": 3911 }], "startDate": 1752612042966, "reserveInDepth": "false" }], "page": 5839 }
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": 4784, "pages": 9620, "pageSize": 9878, "orders": [{ "finishedAmount": 4674.496142308197, "orderId": 9736, "endDate": 1752612042966, "prReference": "prReference", "customerOrderId": 7885, "workHours": 7690.81177566969, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9990.26342053865, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7979.072991663778, "partAmount": 9476.73558612167, "totalReserved": 8738.872559943109 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7391.661556443504, "name": "name", "comment": "comment", "finishDate": 1752612042966, "storeState": 9449, "state": "0", "articles": [{ "waste": "0", "amount": 4682.041525413259, "articleName": "articleName", "productionOrderId": 9615, "articleId": "articleId", "accuracy": 8078.911581297846, "finished": 5726.920048169582, "time": 1553.1749052994603, "status": 2256 }], "startDate": 1752612042966, "reserveInDepth": "false" }], "page": 9122 }
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": 136.62236479233815, "orderId": 2229, "endDate": 1752612042966, "prReference": "prReference", "customerOrderId": 8468, "workHours": 8094.207034547908, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4086.3275713280423, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3373.607328614625, "partAmount": 5119.1821228955205, "totalReserved": 2655.5516988316376 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1963.2403344650095, "name": "name", "comment": "comment", "finishDate": 1752612042966, "storeState": 4318, "state": "0", "articles": [{ "waste": "0", "amount": 9341.292974856953, "articleName": "articleName", "productionOrderId": 1543, "articleId": "articleId", "accuracy": 8371.713960267158, "finished": 707.9877123040957, "time": 9643.170010677948, "status": 8392 }], "startDate": 1752612042966, "reserveInDepth": "false" }
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": 8968.088731913162, "articleName": "articleName", "supplierId": 5931, "purchasePriceMisc": 5011.945582083619, "articleId": "articleId", "purchasePrice": 9757.936547658503, "partAmount": 6155.188451760609, "stockplace": "stockplace", "unit": "unit", "reserved": 7348.970411264866, "purchasePriceShipment": 5598.836464022765, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 1207.3462415208357, "orderId": 8483, "poRef": "poRef", "state": 3633, "deliveryDate": 1752612042966 }] }]}
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": 7067.960497239619, "orderId": 3464, "endDate": 1752612042967, "prReference": "prReference", "customerOrderId": 7304, "workHours": 2756.927174255277, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5753.2400418306925, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1877.3117241885761, "partAmount": 5039.231180240081, "totalReserved": 3397.94132748402 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4055.83244955953, "name": "name", "comment": "comment", "finishDate": 1752612042967, "storeState": 7669, "state": "0", "articles": [{ "waste": "0", "amount": 2155.0587795232, "articleName": "articleName", "productionOrderId": 276, "articleId": "articleId", "accuracy": 1821.5599308873686, "finished": 616.9275269132157, "time": 2115.8999577298187, "status": 8904 }], "startDate": 1752612042967, "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": 1153.2786293596675, "orderId": 1453, "endDate": 1752612042967, "prReference": "prReference", "customerOrderId": 521, "workHours": 8195.060506625787, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 245.2014322819651, "name": "name", "comment": "comment", "finishDate": 1752612042967, "storeState": 8044, "state": "0", "startDate": 1752612042967, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 5509.82560481329, "orderId": 2519, "endDate": 1752612042967, "prReference": "prReference", "customerOrderId": 4345, "workHours": 1841.7530310002628, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 365.7220447508869, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2385.0398538323725, "partAmount": 2182.254523486884, "totalReserved": 5726.216465540788 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 375.2981887233864, "name": "name", "comment": "comment", "finishDate": 1752612042967, "storeState": 2098, "state": "0", "articles": [{ "waste": "0", "amount": 8115.409380513562, "articleName": "articleName", "productionOrderId": 3148, "articleId": "articleId", "accuracy": 8227.2106806859, "finished": 1349.202960722965, "time": 8783.332463316023, "status": 7568 }], "startDate": 1752612042967, "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": 2062.242560810098, "articleName": "articleName", "productionOrderId": 5418, "articleId": "articleId", "finished": 1371.2541516338383, "time": 4806.068193666954, "status": 2177 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5903.908943955562, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1395.4967214164337, "partAmount": 2312.326173674817, "totalReserved": 7420.512589716727 }] }], "articles": [{ "waste": "0", "amount": 7626.365741652764, "articleName": "articleName", "productionOrderId": 4211, "articleId": "articleId", "accuracy": 7088.228301437451, "finished": 5567.907594960349, "time": 7220.199039790387, "status": 5850 }] }
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": 5600.519034264456, "orderId": 8220, "endDate": 1752612042967, "prReference": "prReference", "customerOrderId": 2448, "workHours": 2249.5280986938806, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4056.4328584931754, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8592.01784080069, "partAmount": 8124.111272124273, "totalReserved": 3378.85724150627 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5427.008512643393, "name": "name", "comment": "comment", "finishDate": 1752612042967, "storeState": 1546, "state": "0", "articles": [{ "waste": "0", "amount": 8336.33161784982, "articleName": "articleName", "productionOrderId": 4713, "articleId": "articleId", "accuracy": 1507.8422501803602, "finished": 7687.579698839606, "time": 9380.086457490417, "status": 2971 }], "startDate": 1752612042967, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 68.11732648909108, "orderId": 9930, "endDate": 1752612042967, "prReference": "prReference", "customerOrderId": 3114, "workHours": 4729.040449753803, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8497.611470430611, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9350.746411334425, "partAmount": 2692.445336419602, "totalReserved": 4884.742626770838 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3062.142805278083, "name": "name", "comment": "comment", "finishDate": 1752612042967, "storeState": 2924, "state": "0", "articles": [{ "waste": "0", "amount": 4765.770726317227, "articleName": "articleName", "productionOrderId": 4483, "articleId": "articleId", "accuracy": 9671.140235832849, "finished": 5403.872131267074, "time": 6342.9154125891655, "status": 6526 }], "startDate": 1752612042967, "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": 4357.02923362598, "articleName": "articleName", "productionOrderId": 363, "articleId": "articleId", "accuracy": 4663.65996513899, "finished": 6829.811584075121, "time": 1096.5906668538105, "status": 9866 }
Successfull response:
{ "finishedAmount": 8291.976696314185, "orderId": 6232, "endDate": 1752612042967, "prReference": "prReference", "customerOrderId": 8849, "workHours": 6308.846447871831, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1429.1317083717881, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5793.179267248696, "partAmount": 5279.94943599411, "totalReserved": 5656.155142565365 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9500.364957604246, "name": "name", "comment": "comment", "finishDate": 1752612042967, "storeState": 1850, "state": "0", "articles": [{ "waste": "0", "amount": 2009.293198642722, "articleName": "articleName", "productionOrderId": 8878, "articleId": "articleId", "accuracy": 218.21308167037867, "finished": 2256.048781767508, "time": 4671.7427956286165, "status": 5423 }], "startDate": 1752612042967, "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": 7224.747190502445, "partTraceability": [{ "amount": 4500.4455418023545, "serial": [{}], "articleId": "articleId", "batch": "batch" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 3468, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 8742.844586315312, "orderId": 5454, "endDate": 1752612042968, "prReference": "prReference", "customerOrderId": 2686, "workHours": 6490.351659078876, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8801.124025121457, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7248.89490727119, "partAmount": 3710.2379833377495, "totalReserved": 8968.522838523977 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5254.720053477251, "name": "name", "comment": "comment", "finishDate": 1752612042968, "storeState": 7674, "state": "0", "articles": [{ "waste": "0", "amount": 6083.049655443568, "articleName": "articleName", "productionOrderId": 3150, "articleId": "articleId", "accuracy": 1450.3670961012826, "finished": 4899.7351103004385, "time": 2889.669891655694, "status": 7356 }], "startDate": 1752612042968, "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": 1746.6301977424337, "orderId": 2195, "endDate": 1752612042968, "prReference": "prReference", "customerOrderId": 819, "workHours": 9660.620799475146, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 826.9011098891765, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8073.843190364874, "partAmount": 3013.1071158686227, "totalReserved": 5886.619192911939 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1816.792695725381, "name": "name", "comment": "comment", "finishDate": 1752612042968, "storeState": 1158, "state": "0", "articles": [{ "waste": "0", "amount": 2430.8376235013006, "articleName": "articleName", "productionOrderId": 6755, "articleId": "articleId", "accuracy": 5653.494704383202, "finished": 5785.912218968547, "time": 3158.143438716263, "status": 1521 }], "startDate": 1752612042968, "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": 723.3270854787688, "orderId": 991, "endDate": 1752612042968, "prReference": "prReference", "customerOrderId": 6400, "workHours": 2534.583140090528, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 535.608280804768, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9867.778748536757, "partAmount": 4446.460497767134, "totalReserved": 3213.8311797694287 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9923.846895585273, "name": "name", "comment": "comment", "finishDate": 1752612042968, "storeState": 8347, "state": "0", "articles": [{ "waste": "0", "amount": 6142.909714494509, "articleName": "articleName", "productionOrderId": 445, "articleId": "articleId", "accuracy": 6619.77540663678, "finished": 842.0365749830383, "time": 9410.861371716364, "status": 1354 }], "startDate": 1752612042968, "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": 3185.854179888741, "orderId": 7009, "endDate": 1752612042968, "prReference": "prReference", "customerOrderId": 3646, "workHours": 7813.578347434002, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8880.317533631533, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9685.424409863768, "partAmount": 8899.913426503264, "totalReserved": 6354.98568419327 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3160.085044996328, "name": "name", "comment": "comment", "finishDate": 1752612042968, "storeState": 6277, "state": "0", "articles": [{ "waste": "0", "amount": 2874.140771811777, "articleName": "articleName", "productionOrderId": 8891, "articleId": "articleId", "accuracy": 6239.759976625667, "finished": 1627.378045048824, "time": 602.9916661800927, "status": 3068 }], "startDate": 1752612042968, "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 |