Versions Compared

Old Version 3

changes.mady.by.user Alan Gilchrist

Saved on

compared with

New Version Current

changes.mady.by.user Harish Kushwah

Saved on

Key

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

Introduction

The purpose of this service is to get price list from vision database.

Price List

There is also a web price list extract. If you want to add the product but you also want to have different pricing for different customers, then the web price list is an output of all prices for all products, we then provide the following fields

...

Request

API GET :  https://<pathtoapi>/PriceList

This API needs to be authenticated  ( pass header parameter  Authorization : "Bearer "+AccessToken )

Input parameters

Parameter
(Query Param)

Details

Required

Example

response_type

Can supply with JSON OR XML, Default response is JSON

Optional

 XML

price_list_id

PKPriceList

Optional

2018

product_codes

comma separated values to retrieve multiple producers

Optional

BAROLO,CHABLIS

Response

Name

Type

Length

Notes

PKPriceList

Int

16

WebPriceGroupCode

AN

6

PriceGroupName

AN

30

IsLive

Bit

Will remain but will only contain lines which ARE live

IsEP

Bit


Is this an EnPrimeur Price list

IsPromo

Bit



StartDate

DateTime

EndDate

DateTime

Notes

AN

60

Any notes for this price list

PriceIncVAT

Bit

ProductCode

AN

20

Unique Product Code

QuantityFrom

Int

QuantityTo

Int

CasePrice

decimal

8.3

Duty Paid Price per case

SinglePrice

decimal

8.3

Duty Paid price per single

CasePriceUB

decimal

8.3

New feature coming soon

SinglePriceUB

decimal

8.3

New feature coming soon.

JSON Response sample

Code Block
languagejson
[
  {
    "PKPriceList": 2018,
    "WebPriceGroupCode": "A",
    "PriceGroupName": "TRADE",
    "IsLive": true,
    "IsEP": false,
    "IsPromo": false,
    "StartDate": "2018-04-16T13:50:59",
    "EndDate": "2018-08-25T00:00:00",
    "Notes": "",
    "PriceIncVAT": false,
    "ProductCode": "BAROLO",
    "QuantityFrom": 0,
    "QuantityTo": 1000,
    "CasePrice": 200.00000,
    "SinglePrice": 16.66667,
    "UBCasePrice": 174.02000,
    "UBSinglePrice": 14.50167
  },
  {
    "PKPriceList": 2018,
    "WebPriceGroupCode": "A",
    "PriceGroupName": "TRADE",
    "IsLive": true,
    "IsEP": false,
    "IsPromo": false,
    "StartDate": "2018-04-16T13:50:59",
    "EndDate": "2018-08-25T00:00:00",
    "Notes": "",
    "PriceIncVAT": false,
    "ProductCode": "BLINDT",
    "QuantityFrom": 0,
    "QuantityTo": 1000,
    "CasePrice": 240.00000,
    "SinglePrice": 40.00000,
    "UBCasePrice": 191.72000,
    "UBSinglePrice": 31.95333
  }
]

XML Response sample

Code Block
languagexml
<Pricelists>
    <Pricelist>
        <PKPriceList>2018</PKPriceList>
        <WebPriceGroupCode>A</WebPriceGroupCode>
        <PriceGroupName>TRADE</PriceGroupName>
        <IsLive>true</IsLive>
        <IsEP>false</IsEP>
        <IsPromo>false</IsPromo>
        <StartDate>2018-04-16T13:50:59+01:00</StartDate>
        <EndDate>2018-08-25T00:00:00+01:00</EndDate>
        <Notes></Notes>
        <PriceIncVAT>false</PriceIncVAT>
        <ProductCode>BAROLO</ProductCode>
        <QuantityFrom>0</QuantityFrom>
        <QuantityTo>1000</QuantityTo>
        <CasePrice>200.00000</CasePrice>
        <SinglePrice>16.66667</SinglePrice>
        <UBCasePrice>174.02000</UBCasePrice>
        <UBSinglePrice>14.50167</UBSinglePrice>
    </Pricelist>
    <Pricelist>
        <PKPriceList>2018</PKPriceList>
        <WebPriceGroupCode>A</WebPriceGroupCode>
        <PriceGroupName>TRADE</PriceGroupName>
        <IsLive>true</IsLive>
        <IsEP>false</IsEP>
        <IsPromo>false</IsPromo>
        <StartDate>2018-04-16T13:50:59+01:00</StartDate>
        <EndDate>2018-08-25T00:00:00+01:00</EndDate>
        <Notes></Notes>
        <PriceIncVAT>false</PriceIncVAT>
        <ProductCode>BLINDT</ProductCode>
        <QuantityFrom>0</QuantityFrom>
        <QuantityTo>1000</QuantityTo>
        <CasePrice>240.00000</CasePrice>
        <SinglePrice>40.00000</SinglePrice>
        <UBCasePrice>191.72000</UBCasePrice>
        <UBSinglePrice>31.95333</UBSinglePrice>
    </Pricelist>
</Pricelists>