Versions Compared

Version Old Version 2 New Version Current
Changes made by

Bart Friederichs

Bart Friederichs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

http://<<ip address>>/rest/order/

Method

GET

Description

Receive a list of all available orders in the PTLControl.

Response

Code Block
languagejson
{
   «orderid»: {
      "orderlines": [
          { 
            "articlearticledescription": «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
colourPurple
titleDesign

Design

URL

http://<<ip address>>/rest/order/«orderid»

Method

GET

Description

Receive the lines in order «orderid».

Response

Code Block
languagejson
{
      "orderlines": [
          { 
            "articlearticledescription": «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

Status
colourPurple
title
Status

URL

http://<<ip address>>/rest/order/

Method

DELETE

Description

Delete all orders

Response

HTTP204

Status
colourPurple
titleDesign

DesignNote, when the order did not exist, this call still returns a HTTP204.

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.

Response

HTTP204

Possble Error

HTTP404 with no body if order not found

Status

Status
colourPurple
title

Response

HTTP204d

Design

URL

http://<<ip address>>/rest/order/

Method

POST

Description

Create a new order. The Content-Type request header defines the data type that is being sent:

  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for Excel files

    • … ?

    new orders, if an order already exists, it will be overwritten, whatever the status of the order.

    Request

    Code Block
    languagejson
    {
   «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.

    HTTP503 if order exists, but has picked lines

    Status

    Status
    colourPurple
    title

    URL

    http://<<ip address>>/rest/order/«orderid»

    Method

    PUT

    Description

    Set the tote for this order.

    Request

    Code Block
    languagejson
    {
   "tote": «toteid»
}

    «toteid» can be a string

    Response

    HTTP200 without body if updated

    Possible Error

    HTTP404 if order was not found.