Order
- Bart Friederichs
The order interface is available starting from version 2.2 and is used solely for the PTLCart, where it can be used as a stand alone order picking system.
URL |
|
|---|---|
Method | GET |
Description | Receive a list of all available orders in the PTLControl. |
Response | {
«orderid»: {
"orderlines": [
{
"articledescription": «article description»,
"articlebarcode": «article barcode»,
"location": «location»,
"ordered": «amount ordered»,
"picked": «amount picked»
},
...
],
"tote": «order tote»
},
...
}Note that |
Possible Error | HTTP404 with no body when no orders found. |
URL |
|
|---|---|
Method | GET |
Description | Receive the lines in order |
Response | {
"orderlines": [
{
"articledescription": «article description»,
"articlebarcode": «article barcode»,
"location": «location»,
"ordered": «amount ordersed»,
"picked": «amount picked»
},
...
],
"tote": «order tote»
}Note that |
Possible Error | HTTP404 with no body when the order was not found. |
URL |
|
|---|---|
Method | DELETE |
Description | Delete all orders |
Response | HTTP204 |
URL |
|
|---|---|
Method | DELETE |
Description | Delete order with orderid |
Response | HTTP204d |
URL |
|
|---|---|
Method | POST |
Description | Create new orders, if an order already exists, it will be overwritten, whatever the status of the order. |
Request | {
«orderid»: {
"orderlines": [
{
"articledescription": «article description»,
"articlebarcode": «article barcode»,
"location": «location»,
"ordered": «amount ordered»
},
...
],
"tote": «order tote»
},
...
} |
Response | HTTP201 without body if created or updated |
Possible Error | HTTP400 if request was invalid (e.g. invalid JSON). A human readable error message can be found in the body. |
URL |
|
|---|---|
Method | PUT |
Description | Set the tote for this order. |
Request |
|
Response | HTTP200 without body if updated |
Possible Error | HTTP404 if order was not found. |