# Pricelist detail

Price list detail with product prices (variants) and info on discounts and limitations of purchase (minimum and maximum price)

Endpoint: GET /api/pricelists/{id}
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Path parameters:

  - `id` (number, required)
    Price list ID
    Example: 1

## Query parameters:

  - `code` (string)
    Product variant code
    Example: "106/BIL"

  - `guid` (string)
    Product GUID
    Example: "94fe7ffc-7481-11e8-8216-002590dad85e"

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.pricelist` (array, required)

  - `data.pricelist.code` (string, required)

  - `data.pricelist.currencyCode` (string, required)
    currency code. List of available currencies within the e-shop can be found in endpoint .

  - `data.pricelist.includingVat` (boolean, required)

  - `data.pricelist.vatRate` (string, required)

  - `data.pricelist.price` (object, required)

  - `data.pricelist.price.price` (string,null, required)
    Price, at which the customer can purchase the product. It can be loaded by the special discounted price and influenced by the price ratio.

  - `data.pricelist.price.commonPrice` (string,null, required)
    standard price, use for information and comparison to competitors.

  - `data.pricelist.price.buyPrice` (string,null, required)
    purchase price.

  - `data.pricelist.price.priceRatio` (string, required)
    price ratio. The price of the product shall be calculated by multiplying the price and this coefficient. The price ratio affects only the price (), the special discounted price () is not affected by the ratio. This ratio has 3 decimal places and can be greater than 1,000

  - `data.pricelist.price.actionPrice` (object,null, required)
    special discounted price.

  - `data.pricelist.price.actionPrice.price` (string, required)
    special discounted price. It is only used if set and if the validity date is set too, form () to ().

  - `data.pricelist.price.actionPrice.fromDate` (string,null, required)
    date from which the special discounted price is valid.

  - `data.pricelist.price.actionPrice.toDate` (string,null, required)
    date to which the special discounted price is valid.

  - `data.pricelist.orderableAmount` (object, required)
    orderable quantity.

  - `data.pricelist.orderableAmount.minimumAmount` (string,null, required)
    minimum orderable quantity.

  - `data.pricelist.orderableAmount.maximumAmount` (string,null, required)
    maximum orderable quantity.

  - `data.pricelist.sales` (object, required)
    definition of discounts.

  - `data.pricelist.sales.minPriceRatio` (string, required)
    3 decimal places accuracy, (from  to ), maximum permitted discount.

  - `data.pricelist.sales.freeShipping` (boolean, required)
    flag, whether the product will have a free transport after it is placed in the cart.

  - `data.pricelist.sales.freeBilling` (boolean, required)
    flag, whether the product will have a free payment after it is placed in the cart.

  - `data.pricelist.sales.loyaltyDiscount` (boolean, required)
    flag, whether the loyalty discount should be used.

  - `data.pricelist.sales.volumeDiscount` (boolean, required)
    flag, whether the volume discount should be used.

  - `data.pricelist.sales.quantityDiscount` (boolean, required)
    flag, whether the volume/multibuy discount should be used.

  - `data.pricelist.sales.discountCoupon` (boolean, required)
    flag, whether a discount coupon can be applied.

  - `data.paginator` (object)

  - `data.paginator.totalCount` (integer, required)
    total number of available records

  - `data.paginator.page` (integer, required)
    current page

  - `data.paginator.pageCount` (integer, required)
    total available of pages

  - `data.paginator.itemsOnPage` (integer, required)
    number of currently returned records

  - `data.paginator.itemsPerPage` (integer, required)
    required number of records per page

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced