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": 1645.199783895559, "orderId": 8729, "endDate": 1679786642807, "prReference": "prReference", "customerOrderId": 3901, "workHours": 7904.631304775307, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9889.975254694562, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 1179.7010821691933, "partAmount": 6441.970388137464, "totalReserved": 5680.716394107303 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6705.108347626551, "name": "name", "comment": "comment", "finishDate": 1679786642807, "storeState": 2199, "state": "0", "articles": [{ "waste": "0", "amount": 3178.739848232728, "articleName": "articleName", "productionOrderId": 6478, "articleId": "articleId", "accuracy": 6974.258525061131, "finished": 4004.6291708751846, "time": 6902.416193022629, "status": 5748 }], "startDate": 1679786642807, "reserveInDepth": "false" }
Print pickinglist
GETUrl: /{order_id}/pickinglist/print
Headers:
Accept: application/pdf or application/json
Print pickinglist of flat articles for production order
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
filter_non_available | false | ||
article_images | false | ||
order | asc | asc,desc | |
sort_column | art | art,name,supplier,supplier_art |
Production orders
Get batch and serial for a production order
GETUrl: /{order_id}/batch
Headers:
Accept: application/json or application/xml
Get batches and serial numbers for all the articles in a production order
Body:
Successfull response:
{ "countBatch": 9091, "batches": [{ "deliveredAmount": 669.2612651491303, "serialNr": "serialNr", "bestBefore": 9058, "batchId": "batchId", "orderedAmount": 6920.582762360235 }], "articleId": "articleId", "countSerial": 3975 }
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": 2494.359675075204, "orderId": 9040, "endDate": 1679786642814, "prReference": "prReference", "customerOrderId": 3572, "workHours": 4698.91272998788, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 1470.508752106653, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9420.815020826949, "partAmount": 3508.792981313308, "totalReserved": 6226.517106910117 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 172.74370137641438, "name": "name", "comment": "comment", "finishDate": 1679786642814, "storeState": 9554, "state": "0", "articles": [{ "waste": "0", "amount": 8296.966852217218, "articleName": "articleName", "productionOrderId": 7934, "articleId": "articleId", "accuracy": 9029.861337323004, "finished": 8018.209591001333, "time": 4481.738457920333, "status": 359 }], "startDate": 1679786642814, "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": 2622, "pages": 9732, "pageSize": 2018, "orders": [{ "finishedAmount": 4261.073950056189, "orderId": 7016, "endDate": 1679786642814, "prReference": "prReference", "customerOrderId": 8087, "workHours": 8324.237944517983, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 5533.500321669994, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 9372.590515930819, "partAmount": 3409.306119168363, "totalReserved": 5609.308106229787 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1417.00021659687, "name": "name", "comment": "comment", "finishDate": 1679786642814, "storeState": 9402, "state": "0", "articles": [{ "waste": "0", "amount": 8388.304513528827, "articleName": "articleName", "productionOrderId": 2474, "articleId": "articleId", "accuracy": 8535.513649618675, "finished": 1357.8878466173005, "time": 3901.0992093901764, "status": 8263 }], "startDate": 1679786642814, "reserveInDepth": "false" }], "page": 3332 }
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": 1089, "pages": 9835, "pageSize": 4464, "orders": [{ "finishedAmount": 1328.2083110563904, "orderId": 7803, "endDate": 1679786642814, "prReference": "prReference", "customerOrderId": 43, "workHours": 5679.153062721657, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2423.5605349324505, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 483.99201513151803, "partAmount": 9371.114497100829, "totalReserved": 3251.520035488199 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 135.04982233582098, "name": "name", "comment": "comment", "finishDate": 1679786642814, "storeState": 6420, "state": "0", "articles": [{ "waste": "0", "amount": 3955.410282800991, "articleName": "articleName", "productionOrderId": 368, "articleId": "articleId", "accuracy": 5796.2177080962165, "finished": 1549.2852645123955, "time": 1754.6859044020414, "status": 321 }], "startDate": 1679786642814, "reserveInDepth": "false" }], "page": 5510 }
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": 5682, "pages": 7742, "pageSize": 1802, "orders": [{ "finishedAmount": 2071.2978449053467, "orderId": 6244, "endDate": 1679786642815, "prReference": "prReference", "customerOrderId": 785, "workHours": 2193.9000914900444, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3129.1054705066044, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 5820.0424554232295, "partAmount": 4886.783750442542, "totalReserved": 7314.801284632484 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9024.009437732977, "name": "name", "comment": "comment", "finishDate": 1679786642815, "storeState": 2852, "state": "0", "articles": [{ "waste": "0", "amount": 1022.8012179756452, "articleName": "articleName", "productionOrderId": 2852, "articleId": "articleId", "accuracy": 3528.1787858998428, "finished": 6010.317775414522, "time": 8507.891419042473, "status": 1612 }], "startDate": 1679786642815, "reserveInDepth": "false" }], "page": 8923 }
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": 176.0785467237036, "articleName": "articleName", "supplierId": 7510, "purchasePriceMisc": 4801.435705930078, "articleId": "articleId", "purchasePrice": 4358.361873335256, "partAmount": 641.7485323696626, "stockplace": "stockplace", "unit": "unit", "reserved": 1920.527593880218, "purchasePriceShipment": 9020.794726398897, "supplierArticleId": "supplierArticleId", "purchaseOrders": [{ "ordered": 2118.32953320657, "orderId": 2110, "poRef": "poRef", "state": 8971, "deliveryDate": 1679786642815 }] }]}
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": 3465.4041054453355, "orderId": 8773, "endDate": 1679786642816, "prReference": "prReference", "customerOrderId": 3590, "workHours": 7373.123890876749, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2199.6096480854876, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 7573.642853621239, "partAmount": 1170.8372919171306, "totalReserved": 9824.36019670601 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9311.9779450578, "name": "name", "comment": "comment", "finishDate": 1679786642816, "storeState": 7129, "state": "0", "articles": [{ "waste": "0", "amount": 9031.142145846245, "articleName": "articleName", "productionOrderId": 8881, "articleId": "articleId", "accuracy": 6027.605635147171, "finished": 420.2792704871616, "time": 7126.067327938504, "status": 7931 }], "startDate": 1679786642816, "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": 6540.699499152099, "orderId": 5192, "endDate": 1679786642816, "prReference": "prReference", "customerOrderId": 5438, "workHours": 3420.289665004688, "internalReference": "internalReference", "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 9206.706423140795, "name": "name", "comment": "comment", "finishDate": 1679786642816, "storeState": 6749, "state": "0", "startDate": 1679786642816, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 7062.380988778548, "orderId": 4597, "endDate": 1679786642816, "prReference": "prReference", "customerOrderId": 8910, "workHours": 5050.941333394288, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 8345.74226402424, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3854.465833002786, "partAmount": 8859.727026386243, "totalReserved": 4773.484591426492 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1271.970021064993, "name": "name", "comment": "comment", "finishDate": 1679786642816, "storeState": 9572, "state": "0", "articles": [{ "waste": "0", "amount": 75.49659937161168, "articleName": "articleName", "productionOrderId": 9802, "articleId": "articleId", "accuracy": 4939.345095344948, "finished": 2664.2046619067783, "time": 7312.4384979171155, "status": 2246 }], "startDate": 1679786642816, "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": 4763.986183587484, "articleName": "articleName", "productionOrderId": 4406, "articleId": "articleId", "finished": 7561.972638604438, "time": 8921.520244134865, "status": 1012 }
Successfull response:
{ "parts": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 3646.281564098185, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 728.9419886441939, "partAmount": 3791.178415652644, "totalReserved": 6360.777520665553 }] }], "articles": [{ "waste": "0", "amount": 8007.870979289083, "articleName": "articleName", "productionOrderId": 5879, "articleId": "articleId", "accuracy": 647.6927714175552, "finished": 9414.93802572527, "time": 325.2066837911671, "status": 912 }] }
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": 7760.646049515732, "orderId": 104, "endDate": 1679786642817, "prReference": "prReference", "customerOrderId": 5616, "workHours": 7507.981382118818, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 2812.557915606513, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 3487.0519910781695, "partAmount": 2421.115364478633, "totalReserved": 8152.321274280163 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 6180.762767757248, "name": "name", "comment": "comment", "finishDate": 1679786642817, "storeState": 702, "state": "0", "articles": [{ "waste": "0", "amount": 682.117242474406, "articleName": "articleName", "productionOrderId": 5636, "articleId": "articleId", "accuracy": 5902.52847690512, "finished": 1449.4850880943254, "time": 2108.8320467739263, "status": 5294 }], "startDate": 1679786642817, "reserveInDepth": "false" }
Successfull response:
{ "finishedAmount": 4364.760024901948, "orderId": 8943, "endDate": 1679786642817, "prReference": "prReference", "customerOrderId": 1583, "workHours": 9937.32655445709, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6480.266473790416, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8190.068007136746, "partAmount": 9226.55847518148, "totalReserved": 5691.194489624813 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 1538.6062507986342, "name": "name", "comment": "comment", "finishDate": 1679786642817, "storeState": 1745, "state": "0", "articles": [{ "waste": "0", "amount": 6018.728488981998, "articleName": "articleName", "productionOrderId": 6757, "articleId": "articleId", "accuracy": 1858.922172993176, "finished": 1654.8507264796185, "time": 8560.669842795063, "status": 7407 }], "startDate": 1679786642817, "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": 7926.965661973456, "articleName": "articleName", "productionOrderId": 5153, "articleId": "articleId", "accuracy": 3509.036875158836, "finished": 7948.124932204643, "time": 6235.779263142414, "status": 8407 }
Successfull response:
{ "finishedAmount": 2637.859118927951, "orderId": 5306, "endDate": 1679786642817, "prReference": "prReference", "customerOrderId": 1206, "workHours": 927.8785263444888, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6714.411035274917, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 8732.61729764486, "partAmount": 5562.094665547845, "totalReserved": 1775.1388577519733 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 4706.902832408956, "name": "name", "comment": "comment", "finishDate": 1679786642817, "storeState": 5266, "state": "0", "articles": [{ "waste": "0", "amount": 1304.8825392174035, "articleName": "articleName", "productionOrderId": 7228, "articleId": "articleId", "accuracy": 3440.277338332289, "finished": 6285.469828784617, "time": 5674.512977549344, "status": 4164 }], "startDate": 1679786642817, "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": 275.56683076081276, "partTraceability": [{ "amount": 3693.413680241602, "serial": [{}], "articleId": "articleId", "batch": "batch" }], "limitPartAmounts": "false", "serial": "serial", "bestBefore": 2399, "articleId": "articleId", "batch": "batch", "barcode": "barcode" }
Successfull response:
{ "finishedAmount": 5992.370696281688, "orderId": 3948, "endDate": 1679786642817, "prReference": "prReference", "customerOrderId": 4770, "workHours": 2778.8590654883374, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 143.22967759308747, "hasStockValue": true, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 6522.314522023665, "partAmount": 9399.546012500301, "totalReserved": 6907.50358017023 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2660.8207568192265, "name": "name", "comment": "comment", "finishDate": 1679786642817, "storeState": 5869, "state": "0", "articles": [{ "waste": "0", "amount": 7363.120679981088, "articleName": "articleName", "productionOrderId": 9528, "articleId": "articleId", "accuracy": 349.06842335675424, "finished": 4381.084600599165, "time": 7258.450080339628, "status": 9695 }], "startDate": 1679786642817, "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": 3100.8081105198958, "orderId": 557, "endDate": 1679786642817, "prReference": "prReference", "customerOrderId": 9596, "workHours": 1496.36715083055, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 6543.898934534091, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 4778.690783598107, "partAmount": 2354.0607450700168, "totalReserved": 8085.549002944428 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 8920.971895244169, "name": "name", "comment": "comment", "finishDate": 1679786642817, "storeState": 8162, "state": "0", "articles": [{ "waste": "0", "amount": 614.1938885123543, "articleName": "articleName", "productionOrderId": 7109, "articleId": "articleId", "accuracy": 4419.334006923888, "finished": 940.2129338654586, "time": 5401.693883519757, "status": 8671 }], "startDate": 1679786642817, "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": 5822.324558411018, "orderId": 9592, "endDate": 1679786642818, "prReference": "prReference", "customerOrderId": 7653, "workHours": 3933.8816592321423, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 54.23719665482163, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 4178.085864684562, "partAmount": 521.8090601974557, "totalReserved": 3269.038187251122 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 7439.124929089822, "name": "name", "comment": "comment", "finishDate": 1679786642818, "storeState": 2572, "state": "0", "articles": [{ "waste": "0", "amount": 943.1570121875354, "articleName": "articleName", "productionOrderId": 7265, "articleId": "articleId", "accuracy": 3168.4043476669553, "finished": 6346.8812798457375, "time": 7982.792152854704, "status": 9770 }], "startDate": 1679786642818, "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": 8430.884289976359, "orderId": 9220, "endDate": 1679786642818, "prReference": "prReference", "customerOrderId": 5686, "workHours": 289.0622940636556, "internalReference": "internalReference", "singleArticles": [{ "articleId": "articleId", "singleArticles": [{ "totalAmount": 9099.921835307658, "hasStockValue": false, "singleArticleId": "singleArticleId", "singleArticleName": "singleArticleName", "articleId": "articleId", "purchasePrice": 4365.30362348348, "partAmount": 7326.486556775971, "totalReserved": 9603.218303089698 }] }], "customerOrderExternalId": "customerOrderExternalId", "totalAmount": 2183.548943302791, "name": "name", "comment": "comment", "finishDate": 1679786642818, "storeState": 4359, "state": "0", "articles": [{ "waste": "0", "amount": 2399.3944872230445, "articleName": "articleName", "productionOrderId": 216, "articleId": "articleId", "accuracy": 8653.359544432591, "finished": 4335.074565538436, "time": 8141.661788325131, "status": 7405 }], "startDate": 1679786642818, "reserveInDepth": "false" }
Classes:
FlatBundledArticle
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for a single article within the bundled article | R,W | ||||
articleName | String | R,W | |||||
reserved | Double | R,W | |||||
amount | Double | R,W | |||||
partAmount | Double | R,W | |||||
purchasePrice | Double | R,W | |||||
purchasePriceMisc | Double | R,W | |||||
purchasePriceShipment | Double | R,W | |||||
supplierId | Long | R,W | |||||
supplierName | String | R,W | |||||
supplierArticleId | String | R,W | |||||
unit | String | R,W | |||||
stockplace | String | R,W | |||||
purchaseOrders | List | R,W |
FlatBundledArticlePurchaseOrder
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
orderId | Long | R,W | |||||
poRef | String | R,W | |||||
ordered | Double | R,W | |||||
state | int | R,W | |||||
deliveryDate | Date | R,W |
FlatBundledArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R |
PartTraceability
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R,W | |||||
amount | double | R,W | |||||
batch | String | R,W | |||||
serial | List | R,W |
ProductionOrder
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
orderId | Long | When updating a production order (PUT) | R,W | ||||
prReference | String | Unique ProductionOrder-id which the customer can decide themselves | R,W | ||||
customerOrderId | Long | POST | must point to an existing customerOrder | R,W | |||
customerOrderExternalId | String | R,W | |||||
internalReference | String | R,W | |||||
name | String | R,W | |||||
comment | String | R,W | |||||
startDate | Date | R,W | |||||
endDate | Date | R,W | |||||
finishDate | Date | R,W | |||||
workHours | Double | R,W | |||||
state | Integer | Write only with POST | 0 | NEW = 0, DEVELOPING = 1, FINISHED = 2, CANCELLED = 3 |
R,W | ||
reserveInDepth | Boolean | Flag to indicate if reservation should be done on only first layer of bundled articles, or if it should be done on all simple articles in all layers | false | R,W | |||
storeState | Integer | R,W | |||||
totalAmount | Double | R,W | |||||
finishedAmount | Double | R,W | |||||
articles | List | List of ProductionOrderArticles | R | ||||
singleArticles | List | List of ProductionOrderSingleArticles | R |
ProductionOrderArticle
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
productionOrderId | long | R,W | |||||
articleId | String | R,W | |||||
articleName | String | R,W | |||||
time | Double | R,W | |||||
amount | Double | R,W | |||||
finished | Double | R,W | |||||
waste | Double | Total number of produced is finished plus waste | 0 | R,W | |||
status | int | R,W | |||||
accuracy | Double | Percentage on accuracy of the production result. A positive accuracy describes a general overproduction, while a negative accuracy describes waste in production | R |
ProductionOrderArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R | |||||
parts | List | R |
ProductionOrderArticleTraceability
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for bundled article | R,W | ||||
batch | String | Batch for bundled article | R,W | ||||
serial | String | Serial number for bundled article | R,W | ||||
amount | double | Amount to be produced for bundled article | R,W | ||||
bestBefore | Long | Best before for bundled article | R,W | ||||
barcode | String | Barcode for bundled article | R,W | ||||
partTraceability | List | List of traceability for all parts in the bundled article | R,W | ||||
limitPartAmounts | Boolean | Set flag to true if we want to limit part amounts to ordered amount when overproducing | false | R,W |
ProductionOrderBatchResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R | |||||
countBatch | int | R | |||||
countSerial | int | R | |||||
batches | List | R |
ProductionOrderProductBatch
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
batchId | String | R,W | |||||
serialNr | String | R,W | |||||
orderedAmount | Double | R,W | |||||
deliveredAmount | Double | R,W | |||||
bestBefore | Long | R,W |
ProductionOrderRef
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
prReference | String | Next available purchase order reference | R |
ProductionOrderSingleArticleGroup
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | R,W | |||||
singleArticles | List | R,W |
ProductionOrderSingleArticleReserved
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleId | String | Article id for the bundled article | R,W | ||||
singleArticleId | String | Article id for a single article within the bundled article | R,W | ||||
singleArticleName | String | R,W | |||||
totalReserved | Double | R,W | |||||
totalAmount | Double | R,W | |||||
partAmount | Double | R,W | |||||
purchasePrice | Double | R,W | |||||
hasStockValue | Boolean | R,W |
ProductionOrdersResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
page | int | R | |||||
pages | int | R | |||||
pageSize | int | R | |||||
ordersCount | int | R | |||||
orders | List | R |