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": 1537.8238820601798, "orderId": 562, "endDate": 1732182996440, "prReference": "prReference", "customerOrderId": 3048, "workHours": 4874.189968689679, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5056.069275677596, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7290.955414114474, "partAmount": 3648.185462240191, "totalReserved": 5758.766345940614 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1134.3719648180072, "name": "name", "comment": "comment", "finishDate": 1732182996440, "storeState": 4007, "state": "0", "articles": [{ "waste": "0", "amount": 592.2047982200606, "articleName": "articleName", "productionOrderId": 7784, "articleId": "articleId", "accuracy": 6028.519987598487, "finished": 473.5675435993381, "time": 2049.4008928609787, "status": 5189 }], "startDate": 1732182996440, "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": 3775, "batches": [{ "deliveredAmount": 5593.078777084869, "serialNr": "serialNr", "bestBefore": 210, "batchId": "batchId", "orderedAmount": 2419.4839598405692 }], "articleId": "articleId", "countSerial": 7011 }
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": 1198, "pages": 4317, "pageSize": 4695, "orders": [{ "finishedAmount": 3226.751235841583, "orderId": 210, "endDate": 1732182996442, "prReference": "prReference", "customerOrderId": 7330, "workHours": 4298.997583838821, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5991.94459676177, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9553.761482219415, "partAmount": 7069.094853427623, "totalReserved": 6196.292014241378 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1266.6613436659545, "name": "name", "comment": "comment", "finishDate": 1732182996442, "storeState": 4847, "state": "0", "articles": [{ "waste": "0", "amount": 6467.590484391179, "articleName": "articleName", "productionOrderId": 1626, "articleId": "articleId", "accuracy": 3369.3781804420564, "finished": 9591.131984561953, "time": 5824.806825475169, "status": 481 }], "startDate": 1732182996442, "reserveInDepth": "false" }], "page": 7613 }
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": 7857, "pages": 2359, "pageSize": 1471, "orders": [{ "finishedAmount": 4677.869010211869, "orderId": 6137, "endDate": 1732182996442, "prReference": "prReference", "customerOrderId": 5915, "workHours": 1221.9453197575947, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 562.9588628976189, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1882.6654783811769, "partAmount": 3806.3516642218333, "totalReserved": 8363.727987445256 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 78.23043581008382, "name": "name", "comment": "comment", "finishDate": 1732182996442, "storeState": 3791, "state": "0", "articles": [{ "waste": "0", "amount": 3952.8686352737795, "articleName": "articleName", "productionOrderId": 1837, "articleId": "articleId", "accuracy": 6794.728287313257, "finished": 332.67615151556964, "time": 8056.792483965131, "status": 5628 }], "startDate": 1732182996442, "reserveInDepth": "false" }], "page": 6133 }
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": 2510.673918822772, "orderId": 2751, "endDate": 1732182996442, "prReference": "prReference", "customerOrderId": 2716, "workHours": 7661.243868405986, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5502.87013406378, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5758.067184689038, "partAmount": 8882.343757549723, "totalReserved": 7201.831853923087 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3509.9734118430347, "name": "name", "comment": "comment", "finishDate": 1732182996442, "storeState": 6301, "state": "0", "articles": [{ "waste": "0", "amount": 3778.1815691022225, "articleName": "articleName", "productionOrderId": 7391, "articleId": "articleId", "accuracy": 8943.578535795776, "finished": 8677.149527467684, "time": 9227.3320905447, "status": 6093 }], "startDate": 1732182996442, "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": 2969.246483708876, "articleName": "articleName", "supplierId": 440, "purchasePriceMisc": 7369.557413532015, "articleId": "articleId", "purchasePrice": 3353.2906932695473, "partAmount": 1638.0900961157474, "stockplace": "stockplace", "unit": "unit", "reserved": 3218.3301728944734, "purchasePriceShipment": 7067.24184308935, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 9778.095025185536, "orderId": 906, "poRef": "poRef", "state": 4118, "deliveryDate": 1732182996442 }] }]}
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": 5569.721333750398, "orderId": 4665, "endDate": 1732182996442, "prReference": "prReference", "customerOrderId": 275, "workHours": 5346.3679540965795, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4346.913881829867, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9291.923381067849, "partAmount": 9682.355781278931, "totalReserved": 9337.717357743677 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8833.90712642711, "name": "name", "comment": "comment", "finishDate": 1732182996442, "storeState": 1971, "state": "0", "articles": [{ "waste": "0", "amount": 9329.136473721568, "articleName": "articleName", "productionOrderId": 7920, "articleId": "articleId", "accuracy": 6871.205182145782, "finished": 7359.111128400905, "time": 1920.6292830534055, "status": 1439 }], "startDate": 1732182996442, "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": 8908, "pages": 9062, "pageSize": 4098, "orders": [{ "finishedAmount": 4692.908105489688, "orderId": 5742, "endDate": 1732182996443, "prReference": "prReference", "customerOrderId": 4127, "workHours": 3134.6705690181266, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7566.064651110597, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3497.7780094461564, "partAmount": 7059.68108926475, "totalReserved": 8921.283633671515 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7316.604172250396, "name": "name", "comment": "comment", "finishDate": 1732182996443, "storeState": 2212, "state": "0", "articles": [{ "waste": "0", "amount": 3156.087871717326, "articleName": "articleName", "productionOrderId": 6025, "articleId": "articleId", "accuracy": 8550.554822577953, "finished": 6860.355815423267, "time": 3375.2859917640444, "status": 6817 }], "startDate": 1732182996443, "reserveInDepth": "false" }], "page": 3162 }
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": 4954.99184706476, "orderId": 3769, "endDate": 1732182996443, "prReference": "prReference", "customerOrderId": 3756, "workHours": 8274.531207058513, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2898.125835124956, "name": "name", "comment": "comment", "finishDate": 1732182996443, "storeState": 6647, "state": "0", "startDate": 1732182996443, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 8227.322316414073, "orderId": 383, "endDate": 1732182996443, "prReference": "prReference", "customerOrderId": 7504, "workHours": 743.0337548355149, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9533.632634897756, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1313.7440798326893, "partAmount": 2413.459011934107, "totalReserved": 7016.987027980862 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2010.8039370150254, "name": "name", "comment": "comment", "finishDate": 1732182996443, "storeState": 6669, "state": "0", "articles": [{ "waste": "0", "amount": 6414.109001076829, "articleName": "articleName", "productionOrderId": 6661, "articleId": "articleId", "accuracy": 9573.474472804555, "finished": 7443.962310308221, "time": 2274.3226969349294, "status": 3622 }], "startDate": 1732182996443, "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": 2091.8290089156353, "articleName": "articleName", "productionOrderId": 5742, "articleId": "articleId", "finished": 199.78178299518757, "time": 5158.427466096593, "status": 5943 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1177.1733706669486, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5270.556030102578, "partAmount": 3926.4857072996197, "totalReserved": 1653.0022934291567 }] }], "articles": [{ "waste": "0", "amount": 7404.423643902019, "articleName": "articleName", "productionOrderId": 3181, "articleId": "articleId", "accuracy": 8146.377000440045, "finished": 6394.468380177004, "time": 8312.84078834442, "status": 8210 }] }
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": 2574.123577762796, "orderId": 8849, "endDate": 1732182996444, "prReference": "prReference", "customerOrderId": 6963, "workHours": 3602.8114063269422, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 138.68893100224545, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9019.166570870699, "partAmount": 9051.100156007176, "totalReserved": 4193.839432585619 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1318.3162146019279, "name": "name", "comment": "comment", "finishDate": 1732182996444, "storeState": 8599, "state": "0", "articles": [{ "waste": "0", "amount": 8908.214735047566, "articleName": "articleName", "productionOrderId": 186, "articleId": "articleId", "accuracy": 2116.617233896262, "finished": 412.9077658990754, "time": 6365.4225227387105, "status": 9939 }], "startDate": 1732182996444, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 5395.718471037523, "orderId": 4871, "endDate": 1732182996444, "prReference": "prReference", "customerOrderId": 3507, "workHours": 1537.517929258606, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5738.356694147321, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5118.1548150005065, "partAmount": 2804.0488242027395, "totalReserved": 2395.400683881922 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2935.4606562638087, "name": "name", "comment": "comment", "finishDate": 1732182996444, "storeState": 6825, "state": "0", "articles": [{ "waste": "0", "amount": 4766.778011374324, "articleName": "articleName", "productionOrderId": 7126, "articleId": "articleId", "accuracy": 6138.7942741824045, "finished": 2463.04777532906, "time": 4676.177574557349, "status": 3895 }], "startDate": 1732182996444, "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": 3271.7529484163265, "articleName": "articleName", "productionOrderId": 296, "articleId": "articleId", "accuracy": 1993.1503553997509, "finished": 621.0921654833645, "time": 9030.003015110988, "status": 5677 }
Successfull response:
{ "finishedAmount": 7244.712294725095, "orderId": 7753, "endDate": 1732182996451, "prReference": "prReference", "customerOrderId": 3670, "workHours": 3161.6927264017722, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6781.513374981552, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5925.088818674864, "partAmount": 8368.774684866912, "totalReserved": 525.8537932562468 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7978.9095767039935, "name": "name", "comment": "comment", "finishDate": 1732182996451, "storeState": 1661, "state": "0", "articles": [{ "waste": "0", "amount": 5658.693127928583, "articleName": "articleName", "productionOrderId": 6343, "articleId": "articleId", "accuracy": 94.11512133573163, "finished": 4740.649425303001, "time": 3969.430726438743, "status": 6058 }], "startDate": 1732182996451, "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": 9102.76512662588, "partTraceability": [{ "amount": 2666.144241990802, "serial": [{}], "articleId": "articleId", "batch": "batch" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 5708, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 8254.373536030274, "orderId": 2184, "endDate": 1732182996452, "prReference": "prReference", "customerOrderId": 8783, "workHours": 1365.9358056453996, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4891.675328088026, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1519.2206869875424, "partAmount": 7151.107419333226, "totalReserved": 843.8810558556853 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1980.9748035957875, "name": "name", "comment": "comment", "finishDate": 1732182996452, "storeState": 1575, "state": "0", "articles": [{ "waste": "0", "amount": 8388.593253520308, "articleName": "articleName", "productionOrderId": 1887, "articleId": "articleId", "accuracy": 9736.39450390843, "finished": 5553.8350657133005, "time": 5353.014046599797, "status": 5498 }], "startDate": 1732182996452, "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": 3395.186448697315, "orderId": 3747, "endDate": 1732182996452, "prReference": "prReference", "customerOrderId": 2454, "workHours": 3363.0458046735034, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8877.970587235015, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5450.896524828311, "partAmount": 3820.0008229989226, "totalReserved": 5260.9859342970085 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1441.5090704597, "name": "name", "comment": "comment", "finishDate": 1732182996452, "storeState": 1438, "state": "0", "articles": [{ "waste": "0", "amount": 9412.342959469612, "articleName": "articleName", "productionOrderId": 1551, "articleId": "articleId", "accuracy": 3855.778214504758, "finished": 8498.073698154702, "time": 636.1253512667676, "status": 139 }], "startDate": 1732182996452, "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": 906.5650778714319, "orderId": 9493, "endDate": 1732182996452, "prReference": "prReference", "customerOrderId": 2295, "workHours": 233.33919881109333, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7555.925053967861, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2087.276278270281, "partAmount": 9026.954948774857, "totalReserved": 9321.326740590277 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1834.6741302169378, "name": "name", "comment": "comment", "finishDate": 1732182996452, "storeState": 1325, "state": "0", "articles": [{ "waste": "0", "amount": 271.1930024497944, "articleName": "articleName", "productionOrderId": 6242, "articleId": "articleId", "accuracy": 5725.601449117017, "finished": 5864.736527394373, "time": 7775.589705064603, "status": 3529 }], "startDate": 1732182996452, "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": 9709.937788116713, "orderId": 2058, "endDate": 1732182996452, "prReference": "prReference", "customerOrderId": 4958, "workHours": 5792.5355245013125, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7485.033757146575, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 933.9578530538528, "partAmount": 9003.256434538973, "totalReserved": 3099.336953163571 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9284.633317535452, "name": "name", "comment": "comment", "finishDate": 1732182996452, "storeState": 2418, "state": "0", "articles": [{ "waste": "0", "amount": 5970.843553877112, "articleName": "articleName", "productionOrderId": 9429, "articleId": "articleId", "accuracy": 1429.852237084529, "finished": 5587.758187549411, "time": 3559.441398412634, "status": 5173 }], "startDate": 1732182996452, "reserveInDepth": "false" }
Classes:
FlatBundledArticle
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for a single article within the bundled article | R,W | ||||
articleName | String | R,W | |||||
reserved | Double | R,W | |||||
amount | Double | R,W | |||||
partAmount | Double | R,W | |||||
purchasePrice | Double | R,W | |||||
purchasePriceMisc | Double | R,W | |||||
purchasePriceShipment | Double | R,W | |||||
supplierId | Long | R,W | |||||
supplierName | String | R,W | |||||
supplierArticleId | String | R,W | |||||
unit | String | R,W | |||||
stockplace | String | R,W | |||||
purchaseOrders | List | R,W |
FlatBundledArticlePurchaseOrder
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
orderId | Long | R,W | |||||
poRef | String | R,W | |||||
ordered | Double | R,W | |||||
state | int | R,W | |||||
deliveryDate | Date | R,W |
FlatBundledArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R |
PartTraceability
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R,W | |||||
amount | double | R,W | |||||
batch | String | R,W | |||||
serial | List | R,W |
ProductionOrder
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
orderId | Long | When updating a production order (PUT) | R,W | ||||
prReference | String | Unique ProductionOrder-id which the customer can decide themselves | R,W | ||||
customerOrderId | Long | POST | must point to an existing customerOrder | R,W | |||
customerOrderExternalId | String | R,W | |||||
internalReference | String | R,W | |||||
name | String | R,W | |||||
comment | String | R,W | |||||
startDate | Date | R,W | |||||
endDate | Date | R,W | |||||
finishDate | Date | R,W | |||||
workHours | Double | R,W | |||||
state | Integer | Write only with POST | 0 | NEW = 0, DEVELOPING = 1, FINISHED = 2, CANCELLED = 3 |
R,W | ||
reserveInDepth | Boolean | Flag to indicate if reservation should be done on only first layer of bundled articles, or if it should be done on all simple articles in all layers | false | R,W | |||
storeState | Integer | R,W | |||||
totalAmount | Double | R,W | |||||
finishedAmount | Double | R,W | |||||
articles | List | List of ProductionOrderArticles | R | ||||
singleArticles | List | List of ProductionOrderSingleArticles | R |
ProductionOrderArticle
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
productionOrderId | long | R,W | |||||
articleId | String | R,W | |||||
articleName | String | R,W | |||||
time | Double | R,W | |||||
amount | Double | R,W | |||||
finished | Double | R,W | |||||
waste | Double | Total number of produced is finished plus waste | 0 | R,W | |||
status | int | R,W | |||||
accuracy | Double | Percentage on accuracy of the production result. A positive accuracy describes a general overproduction, while a negative accuracy describes waste in production | R |
ProductionOrderArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R | |||||
parts | List | R |
ProductionOrderArticleTraceability
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for bundled article | R,W | ||||
batch | String | Batch for bundled article | R,W | ||||
serial | String | Serial number for bundled article | R,W | ||||
amount | double | Amount to be produced for bundled article | R,W | ||||
bestBefore | Long | Best before for bundled article | R,W | ||||
barcode | String | Barcode for bundled article | R,W | ||||
partTraceability | List | List of traceability for all parts in the bundled article | R,W | ||||
limitPartAmounts | Boolean | Set flag to true if we want to limit part amounts to ordered amount when overproducing | false | R,W |
ProductionOrderBatchResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R | |||||
countBatch | int | R | |||||
countSerial | int | R | |||||
batches | List | R |
ProductionOrderProductBatch
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
batchId | String | R,W | |||||
serialNr | String | R,W | |||||
orderedAmount | Double | R,W | |||||
deliveredAmount | Double | R,W | |||||
bestBefore | Long | R,W |
ProductionOrderRef
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
prReference | String | Next available purchase order reference | R |
ProductionOrderSingleArticleGroup
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R,W | |||||
singleArticles | List | R,W |
ProductionOrderSingleArticleReserved
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for the bundled article | R,W | ||||
singleArticleId | String | Article id for a single article within the bundled article | R,W | ||||
singleArticleName | String | R,W | |||||
totalReserved | Double | R,W | |||||
totalAmount | Double | R,W | |||||
partAmount | Double | R,W | |||||
purchasePrice | Double | R,W | |||||
hasStockValue | Boolean | R,W |
ProductionOrdersResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
page | int | R | |||||
pages | int | R | |||||
pageSize | int | R | |||||
ordersCount | int | R | |||||
orders | List | R |