FoodMaster API Documentation

Order Analysis

Getting transport cost info about a possible order before actually placing it.

Action

Read all

GET /orderAnalysis

?dossiernr=1&klant-nr=4&datum_lev=2021-03-10&lev_adres=001&net_waarde_best=220.25

Input

Read all

dossiernr = company within FoodMaster klant-nr = customer id datum_lev = delivery date lev_adres = delivery address code net_waarde_best = net value order

Output

Returns transport cost info about a possible order. The transportkost value determines how much the customer has to pay extra for transport.

The other parts are extra info if wanted. tot_waarde_lev is a cumulation of the current fictional / possible order + all open orders in the system for this customer, delivery date and delivery address. It is this value that is used to determine the costs.

See following example:

{
  "dsOrderAnalysis": {
    "ttOrderAnalyse": [
      {
        "dossiernr": 1, // company within FoodMaster
        "klant-nr": 4, // customer id
        "datum_lev": "01-01-2000", // delivery date
        "lev_adres": "001", // delivery address code
        "net_waarde_best": 10.05,  // net order value (of fictional / possible order)
        "tot_waarde_lev": 15.67, // total delivery value ("net_waarde_best" + values of already received orders)
        "transportkost": 10.0, // calculated tansport cost 
        "te_kort": 24.28, // total delivery value extra needed to remove transport cost completely
        "min-order-amount": 20.00 // minimum amount to order
        "order-ok-to-push": FALSE // minimum order amount has been reached 
        "crud": "R", // crud action code
        "ttTransportKost": [
          {
            "id_kostd": 22, // cost detail id
            "tot_hoev": 50.0, // total delivery value needed for this cost-level
            "tarrief": 10.0, // cost value
            "te_kort": 24.28, // total delivery value extra needed to pass this cost-level
            "commentaar": "" // cost memo
          },
          {
            "id_kostd": 22, // cost detail id
            "tot_hoev": 100.0, // total delivery value needed for this cost-level
            "tarrief": 5.0, // cost value
            "te_kort": 74.28, // total delivery value extra needed to pass this cost-level
            "commentaar": "Transport bestelling <100€" // cost memo
          },
          ...
        ]
      }
    ]
  }
}