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": 6886.6963213374365, "orderId": 6902, "endDate": 1765735950727, "prReference": "prReference", "customerOrderId": 9631, "workHours": 7301.828742489534, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2119.542916970122, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7138.765279256793, "partAmount": 3439.647109791939, "totalReserved": 2839.057934239153 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9748.984360820983, "name": "name", "comment": "comment", "finishDate": 1765735950727, "storeState": 4774, "state": "0", "articles": [{ "waste": "0", "amount": 4850.009762260178, "articleName": "articleName", "productionOrderId": 8319, "articleId": "articleId", "accuracy": 7470.481324063024, "finished": 8674.799278863944, "time": 6744.321537562724, "status": 591 }], "startDate": 1765735950727, "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": 983, "pages": 2669, "pageSize": 267, "orders": [{ "finishedAmount": 1888.457486625279, "orderId": 5583, "endDate": 1765735950728, "prReference": "prReference", "customerOrderId": 3617, "workHours": 5422.5579725632515, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6464.131299671749, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 4374.230020060573, "partAmount": 2740.5010485197868, "totalReserved": 6584.167832238449 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 649.5646811796141, "name": "name", "comment": "comment", "finishDate": 1765735950728, "storeState": 9156, "state": "0", "articles": [{ "waste": "0", "amount": 7435.323134277668, "articleName": "articleName", "productionOrderId": 9582, "articleId": "articleId", "accuracy": 7884.053028291507, "finished": 9133.73342136783, "time": 3702.903184928712, "status": 5087 }], "startDate": 1765735950728, "reserveInDepth": "false" }], "page": 5701 }
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": 8659, "batches": [{ "deliveredAmount": 209.30553992022593, "serialNr": "serialNr", "bestBefore": 8191, "batchId": "batchId", "orderedAmount": 8102.9495686395385 }], "articleId": "articleId", "countSerial": 8070 }
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": 9273, "pages": 5022, "pageSize": 458, "orders": [{ "finishedAmount": 6645.2047805745715, "orderId": 2521, "endDate": 1765735950728, "prReference": "prReference", "customerOrderId": 5215, "workHours": 9626.297475296511, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6339.912586051249, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1085.7146658685724, "partAmount": 7682.427026485458, "totalReserved": 5418.794511526797 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3832.7629176249857, "name": "name", "comment": "comment", "finishDate": 1765735950728, "storeState": 8626, "state": "0", "articles": [{ "waste": "0", "amount": 8162.353295415622, "articleName": "articleName", "productionOrderId": 5786, "articleId": "articleId", "accuracy": 8397.46492344122, "finished": 4097.681831544792, "time": 1474.7222761005874, "status": 3440 }], "startDate": 1765735950728, "reserveInDepth": "false" }], "page": 9036 }
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": 6866, "pages": 7817, "pageSize": 2813, "orders": [{ "finishedAmount": 591.929493694493, "orderId": 5041, "endDate": 1765735950728, "prReference": "prReference", "customerOrderId": 2939, "workHours": 2476.7464935498774, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 4026.959145487412, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1909.4982219366452, "partAmount": 5727.22620783153, "totalReserved": 6702.556540877127 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 810.2629578277309, "name": "name", "comment": "comment", "finishDate": 1765735950728, "storeState": 5341, "state": "0", "articles": [{ "waste": "0", "amount": 2144.300278844876, "articleName": "articleName", "productionOrderId": 9427, "articleId": "articleId", "accuracy": 5671.681830482607, "finished": 1057.676689979501, "time": 7600.465642267646, "status": 15 }], "startDate": 1765735950728, "reserveInDepth": "false" }], "page": 3406 }
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": 7156.83892222022, "articleName": "articleName", "supplierId": 4134, "purchasePriceMisc": 330.8106777990949, "articleId": "articleId", "purchasePrice": 6417.91624073108, "partAmount": 9237.914698538456, "stockplace": "stockplace", "unit": "unit", "reserved": 1464.98648868411, "purchasePriceShipment": 7605.652429812003, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 1476.0632693366492, "orderId": 211, "poRef": "poRef", "state": 5096, "deliveryDate": 1765735950729 }] }]}
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": 3617.398592613532, "orderId": 7943, "endDate": 1765735950729, "prReference": "prReference", "customerOrderId": 3503, "workHours": 6527.711113080121, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3412.4191531475813, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3425.90621517053, "partAmount": 7293.981213412688, "totalReserved": 8060.516225990358 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2747.6549743830647, "name": "name", "comment": "comment", "finishDate": 1765735950729, "storeState": 1790, "state": "0", "articles": [{ "waste": "0", "amount": 6457.015086012955, "articleName": "articleName", "productionOrderId": 2850, "articleId": "articleId", "accuracy": 7883.667981144618, "finished": 9079.651843268151, "time": 5382.5837215814245, "status": 7787 }], "startDate": 1765735950729, "reserveInDepth": "false" }
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": 3759.510573660674, "orderId": 4825, "endDate": 1765735950729, "prReference": "prReference", "customerOrderId": 811, "workHours": 8178.737388980939, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2894.706703751316, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9.721464144403225, "partAmount": 8739.047287077012, "totalReserved": 4.670348701112381 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7034.257989572478, "name": "name", "comment": "comment", "finishDate": 1765735950729, "storeState": 777, "state": "0", "articles": [{ "waste": "0", "amount": 9636.768475964014, "articleName": "articleName", "productionOrderId": 2296, "articleId": "articleId", "accuracy": 1128.8654639188233, "finished": 1387.4159414187027, "time": 5726.196353660973, "status": 5925 }], "startDate": 1765735950729, "reserveInDepth": "false" }
Add production order
POSTUrl:
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Add a new production order
Body:
{ "finishedAmount": 5815.262425134951, "orderId": 2693, "endDate": 1765735950730, "prReference": "prReference", "customerOrderId": 5198, "workHours": 807.6061335459573, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6491.944540420739, "name": "name", "comment": "comment", "finishDate": 1765735950730, "storeState": 4878, "state": "0", "startDate": 1765735950730, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 7394.684137101147, "orderId": 6209, "endDate": 1765735950730, "prReference": "prReference", "customerOrderId": 6539, "workHours": 3478.0707478377935, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8621.752424593642, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5733.737748505656, "partAmount": 6978.230563860026, "totalReserved": 3777.782113738073 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2433.865437303251, "name": "name", "comment": "comment", "finishDate": 1765735950730, "storeState": 8037, "state": "0", "articles": [{ "waste": "0", "amount": 7797.713527929014, "articleName": "articleName", "productionOrderId": 2289, "articleId": "articleId", "accuracy": 7022.998241786101, "finished": 2032.656307449402, "time": 9083.068468924677, "status": 7700 }], "startDate": 1765735950730, "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": 3951.6548358287673, "articleName": "articleName", "productionOrderId": 8002, "articleId": "articleId", "finished": 6464.58536270887, "time": 9736.782977631465, "status": 4380 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5740.152171561204, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9426.245383181089, "partAmount": 5315.017702350059, "totalReserved": 1389.4147460813022 }] }], "articles": [{ "waste": "0", "amount": 2589.28228058254, "articleName": "articleName", "productionOrderId": 2759, "articleId": "articleId", "accuracy": 7774.241549049902, "finished": 5362.48459932912, "time": 8596.506946678861, "status": 1757 }] }
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": 3532.099614727433, "orderId": 6381, "endDate": 1765735950730, "prReference": "prReference", "customerOrderId": 2373, "workHours": 7461.2851747688765, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3839.0622011509936, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6298.241824659935, "partAmount": 9152.635683780469, "totalReserved": 9043.922152077335 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6870.288235297348, "name": "name", "comment": "comment", "finishDate": 1765735950730, "storeState": 5568, "state": "0", "articles": [{ "waste": "0", "amount": 8111.440431004189, "articleName": "articleName", "productionOrderId": 8388, "articleId": "articleId", "accuracy": 7651.8402920010185, "finished": 8155.205598156083, "time": 5953.453443145507, "status": 7960 }], "startDate": 1765735950730, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 1517.1686984629018, "orderId": 2121, "endDate": 1765735950730, "prReference": "prReference", "customerOrderId": 9907, "workHours": 1828.218991424223, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5964.6277723180065, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5899.820736657737, "partAmount": 153.99533009283095, "totalReserved": 7740.325429018727 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4503.017234249712, "name": "name", "comment": "comment", "finishDate": 1765735950730, "storeState": 2075, "state": "0", "articles": [{ "waste": "0", "amount": 5809.959724124805, "articleName": "articleName", "productionOrderId": 3596, "articleId": "articleId", "accuracy": 6986.185691125082, "finished": 6261.330435647606, "time": 6739.205297934586, "status": 2341 }], "startDate": 1765735950730, "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": 6183.709249592289, "articleName": "articleName", "productionOrderId": 1517, "articleId": "articleId", "accuracy": 4788.634121022291, "finished": 9991.79811183927, "time": 3355.3313282595254, "status": 7076 }
Successfull response:
{ "finishedAmount": 3214.134639028703, "orderId": 352, "endDate": 1765735950731, "prReference": "prReference", "customerOrderId": 3812, "workHours": 1670.4262227629229, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2539.1570713158717, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2454.4091192394703, "partAmount": 8376.63708927171, "totalReserved": 505.28327812489505 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9947.271972218905, "name": "name", "comment": "comment", "finishDate": 1765735950731, "storeState": 1378, "state": "0", "articles": [{ "waste": "0", "amount": 3061.404174188359, "articleName": "articleName", "productionOrderId": 5213, "articleId": "articleId", "accuracy": 9994.241863906174, "finished": 1958.3508169679121, "time": 36.59239742291875, "status": 5592 }], "startDate": 1765735950731, "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": 7267.715071189174, "partTraceability": [{ "batches": [{ "amount": 7495.76462143246, "batchId": "batchId" }], "amount": 9108.276802919292, "serial": [{}], "articleId": "articleId" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 982, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 554.4693037665837, "orderId": 8152, "endDate": 1765735950731, "prReference": "prReference", "customerOrderId": 8661, "workHours": 9494.094339268011, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6636.691989955712, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1626.1104287774097, "partAmount": 7511.130399332011, "totalReserved": 9416.729435477002 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7082.3854812908685, "name": "name", "comment": "comment", "finishDate": 1765735950731, "storeState": 3531, "state": "0", "articles": [{ "waste": "0", "amount": 1742.657840108025, "articleName": "articleName", "productionOrderId": 3443, "articleId": "articleId", "accuracy": 6217.838928660591, "finished": 229.38787806299766, "time": 1098.225389699997, "status": 8927 }], "startDate": 1765735950731, "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": 6787.705501120747, "orderId": 8190, "endDate": 1765735950731, "prReference": "prReference", "customerOrderId": 9297, "workHours": 4015.7553890360264, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 7313.138169866265, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8393.72060178084, "partAmount": 972.793049810683, "totalReserved": 9911.018020618478 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4831.505858866416, "name": "name", "comment": "comment", "finishDate": 1765735950731, "storeState": 4891, "state": "0", "articles": [{ "waste": "0", "amount": 337.11421797240627, "articleName": "articleName", "productionOrderId": 6868, "articleId": "articleId", "accuracy": 5057.474125042764, "finished": 2370.120838870021, "time": 3131.530339764589, "status": 2486 }], "startDate": 1765735950731, "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": 1149.430623015718, "orderId": 1067, "endDate": 1765735950732, "prReference": "prReference", "customerOrderId": 8400, "workHours": 6200.5504181766155, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1001.066546569539, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7103.6594716472655, "partAmount": 9731.42490061326, "totalReserved": 6018.065728185985 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8449.342830433849, "name": "name", "comment": "comment", "finishDate": 1765735950732, "storeState": 9607, "state": "0", "articles": [{ "waste": "0", "amount": 8854.32723676805, "articleName": "articleName", "productionOrderId": 2080, "articleId": "articleId", "accuracy": 4466.4357743654955, "finished": 8503.670258739681, "time": 9780.146595924867, "status": 247 }], "startDate": 1765735950732, "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": 7762.97855432541, "orderId": 7722, "endDate": 1765735950732, "prReference": "prReference", "customerOrderId": 6854, "workHours": 4417.918871006286, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1758.7966176212278, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5131.410035412794, "partAmount": 6679.706965199107, "totalReserved": 5174.253163677016 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1751.9015957464512, "name": "name", "comment": "comment", "finishDate": 1765735950732, "storeState": 5547, "state": "0", "articles": [{ "waste": "0", "amount": 9367.379708164064, "articleName": "articleName", "productionOrderId": 7607, "articleId": "articleId", "accuracy": 7851.25418471841, "finished": 3296.970170026069, "time": 5110.449118100964, "status": 5244 }], "startDate": 1765735950732, "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 |