FoodMaster API Documentation

Special Prices

This endpoint returns the special settings for prices defined in FoodMaster. There are a few different types of special prices, they are defined by a code.

Each code has a different meaning.

xxxxxxxxxx
Possible codes:
    - 10: Price code
    - 20: Net price
    - 30: Discount
    - 40: Quantum           /* Onyly then will ttQuantumPrices be available */
    - 50: Promotion
    - 60: Pick-up discount
​
Types of discounts:
    - 0: New price (only for code 40:  `ttQuantumPrices`)
    - 1: Percent
    - 2: Amount / piece
    - 3: Amount / kg
    - 4: Fixed amount

Explanation code 10

Price code

A different price code should be used. The normal price code, assigned for this customer to this article, is not applicable. The given price code, assigned in field waarde should be used.

For example: A customer that normally had price code 1 assigned. Can now buy this article for the price assigned in price code 2.

Explanation code 20

Net price

The value in this code simply overwrites the value of the article. The value of the field waarde just becomes the price for the article for the given customer.

Explanation code 30

Discount

The value of the discount depends on the type of discount.

In case the value is 5, the discount will be:

• Type 1: 5% discount
• Type 2: € 5 / unit discount
• Type 3: € 5 / kg discount

Explanation code 40

Quantum

The quantum discount depends on the amount you buy. The type of the ttSpecialPrices does not matter. The type is defined in de sub node `ttQuantumPrices, which will only be available when the Special Price code is 40.

Some examples:

• tp_korting: 0, korting: 2.5, van_hoev: 20:

  • From 20 units, the product costs € 2.5 / unit

• tp_korting: 1, korting: 5, van_hoev: 10 :

  • From 10 units, you get 5% discount

• tp_korting: 2, korting: 2, van_hoev: 5:

  • From 5 units, you get € 2 / unit discount

Explanation code 50

Promotion

You get an extra item when buying an item x times.

Example 1:

• artikelnr: Product id of an apple

• promo_artikel: Product id of an egg

• promo_besth: 5

• promo_extra: 2

• promo_prijs: 0

• minimum_besth: 20

  => In this case the customer will receive 2 eggs for each 5 apples he buys once he buys 20 apples.

  The eggs are free because the price is 0.

Example 2:

• artikelnr: Product id of an apple

• promo_artikel: Product id of an apple (same as above)

• promo_besth: 5

• promo_extra: 1

• promo_prijs: 0.5

• minimum_besth: 5

  => In this case the customer will get an extra apple for only € 0.5 for each 5 apples he buys once he buys.

  So the customer receives a 6th apple for only 50 cents for each 5 apples he buys. Or a discount for each 6th apple that is bought.

  Because the minimum amount is 5, the promo will already be valid from the first 5 apples.

If the promo_... are not filled, code 50 works the same as code 30. Most of the time code 50 special prices will be a temporary offer and code 30 are for longer time.

Another difference between code 30 and code 50 is that tp_korting and ln_korting (1 and 2) will not get filled when using the prices endpoint for codes 30 . For code 50 they will get filled. Code 30 will already be included in the waarde field. Code 50 is included in the netto field.

Explanation code 60

Pick-up discount

Code 60 works the same as code 30, but it is only applicable if the customer picks the order up himself / when there is no delivery.

Action

Read all via pagination

GET /SpecialPrices

Read all via code

GET /SpecialPrices/bycode

Read incremental

GET /SpecialPrices/incremental

Count

GET /SpecialPrices/count

Input

Read all via pagination

dossiernr = company within FoodMaster pag = page number lim = page size

Read all via code

dossiernr = company within FoodMaster code = code of the special price

Read incremental

dossiernr = company within FoodMaster since = changes since 1900-01-01T00:00:00 for ‘since last call’

Count

dossiernr = company within FoodMaster

Output

See following example:

xxxxxxxxxx
{
  "dsSpecialPrices": {
    "ttSpecialPrices": [
      {
        "id_fprijskl": 10, // customer price id (not important)
        "code": 40, // price code
        "klant-nr": 0, // customer id
        "klgroep": "GRP1", // customer group
        "artikelsrt": 0, // article kind
        "artikelnr": "4587AFG", // article id
        "cd_artgrp": "", // article group code
        "lever-nr": 0, // supplier id
        "waarde": 0.0, // value
        "tp_korting": 0, // discount type
        "van_datum": "20010-01-01", // begin date
        "tot_datum": "2050-12-31", // end date
        "blok_cumul": false, // block adding-up promo's / discount >> use only this record if true
        "promo_artikel": "", // promotion article
        "promo_comment": "", // promotion comment
        "promo_besth": 1.0, // promotion order unit
        "promo_extra": 0.0, // promotion extra
        "promo_prijs": 0.0, // promotion price
        "omschr_nl": "", // Dutch description
        "omschr_fr": "", // French description
        "omschr_en": "", // English description
        "omschr_de": "", //  German description
        "minimum_besth": 1.0, // minimum that needs to be ordered for promotion
        "rec-id": 8192514, // record id
        "ttQuantumPrices": [
          {
            "van_hoev": 4.0, // minimum that needs to be ordered for discount
            "korting": 0.73, // discount 
            "tp_korting": 0 // discount type
          },
          ...
        ]
      }
    ]
  }
}