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": 9373.79634939565, "orderId": 4749, "endDate": 1758007683618, "prReference": "prReference", "customerOrderId": 112, "workHours": 1187.9909979194003, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2533.4800644811385, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7654.707802265237, "partAmount": 4606.90013442037, "totalReserved": 6110.320317207771 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6960.85069875924, "name": "name", "comment": "comment", "finishDate": 1758007683618, "storeState": 3732, "state": "0", "articles": [{ "waste": "0", "amount": 6336.609315582548, "articleName": "articleName", "productionOrderId": 2462, "articleId": "articleId", "accuracy": 7918.54426151321, "finished": 7345.999435453775, "time": 890.8071982344457, "status": 8583 }], "startDate": 1758007683618, "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": 3896, "batches": [{ "deliveredAmount": 8040.979151220944, "serialNr": "serialNr", "bestBefore": 468, "batchId": "batchId", "orderedAmount": 6813.706739747184 }], "articleId": "articleId", "countSerial": 5149 }
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": 660.594258283268, "orderId": 694, "endDate": 1758007683634, "prReference": "prReference", "customerOrderId": 5039, "workHours": 4664.294492408017, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1538.5820766125557, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8684.639734915792, "partAmount": 9131.413632685408, "totalReserved": 210.20936448110538 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5639.1422069020555, "name": "name", "comment": "comment", "finishDate": 1758007683634, "storeState": 1217, "state": "0", "articles": [{ "waste": "0", "amount": 4367.378634453076, "articleName": "articleName", "productionOrderId": 5432, "articleId": "articleId", "accuracy": 9341.31936566839, "finished": 5762.3163175854015, "time": 9922.308113092231, "status": 9261 }], "startDate": 1758007683634, "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": 9674.463026928333, "articleName": "articleName", "supplierId": 7578, "purchasePriceMisc": 5856.400787292335, "articleId": "articleId", "purchasePrice": 9805.360829299263, "partAmount": 8512.834073329568, "stockplace": "stockplace", "unit": "unit", "reserved": 8596.319019025432, "purchasePriceShipment": 1153.1994528270418, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 6013.3134516563, "orderId": 4194, "poRef": "poRef", "state": 1347, "deliveryDate": 1758007683635 }] }]}
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": 1795.9328417566933, "orderId": 6842, "endDate": 1758007683638, "prReference": "prReference", "customerOrderId": 1783, "workHours": 5131.565918669341, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9628.541397621215, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 4760.541001440453, "partAmount": 2675.5366083130684, "totalReserved": 1175.7456839633273 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6910.31654989817, "name": "name", "comment": "comment", "finishDate": 1758007683638, "storeState": 1863, "state": "0", "articles": [{ "waste": "0", "amount": 6502.632696985422, "articleName": "articleName", "productionOrderId": 8888, "articleId": "articleId", "accuracy": 3549.837204363011, "finished": 2406.5911801557772, "time": 8199.419439829822, "status": 8220 }], "startDate": 1758007683638, "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": 8317, "pages": 664, "pageSize": 5119, "orders": [{ "finishedAmount": 9311.118945360498, "orderId": 2959, "endDate": 1758007683640, "prReference": "prReference", "customerOrderId": 1960, "workHours": 2737.9743695981874, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2885.3795804516913, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 398.92750984686586, "partAmount": 3006.7867429919525, "totalReserved": 6745.807817388975 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7405.498848683612, "name": "name", "comment": "comment", "finishDate": 1758007683640, "storeState": 8697, "state": "0", "articles": [{ "waste": "0", "amount": 2745.259641880897, "articleName": "articleName", "productionOrderId": 5149, "articleId": "articleId", "accuracy": 9684.273799708686, "finished": 2820.8385878833565, "time": 2315.169723553112, "status": 478 }], "startDate": 1758007683640, "reserveInDepth": "false" }], "page": 5290 }
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": 8256, "pages": 6311, "pageSize": 6785, "orders": [{ "finishedAmount": 9243.559123896992, "orderId": 1660, "endDate": 1758007683643, "prReference": "prReference", "customerOrderId": 280, "workHours": 8680.082817545595, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2985.2900609644116, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1049.0157997539295, "partAmount": 7298.855584333034, "totalReserved": 7245.7097334201335 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7575.391336212402, "name": "name", "comment": "comment", "finishDate": 1758007683643, "storeState": 6363, "state": "0", "articles": [{ "waste": "0", "amount": 1903.3714813319525, "articleName": "articleName", "productionOrderId": 7490, "articleId": "articleId", "accuracy": 8261.513882203464, "finished": 7238.2920182820335, "time": 7127.365109549173, "status": 2481 }], "startDate": 1758007683643, "reserveInDepth": "false" }], "page": 4895 }
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": 4971, "pages": 162, "pageSize": 5789, "orders": [{ "finishedAmount": 1721.027362083919, "orderId": 1786, "endDate": 1758007683646, "prReference": "prReference", "customerOrderId": 6863, "workHours": 5539.548903490976, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5969.126639420125, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9401.306606537755, "partAmount": 3104.4015879005506, "totalReserved": 8176.754126028255 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8937.096949019608, "name": "name", "comment": "comment", "finishDate": 1758007683646, "storeState": 9719, "state": "0", "articles": [{ "waste": "0", "amount": 9050.876338915083, "articleName": "articleName", "productionOrderId": 3382, "articleId": "articleId", "accuracy": 7383.421082908227, "finished": 8004.414023310239, "time": 6559.868866272208, "status": 8937 }], "startDate": 1758007683646, "reserveInDepth": "false" }], "page": 1540 }
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": 3236.965161791814, "orderId": 3616, "endDate": 1758007683652, "prReference": "prReference", "customerOrderId": 6164, "workHours": 4611.999829537626, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2566.44304031016, "name": "name", "comment": "comment", "finishDate": 1758007683652, "storeState": 4847, "state": "0", "startDate": 1758007683652, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 1384.6756657205062, "orderId": 3009, "endDate": 1758007683652, "prReference": "prReference", "customerOrderId": 9876, "workHours": 9023.07657739721, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2964.1182636011044, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 645.507700238761, "partAmount": 4707.616664774487, "totalReserved": 8375.1520222533 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2796.517934597793, "name": "name", "comment": "comment", "finishDate": 1758007683652, "storeState": 2862, "state": "0", "articles": [{ "waste": "0", "amount": 2671.2343867221543, "articleName": "articleName", "productionOrderId": 7700, "articleId": "articleId", "accuracy": 4000.7904192536826, "finished": 9589.802514114373, "time": 8986.215495893788, "status": 4809 }], "startDate": 1758007683652, "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": 3560.9509650860705, "articleName": "articleName", "productionOrderId": 7418, "articleId": "articleId", "finished": 9269.49831897696, "time": 3674.493833108765, "status": 1514 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2571.952157436208, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 4836.715167410995, "partAmount": 4495.059377113667, "totalReserved": 1404.9692601308761 }] }], "articles": [{ "waste": "0", "amount": 1659.091683527215, "articleName": "articleName", "productionOrderId": 3412, "articleId": "articleId", "accuracy": 4395.094326966035, "finished": 2605.093630005666, "time": 7073.534373533858, "status": 6337 }] }
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": 7647.690073903758, "orderId": 3399, "endDate": 1758007683655, "prReference": "prReference", "customerOrderId": 4048, "workHours": 9864.72494249238, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4837.98823638381, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8314.60106315342, "partAmount": 8992.400673805385, "totalReserved": 3704.0013711640518 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2198.4727278682235, "name": "name", "comment": "comment", "finishDate": 1758007683655, "storeState": 3478, "state": "0", "articles": [{ "waste": "0", "amount": 2509.356557841933, "articleName": "articleName", "productionOrderId": 5867, "articleId": "articleId", "accuracy": 640.2102730259518, "finished": 7732.355063703952, "time": 7571.915162648452, "status": 1357 }], "startDate": 1758007683655, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 3174.554036883688, "orderId": 6304, "endDate": 1758007683655, "prReference": "prReference", "customerOrderId": 8287, "workHours": 245.34393593935832, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2833.6479384156587, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5093.746658605067, "partAmount": 9224.339513923469, "totalReserved": 8578.65659471042 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2446.4812890950725, "name": "name", "comment": "comment", "finishDate": 1758007683655, "storeState": 6384, "state": "0", "articles": [{ "waste": "0", "amount": 9206.400513958613, "articleName": "articleName", "productionOrderId": 1805, "articleId": "articleId", "accuracy": 1010.3271348739373, "finished": 9671.560100705277, "time": 9135.060896113571, "status": 5353 }], "startDate": 1758007683655, "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": 9291.55582266394, "articleName": "articleName", "productionOrderId": 8900, "articleId": "articleId", "accuracy": 3406.6674366772245, "finished": 4337.095630804047, "time": 4125.951555044369, "status": 8083 }
Successfull response:
{ "finishedAmount": 343.2436044611309, "orderId": 5113, "endDate": 1758007683657, "prReference": "prReference", "customerOrderId": 5911, "workHours": 5787.27273570464, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2297.873026233853, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3134.0200965809563, "partAmount": 5488.08199188708, "totalReserved": 3275.057894846034 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7042.222364886033, "name": "name", "comment": "comment", "finishDate": 1758007683657, "storeState": 5793, "state": "0", "articles": [{ "waste": "0", "amount": 962.0032007544055, "articleName": "articleName", "productionOrderId": 5245, "articleId": "articleId", "accuracy": 6357.694324871298, "finished": 1311.6773664648463, "time": 6627.590353487229, "status": 2503 }], "startDate": 1758007683657, "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": 4429.6949279005175, "partTraceability": [{ "amount": 9682.144365329605, "serial": [{}], "articleId": "articleId", "batch": "batch" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 2509, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 578.6491115319625, "orderId": 9950, "endDate": 1758007683659, "prReference": "prReference", "customerOrderId": 1869, "workHours": 1941.4810359364342, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6489.526610028496, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1555.587560732158, "partAmount": 2470.9085968499967, "totalReserved": 2072.7516759704513 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1578.4349855064806, "name": "name", "comment": "comment", "finishDate": 1758007683659, "storeState": 3343, "state": "0", "articles": [{ "waste": "0", "amount": 9605.948314905147, "articleName": "articleName", "productionOrderId": 4071, "articleId": "articleId", "accuracy": 9124.358867675071, "finished": 1698.4712368952582, "time": 2152.7781159089445, "status": 8143 }], "startDate": 1758007683659, "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": 7506.757356783165, "orderId": 5809, "endDate": 1758007683661, "prReference": "prReference", "customerOrderId": 3165, "workHours": 2065.0803875494994, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5395.672549722247, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 4080.420568794435, "partAmount": 9966.575295792369, "totalReserved": 4908.352401097212 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3439.6852619201854, "name": "name", "comment": "comment", "finishDate": 1758007683661, "storeState": 3380, "state": "0", "articles": [{ "waste": "0", "amount": 9217.163616085609, "articleName": "articleName", "productionOrderId": 3345, "articleId": "articleId", "accuracy": 4514.740655726885, "finished": 1265.553766952988, "time": 2165.5583055365237, "status": 9157 }], "startDate": 1758007683661, "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": 1390.107871861832, "orderId": 6433, "endDate": 1758007683662, "prReference": "prReference", "customerOrderId": 2797, "workHours": 575.3440911546703, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7531.2558746331715, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8282.944206320986, "partAmount": 679.5521525214499, "totalReserved": 4152.116986457073 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6666.147144413604, "name": "name", "comment": "comment", "finishDate": 1758007683662, "storeState": 6298, "state": "0", "articles": [{ "waste": "0", "amount": 4664.509603553096, "articleName": "articleName", "productionOrderId": 8053, "articleId": "articleId", "accuracy": 6761.782746277688, "finished": 4524.419625352404, "time": 3734.697897788549, "status": 4805 }], "startDate": 1758007683662, "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": 110.85400092062048, "orderId": 4406, "endDate": 1758007683664, "prReference": "prReference", "customerOrderId": 7965, "workHours": 5672.746719851337, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1203.4586992182883, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7263.734186197126, "partAmount": 9606.494552055117, "totalReserved": 8830.329837825291 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5711.699451403424, "name": "name", "comment": "comment", "finishDate": 1758007683664, "storeState": 7686, "state": "0", "articles": [{ "waste": "0", "amount": 495.4131949560159, "articleName": "articleName", "productionOrderId": 8204, "articleId": "articleId", "accuracy": 4594.285262980486, "finished": 8491.718714534994, "time": 7423.360119634219, "status": 8779 }], "startDate": 1758007683664, "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 |