The order interface is available starting from version 2.2.0 and is used solely for the PTLCart, where it can be used as a stand alone order picking system.
URL | http://<<ip address>>/rest/order/
|
|---|
Method | GET |
|---|
Description | Receive a list of all available orders in the PTLControl. |
|---|
Response | | Code Block |
|---|
| {
«orderid»: {
"orderlines": [
{
"articledescription": «article description»,
"articlebarcode": «article barcode»,
"location": «location»,
"ordered": «amount ordered»,
"picked": «amount picked»
},
...
],
"tote": «order tote»
},
...
} |
Note that «amount picked» can be null if the line has not been processed yet. |
|---|
Possible Error | HTTP404 with no body when no orders found. | Status | | Status |
|---|
colour
| Yellow |
|---|
| title | develop |
|---|
URL | http://<<ip address>>/rest/order/«orderid»
|
|---|
Method | GET |
|---|
Description | Receive the lines in order «orderid». |
|---|
Response | | Code Block |
|---|
| {
"orderlines": [
{
"articledescription": «article description»,
"articlebarcode": «article barcode»,
"location": «location»,
"ordered": «amount ordered»ordersed»,
"picked": «amount picked»
},
...
],
"tote": «order tote»
} |
Note that «amount picked» can be null if the line has not been processed yet. |
|---|
Possible Error | HTTP404 with no body when the order was not found. |
|---|
Status | |
|---|
URL | http://<<ip address>>/rest/order/
|
|---|
Method | DELETE |
|---|
Description | Delete all orders |
|---|
Response | HTTP204 | Status | |
|---|
URL | http://<<ip address>>/rest/order/«orderid»
|
|---|
Method | DELETE |
|---|
Description | Delete order with orderid «orderid» «oderid». There is no reason not to delete an order, i.e. there are no checks on status, progress, lines, etc. Note, when the order did not exist, this call still returns a HTTP204. |
|---|
Response | HTTP204 |
|---|
Status | |
|---|
HTTP204d |
URL | http://<<ip address>>/rest/order/
|
|---|
Method | POST |
|---|
Description | Create a new orders, if an order already exists, it will be overwritten, whatever the status of the order. |
|---|
Request | | Code Block |
|---|
| {
«orderid»: {
"orderlines": [
{
"articledescription": «article description»,
"articlebarcode": «article barcode»,
"location": «location»,
"ordered": «amount ordered»
},
...
],
"tote": «order tote»
},
...
} |
|
|---|
Response | HTTP201 without body if created or updated status |
|---|
| colour | Blue |
|---|
| title | implemented |
|---|
|
Possible Error | HTTP400 if request was invalid (e.g. invalid JSON). A human readable error message can be found in the body. | Status |
|---|
| colour | Blue |
|---|
| title | implemented |
|---|
|
| Status | | Status |
|---|
|
|---|
| colour | Yellow |
|---|
title | develop
URL | http://<<ip address>>/rest/order/«orderid»
|
|---|
Method | PUT |
|---|
Description | Set the tote for this order. |
|---|
Request | | Code Block |
|---|
| {
"tote": «toteid»
} |
«toteid» can be a string
|
|---|
Response | HTTP200 without body if updated |
|---|
Possible Error | HTTP404 if order was not found. |
|---|
