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": 4617.7796854604, "orderId": 2339, "endDate": 1766443826229, "prReference": "prReference", "customerOrderId": 4026, "workHours": 4799.711742482621, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8660.421498079626, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2952.3254237817087, "partAmount": 2545.7322120042504, "totalReserved": 3095.441129904366 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3281.787490261875, "name": "name", "comment": "comment", "finishDate": 1766443826229, "storeState": 7085, "state": "0", "articles": [{ "waste": "0", "amount": 7501.588292849243, "articleName": "articleName", "productionOrderId": 8424, "articleId": "articleId", "accuracy": 5662.14115611941, "finished": 9425.567826612472, "time": 7375.797586492866, "status": 1195 }], "startDate": 1766443826229, "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": 7121, "pages": 8955, "pageSize": 6644, "orders": [{ "finishedAmount": 1632.4939930645278, "orderId": 3526, "endDate": 1766443826229, "prReference": "prReference", "customerOrderId": 2111, "workHours": 7186.2830101573745, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3167.011765913017, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2617.108889013845, "partAmount": 8117.079878500376, "totalReserved": 8751.14835807898 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6168.897209594545, "name": "name", "comment": "comment", "finishDate": 1766443826229, "storeState": 4283, "state": "0", "articles": [{ "waste": "0", "amount": 4233.267557145265, "articleName": "articleName", "productionOrderId": 5016, "articleId": "articleId", "accuracy": 2169.986005297797, "finished": 5643.750391647843, "time": 4831.4824442656745, "status": 4084 }], "startDate": 1766443826229, "reserveInDepth": "false" }], "page": 9586 }
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": 3339, "batches": [{ "deliveredAmount": 3792.412330065036, "serialNr": "serialNr", "bestBefore": 7798, "batchId": "batchId", "orderedAmount": 7155.343105556782 }], "articleId": "articleId", "countSerial": 8457 }
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": 4237, "pages": 9105, "pageSize": 2997, "orders": [{ "finishedAmount": 5091.30206673832, "orderId": 2242, "endDate": 1766443826229, "prReference": "prReference", "customerOrderId": 4786, "workHours": 9545.802656969061, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6245.2416633202, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2154.646838990807, "partAmount": 8078.157972725217, "totalReserved": 5145.422069756007 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 5899.284773004795, "name": "name", "comment": "comment", "finishDate": 1766443826229, "storeState": 1066, "state": "0", "articles": [{ "waste": "0", "amount": 4771.927904665192, "articleName": "articleName", "productionOrderId": 2263, "articleId": "articleId", "accuracy": 9437.171385267777, "finished": 2085.3614362932017, "time": 5439.169761322872, "status": 2894 }], "startDate": 1766443826229, "reserveInDepth": "false" }], "page": 7773 }
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": 8717, "pages": 6591, "pageSize": 8600, "orders": [{ "finishedAmount": 7869.09246569275, "orderId": 9268, "endDate": 1766443826229, "prReference": "prReference", "customerOrderId": 8462, "workHours": 9882.095263345405, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1916.3923246822633, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2752.307849554171, "partAmount": 1449.299652901709, "totalReserved": 2217.130054340778 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3494.497932274728, "name": "name", "comment": "comment", "finishDate": 1766443826229, "storeState": 4900, "state": "0", "articles": [{ "waste": "0", "amount": 4651.6744020447595, "articleName": "articleName", "productionOrderId": 2973, "articleId": "articleId", "accuracy": 318.1110739234727, "finished": 4859.046562130839, "time": 5950.537872464639, "status": 2496 }], "startDate": 1766443826229, "reserveInDepth": "false" }], "page": 6736 }
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": 2542.1370064046014, "articleName": "articleName", "supplierId": 8507, "purchasePriceMisc": 6172.760893866711, "articleId": "articleId", "purchasePrice": 4433.5837713679, "partAmount": 8900.289667080793, "stockplace": "stockplace", "unit": "unit", "reserved": 110.9946314973953, "purchasePriceShipment": 6931.597787935557, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 6203.243244612885, "orderId": 4033, "poRef": "poRef", "state": 2517, "deliveryDate": 1766443826230 }] }]}
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": 6082.341412153477, "orderId": 8683, "endDate": 1766443826230, "prReference": "prReference", "customerOrderId": 7873, "workHours": 3937.8804913984777, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3988.4996208711277, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9478.52291645953, "partAmount": 9583.292872663804, "totalReserved": 3815.794379020552 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3552.2538242462565, "name": "name", "comment": "comment", "finishDate": 1766443826230, "storeState": 9689, "state": "0", "articles": [{ "waste": "0", "amount": 4259.79439937007, "articleName": "articleName", "productionOrderId": 1481, "articleId": "articleId", "accuracy": 7079.210530801746, "finished": 860.7671377130499, "time": 8438.94614759705, "status": 8262 }], "startDate": 1766443826230, "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": 4804.117775261356, "orderId": 994, "endDate": 1766443826230, "prReference": "prReference", "customerOrderId": 9599, "workHours": 4667.094084662027, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1127.214404875575, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2502.4406764191485, "partAmount": 2480.5080288524305, "totalReserved": 2944.0763358340982 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6323.276232532287, "name": "name", "comment": "comment", "finishDate": 1766443826230, "storeState": 1732, "state": "0", "articles": [{ "waste": "0", "amount": 5020.723996366463, "articleName": "articleName", "productionOrderId": 9955, "articleId": "articleId", "accuracy": 5026.372097460972, "finished": 3191.7308019827606, "time": 7074.277635923088, "status": 6291 }], "startDate": 1766443826230, "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": 3533.3880076364176, "orderId": 4676, "endDate": 1766443826230, "prReference": "prReference", "customerOrderId": 3108, "workHours": 7466.689195339744, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4641.942941769685, "name": "name", "comment": "comment", "finishDate": 1766443826230, "storeState": 2597, "state": "0", "startDate": 1766443826230, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 2440.112640088444, "orderId": 3266, "endDate": 1766443826230, "prReference": "prReference", "customerOrderId": 2925, "workHours": 4874.798497478146, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5148.666575022308, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9842.72652199589, "partAmount": 6683.666774565874, "totalReserved": 8764.40687684802 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8201.340324170946, "name": "name", "comment": "comment", "finishDate": 1766443826230, "storeState": 4149, "state": "0", "articles": [{ "waste": "0", "amount": 5661.536073586032, "articleName": "articleName", "productionOrderId": 1578, "articleId": "articleId", "accuracy": 3450.1262578296687, "finished": 7455.695060881633, "time": 5270.061246180477, "status": 7250 }], "startDate": 1766443826230, "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": 1260.1215330281102, "articleName": "articleName", "productionOrderId": 936, "articleId": "articleId", "finished": 9362.552100624975, "time": 4011.884485124132, "status": 1770 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 989.866709494478, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 2431.213039878196, "partAmount": 5949.220889647135, "totalReserved": 8540.789412857124 }] }], "articles": [{ "waste": "0", "amount": 5882.608897738435, "articleName": "articleName", "productionOrderId": 9168, "articleId": "articleId", "accuracy": 9402.977264656682, "finished": 4862.136374292419, "time": 5025.150076821003, "status": 9335 }] }
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": 4408.284149567499, "orderId": 6449, "endDate": 1766443826231, "prReference": "prReference", "customerOrderId": 680, "workHours": 3303.9806727280275, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9409.75704873803, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5421.428176266374, "partAmount": 9847.811477966925, "totalReserved": 8441.06023139805 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7971.851936076445, "name": "name", "comment": "comment", "finishDate": 1766443826231, "storeState": 2829, "state": "0", "articles": [{ "waste": "0", "amount": 483.4614717561025, "articleName": "articleName", "productionOrderId": 2115, "articleId": "articleId", "accuracy": 5473.047372183918, "finished": 1681.9897195584977, "time": 7172.840441439945, "status": 5734 }], "startDate": 1766443826231, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 5842.214927548738, "orderId": 2589, "endDate": 1766443826231, "prReference": "prReference", "customerOrderId": 9811, "workHours": 5845.2134514235795, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6243.771542133087, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7541.505420734913, "partAmount": 5725.61300687536, "totalReserved": 8021.643494325707 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1784.9032367184736, "name": "name", "comment": "comment", "finishDate": 1766443826231, "storeState": 6168, "state": "0", "articles": [{ "waste": "0", "amount": 6735.486536391691, "articleName": "articleName", "productionOrderId": 6376, "articleId": "articleId", "accuracy": 4523.903173519833, "finished": 1285.456642300351, "time": 8949.296602221157, "status": 3646 }], "startDate": 1766443826231, "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": 5262.655973433428, "articleName": "articleName", "productionOrderId": 2664, "articleId": "articleId", "accuracy": 6444.006367825945, "finished": 3382.0131106162053, "time": 4493.836443211248, "status": 1147 }
Successfull response:
{ "finishedAmount": 3174.524248610178, "orderId": 3389, "endDate": 1766443826231, "prReference": "prReference", "customerOrderId": 4762, "workHours": 4205.434341900158, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9408.000235763258, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7240.912203860259, "partAmount": 1311.5595318519124, "totalReserved": 3982.530887510637 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 205.80585726935553, "name": "name", "comment": "comment", "finishDate": 1766443826231, "storeState": 5991, "state": "0", "articles": [{ "waste": "0", "amount": 6656.264530237548, "articleName": "articleName", "productionOrderId": 5450, "articleId": "articleId", "accuracy": 5903.777114264957, "finished": 304.355204671688, "time": 1808.4871419798433, "status": 9320 }], "startDate": 1766443826231, "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": 8142.373445120068, "partTraceability": [{ "batches": [{ "amount": 8495.939784311757, "batchId": "batchId" }], "amount": 6506.19751490119, "serial": [{}], "articleId": "articleId" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 4422, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 5771.364198113543, "orderId": 2553, "endDate": 1766443826231, "prReference": "prReference", "customerOrderId": 3531, "workHours": 6331.624355719034, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8334.635670102001, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 392.8096481275012, "partAmount": 6269.258784252974, "totalReserved": 8817.70214089361 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 3276.40624260678, "name": "name", "comment": "comment", "finishDate": 1766443826231, "storeState": 421, "state": "0", "articles": [{ "waste": "0", "amount": 640.4820693452651, "articleName": "articleName", "productionOrderId": 1742, "articleId": "articleId", "accuracy": 8299.698165032176, "finished": 1613.6004550912187, "time": 2277.3291485176737, "status": 8894 }], "startDate": 1766443826231, "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": 7999.5621745049075, "orderId": 4817, "endDate": 1766443826231, "prReference": "prReference", "customerOrderId": 1407, "workHours": 5212.328678523709, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8245.234928869664, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7277.698922463502, "partAmount": 3683.3856226215257, "totalReserved": 728.2158680835349 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4223.272414996949, "name": "name", "comment": "comment", "finishDate": 1766443826231, "storeState": 1981, "state": "0", "articles": [{ "waste": "0", "amount": 8980.376946167877, "articleName": "articleName", "productionOrderId": 3066, "articleId": "articleId", "accuracy": 3915.693412285137, "finished": 2682.123863746564, "time": 7784.523015597568, "status": 5267 }], "startDate": 1766443826231, "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": 9338.807174195332, "orderId": 129, "endDate": 1766443826232, "prReference": "prReference", "customerOrderId": 8675, "workHours": 4349.789875829481, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9593.80017461275, "hasStockValue": false, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6158.142158060205, "partAmount": 4026.079003555285, "totalReserved": 5874.152723611161 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6058.314667193703, "name": "name", "comment": "comment", "finishDate": 1766443826232, "storeState": 502, "state": "0", "articles": [{ "waste": "0", "amount": 4453.709868337781, "articleName": "articleName", "productionOrderId": 2744, "articleId": "articleId", "accuracy": 8924.95708420636, "finished": 3039.81244190752, "time": 2604.472247095205, "status": 4528 }], "startDate": 1766443826232, "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": 6812.503584074731, "orderId": 9120, "endDate": 1766443826232, "prReference": "prReference", "customerOrderId": 4418, "workHours": 6190.003994229183, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5429.25171212273, "hasStockValue": true, "unit": "unit", "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5256.803864113162, "partAmount": 9140.549613069477, "totalReserved": 2291.6056004078578 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1605.190813104863, "name": "name", "comment": "comment", "finishDate": 1766443826232, "storeState": 57, "state": "0", "articles": [{ "waste": "0", "amount": 494.8450224243939, "articleName": "articleName", "productionOrderId": 541, "articleId": "articleId", "accuracy": 452.6774064685357, "finished": 2659.766619426983, "time": 5599.458083830816, "status": 4153 }], "startDate": 1766443826232, "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 |