Order: Fetch orders

This endpoint can be used to import all orders. The response can be limited by using the parameter modifiedAtOrAfter to select all orders with a timestamp more or equal the selected timestamp. The order timestamp is changed at any change to the order e.g a changed order status or delivery status.

There is also a possibility to use remoteOrderNo to get all order with a specific order number. Plugboard do not require order number to be unique since the orders could be created from different systems. It is still recommended to use unique order number when it is possible. remoteOrderNo will usually contain the order number that was set by the system that created the order e.g. a e-commerce site.

Another option to fetch order is to use the endpoint /order/query see Query orders

Query parameter

• modifiedAtOrAfter (dateTime)
• remoteOrderNo (string)

Endpoint:

GET /api/order?modifiedAtOrAfter=2020-09-24T17:23:01Z

Example response body:

[
  {
    "href": "/api/order/00061e1066ab0aca7473627d3d488c86",
    "localId": "00061e1066ab0aca7473627d3d488c86",
    "remoteIdMap": {},
    "remoteRefMap": {},
    "created": "2020-09-10T10:56:10Z",
    "lastModified": "2020-09-25T10:24:02Z",
    ".....":"....."
  },
  {
    "href": "/api/order/3fb2568eb7e165e34dd311af5550002b",
    "localId": "3fb2568eb7e165e34dd311af5550002b",
    "remoteIdMap": {},
    "remoteRefMap": {},
    "created": "2020-09-10T10:58:10Z",
    "lastModified": "2020-09-25T10:24:02Z",
    ".....":"....."
  }
]

Order information

The API-documentation contains information that explains the different fields, goto the section "Concepts" -> "Order row". An example of important information is how prices is handled. The field called pricePerUnitExclVat contain the paid price, any discount have already been applied. The discount amount is defined in a separate field. Check the API-documentation and the API-reference for detailed information.

Note

All orders will be returned if modifiedAtOrAfter is excluded