Production orders API
Production orders API provides methods for handling production orders from suppliers
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": 6483.312494257752, "orderId": 5536, "endDate": 1774240893587, "prReference": "prReference", "customerOrderId": 2532, "workHours": 7208.452608868504, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4486.245962410524, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5756.681303780751, "partAmount": 3855.8828203517405, "totalReserved": 2123.155831847732 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1298.783416222008, "name": "name", "comment": "comment", "finishDate": 1774240893587, "storeState": 4824, "state": "0", "articles": [{ "waste": "0", "amount": 5020.5983495972205, "articleName": "articleName", "productionOrderId": 4337, "articleId": "articleId", "accuracy": 3548.863436394276, "finished": 4973.2521880327995, "time": 5516.761726621287, "status": 4013 }], "startDate": 1774240893587, "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 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": 3327, "pages": 3536, "pageSize": 9043, "orders": [{ "finishedAmount": 8894.863315572604, "orderId": 5384, "endDate": 1774240893588, "prReference": "prReference", "customerOrderId": 2856, "workHours": 5159.408631511875, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9347.283262989333, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6969.174217600864, "partAmount": 3602.1682708657922, "totalReserved": 9127.146937322543 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8526.401418695672, "name": "name", "comment": "comment", "finishDate": 1774240893588, "storeState": 7907, "state": "0", "articles": [{ "waste": "0", "amount": 9385.741164943278, "articleName": "articleName", "productionOrderId": 9254, "articleId": "articleId", "accuracy": 9058.089802932605, "finished": 8143.722133098355, "time": 8362.123859522157, "status": 8627 }], "startDate": 1774240893588, "reserveInDepth": "false" }], "page": 9604 }
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": 4136, "batches": [{ "deliveredAmount": 7904.255310778918, "serialNr": "serialNr", "bestBefore": 5500, "batchId": "batchId", "orderedAmount": 8597.450820308468 }], "articleId": "articleId", "countSerial": 2032 }
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": 1735.5648911270594, "orderId": 2613, "endDate": 1774240893588, "prReference": "prReference", "customerOrderId": 1259, "workHours": 2983.3097620192193, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9951.158976895129, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9478.765059668061, "partAmount": 6498.840383747918, "totalReserved": 5327.0117810186875 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9835.088766007766, "name": "name", "comment": "comment", "finishDate": 1774240893588, "storeState": 8627, "state": "0", "articles": [{ "waste": "0", "amount": 5224.710101388124, "articleName": "articleName", "productionOrderId": 8166, "articleId": "articleId", "accuracy": 6033.721928774446, "finished": 5881.847792142876, "time": 4724.1186585472515, "status": 1010 }], "startDate": 1774240893588, "reserveInDepth": "false" }
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": 2752, "pages": 1277, "pageSize": 7095, "orders": [{ "finishedAmount": 3599.1275612965755, "orderId": 865, "endDate": 1774240893589, "prReference": "prReference", "customerOrderId": 5372, "workHours": 3743.3261477749047, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4775.603875444308, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7570.297915701344, "partAmount": 2101.017644454187, "totalReserved": 6419.676118956431 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6122.220323670849, "name": "name", "comment": "comment", "finishDate": 1774240893589, "storeState": 3190, "state": "0", "articles": [{ "waste": "0", "amount": 7691.848850397122, "articleName": "articleName", "productionOrderId": 6459, "articleId": "articleId", "accuracy": 9380.19790312702, "finished": 1782.394856189119, "time": 3064.176926966723, "status": 5244 }], "startDate": 1774240893589, "reserveInDepth": "false" }], "page": 8104 }
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": 3678.0745591795962, "articleName": "articleName", "supplierId": 6238, "purchasePriceMisc": 4650.113164600759, "articleId": "articleId", "purchasePrice": 3501.9514924006667, "partAmount": 2329.258423870357, "stockplace": "stockplace", "unit": "unit", "reserved": 4300.628337619907, "purchasePriceShipment": 3022.745140667763, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 3416.8055381150275, "orderId": 2731, "poRef": "poRef", "state": 7623, "deliveryDate": 1774240893589 }] }]}
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": 3408.239987998617, "orderId": 1918, "endDate": 1774240893591, "prReference": "prReference", "customerOrderId": 7818, "workHours": 2585.6349920059206, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9002.999890372665, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7133.935611458127, "partAmount": 9683.355538157406, "totalReserved": 8150.965894347024 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9904.655095474778, "name": "name", "comment": "comment", "finishDate": 1774240893591, "storeState": 4177, "state": "0", "articles": [{ "waste": "0", "amount": 4966.028449651383, "articleName": "articleName", "productionOrderId": 2560, "articleId": "articleId", "accuracy": 61.3819160927731, "finished": 200.2621323032938, "time": 5337.177484058565, "status": 7999 }], "startDate": 1774240893591, "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": 7108, "pages": 1086, "pageSize": 927, "orders": [{ "finishedAmount": 2361.494502561278, "orderId": 2634, "endDate": 1774240893591, "prReference": "prReference", "customerOrderId": 1778, "workHours": 9536.346056314575, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2160.952596474924, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7270.730434502298, "partAmount": 7004.029023833896, "totalReserved": 7238.8678496539105 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5634.602370359809, "name": "name", "comment": "comment", "finishDate": 1774240893591, "storeState": 6806, "state": "0", "articles": [{ "waste": "0", "amount": 1804.2342391774869, "articleName": "articleName", "productionOrderId": 8049, "articleId": "articleId", "accuracy": 3131.8960331136313, "finished": 7232.7861384099615, "time": 3940.058566983944, "status": 3899 }], "startDate": 1774240893591, "reserveInDepth": "false" }], "page": 3623 }
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": 392.94279746014513, "orderId": 3381, "endDate": 1774240893592, "prReference": "prReference", "customerOrderId": 4702, "workHours": 1771.9177215466952, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3725.298565142825, "name": "name", "comment": "comment", "finishDate": 1774240893592, "storeState": 6589, "state": "0", "startDate": 1774240893592, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 8283.961627169434, "orderId": 5307, "endDate": 1774240893592, "prReference": "prReference", "customerOrderId": 1644, "workHours": 9155.669633170857, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1600.9973468608462, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2604.7090630558455, "partAmount": 4822.0103664896615, "totalReserved": 775.8492154205943 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8328.263487065597, "name": "name", "comment": "comment", "finishDate": 1774240893592, "storeState": 5194, "state": "0", "articles": [{ "waste": "0", "amount": 5919.679568271713, "articleName": "articleName", "productionOrderId": 6005, "articleId": "articleId", "accuracy": 609.4140273971749, "finished": 7229.154141699006, "time": 3969.7516328345737, "status": 5204 }], "startDate": 1774240893592, "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": 1620.3701964889717, "articleName": "articleName", "productionOrderId": 8603, "articleId": "articleId", "finished": 304.59128193240036, "time": 6373.095441265044, "status": 3484 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4604.466604605486, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8864.668152246819, "partAmount": 6661.772821531918, "totalReserved": 9449.262235974302 }] }], "articles": [{ "waste": "0", "amount": 5411.835131377822, "articleName": "articleName", "productionOrderId": 3505, "articleId": "articleId", "accuracy": 3249.869829327884, "finished": 6082.351836508183, "time": 5037.874698884337, "status": 3917 }] }
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": 3182.064378580167, "orderId": 2193, "endDate": 1774240893592, "prReference": "prReference", "customerOrderId": 7347, "workHours": 6919.012857263981, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7141.261509934416, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3039.809933637624, "partAmount": 961.2295796682191, "totalReserved": 2832.814533115484 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9317.42706140896, "name": "name", "comment": "comment", "finishDate": 1774240893592, "storeState": 5515, "state": "0", "articles": [{ "waste": "0", "amount": 9040.571621913505, "articleName": "articleName", "productionOrderId": 9699, "articleId": "articleId", "accuracy": 9808.839877050032, "finished": 8268.615002992423, "time": 2023.2151371465368, "status": 5835 }], "startDate": 1774240893592, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 3230.463394612472, "orderId": 1114, "endDate": 1774240893592, "prReference": "prReference", "customerOrderId": 6416, "workHours": 5677.419291749656, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4616.168125433932, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2238.561548831689, "partAmount": 1325.2538981078321, "totalReserved": 1721.4792290405235 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7710.739966170086, "name": "name", "comment": "comment", "finishDate": 1774240893592, "storeState": 1421, "state": "0", "articles": [{ "waste": "0", "amount": 8152.172448040144, "articleName": "articleName", "productionOrderId": 5733, "articleId": "articleId", "accuracy": 3978.0675638945395, "finished": 934.316785282997, "time": 9962.137780873645, "status": 871 }], "startDate": 1774240893592, "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": 5757.037596234953, "articleName": "articleName", "productionOrderId": 9097, "articleId": "articleId", "accuracy": 7703.684009762208, "finished": 5009.399957387818, "time": 2231.9123812375396, "status": 6084 }
Successfull response:
{ "finishedAmount": 1175.8649938622646, "orderId": 9960, "endDate": 1774240893593, "prReference": "prReference", "customerOrderId": 4495, "workHours": 8736.627358462372, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8896.15201390694, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 454.7445194888899, "partAmount": 8166.235279845132, "totalReserved": 6528.097293681725 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7608.54152349017, "name": "name", "comment": "comment", "finishDate": 1774240893593, "storeState": 3213, "state": "0", "articles": [{ "waste": "0", "amount": 784.8257027459981, "articleName": "articleName", "productionOrderId": 8192, "articleId": "articleId", "accuracy": 7251.614068826332, "finished": 7462.787953079187, "time": 1208.6295896883526, "status": 8318 }], "startDate": 1774240893593, "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": 4967.16469560469, "partTraceability": [{ "batches": [{ "amount": 5844.196657493769, "batchId": "batchId" }], "amount": 2477.071685227612, "serial": [{}], "articleId": "articleId" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 6457, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 6146.574057522111, "orderId": 1408, "endDate": 1774240893593, "prReference": "prReference", "customerOrderId": 8783, "workHours": 3944.920758773899, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3871.7336157134273, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8289.803129496135, "partAmount": 6817.9241513631105, "totalReserved": 500.92298519063047 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4744.772573967133, "name": "name", "comment": "comment", "finishDate": 1774240893593, "storeState": 8429, "state": "0", "articles": [{ "waste": "0", "amount": 4318.036318581623, "articleName": "articleName", "productionOrderId": 5793, "articleId": "articleId", "accuracy": 2034.0772216777482, "finished": 2986.6155664878024, "time": 5862.884408456922, "status": 5734 }], "startDate": 1774240893593, "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": 4696.691625518093, "orderId": 688, "endDate": 1774240893594, "prReference": "prReference", "customerOrderId": 5900, "workHours": 2604.734565232556, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3303.252047379193, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6883.9686839381175, "partAmount": 6225.920645782974, "totalReserved": 9976.218262894643 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6337.8079022542, "name": "name", "comment": "comment", "finishDate": 1774240893594, "storeState": 3526, "state": "0", "articles": [{ "waste": "0", "amount": 6704.784504051964, "articleName": "articleName", "productionOrderId": 250, "articleId": "articleId", "accuracy": 7647.082818239001, "finished": 5082.583560742881, "time": 2149.916250643702, "status": 1807 }], "startDate": 1774240893594, "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": 8733.567173316958, "orderId": 4840, "endDate": 1774240893594, "prReference": "prReference", "customerOrderId": 5027, "workHours": 7388.119360485044, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1057.6900451019987, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9175.610580159198, "partAmount": 6939.4034917609915, "totalReserved": 8251.491248394777 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2825.626710822976, "name": "name", "comment": "comment", "finishDate": 1774240893594, "storeState": 942, "state": "0", "articles": [{ "waste": "0", "amount": 8095.7046237347895, "articleName": "articleName", "productionOrderId": 8563, "articleId": "articleId", "accuracy": 5793.714089060225, "finished": 8128.996264400315, "time": 7049.2637482742175, "status": 1738 }], "startDate": 1774240893594, "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": 3967.751263943742, "orderId": 122, "endDate": 1774240893594, "prReference": "prReference", "customerOrderId": 8397, "workHours": 5546.516648500792, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1528.3862038824625, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5829.553500278738, "partAmount": 9996.068232237527, "totalReserved": 2021.4363319609786 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7865.769978660809, "name": "name", "comment": "comment", "finishDate": 1774240893594, "storeState": 7758, "state": "0", "articles": [{ "waste": "0", "amount": 3804.141418163449, "articleName": "articleName", "productionOrderId": 7123, "articleId": "articleId", "accuracy": 6518.725378663681, "finished": 5880.341866496012, "time": 3378.926479436123, "status": 8302 }], "startDate": 1774240893594, "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 |
PartTraceabilityBatchDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| batchId | String | R,W | |||||
| amount | double | R,W |
PartTraceabilityDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| articleId | String | R,W | |||||
| amount | double | R,W | |||||
| batches | List | List of batches that should be used for this production. For multiple productions don`t include the whole history | R,W | ||||
| serial | List | List of serial numbers that should be used for this production. For multiple productions don`t include the whole history | 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 | |||||
| unit | 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 |