Introduction
The purpose of this service is to retrieve information stored relating to products.
Request
API GET : https://<pathtoapi>/product
This API needs to be authenticated ( pass header parameter Authorization : "Bearer "+AccessToken )
Input parameters
Parameter (Query Param) | Details | Required | Example |
|---|---|---|---|
response_type | JSON OR XML are permitted, default response is 'JSON'. | Optional | JSON |
product_codes | Comma separated value list of product codes, if not provided then all products will be returned. We strongly advise against regularly calling this API without populating this parameter, it should only be used this way for example during a daily update | Optional | BAROLO,CHABLIS |
Output
Field Name | Type | Length | Unique | Comments |
|---|---|---|---|---|
PUID | AN | 12 | Y | Unique product number |
ProductCode | AN | 20 | Y | Unique Product Code |
EANCase | AN | 18 | EAN Barcode Number - normally numerical only. | |
EANSubCase | AN | 18 | EAN Barcode Number - normally numerical only. | |
ProductDescription | AN | 50 | ||
ProductDescription2 | AN | 50 | This field is no longer being used for documents or any output layouts. | |
Vintage | AN | 4 | Will be either a 4 digit year YYYY or NA or NV | |
SPC | Integer | 6 | Singles per Case | |
SS | Decimal | 8.5 | Single Size in centiliters | |
ABV | Decimal | 3.5 | Stength in % | |
TSinglesAvailable | Int | 12 | The total stock in bottles available to sell. (Available to sell = STOCK - Orders not yet completed (orders held will be included)) | |
TCaseAvailable | Int | 12 | This is the total available singles / Singles per case (rounded down) | |
OptionExclude | Bit | Exclude from Web option | ||
OptionSingles | Bit | Do you sell single bottles of this product | ||
OptionSellZero | Bit | Sell even if no stock (for EP) | ||
OptionRetail | Bit | Is this a Retail Product | ||
AvailableFrom | Date | dd/mm/yy When this product is available from. | ||
Product_CaseDP | Decimal | 8.5 | Product Sales Price Duty Paid for a Case | |
Product_SingleDP | Decimal | 8.5 | Product Sales Price Duty Paid for a Bottle | |
Producer | ||||
Producer_Name | ||||
COO | AN | 6 | ||
COO_Name | ||||
Region | ||||
Region_Name | ||||
Group | ||||
Group_Name | ||||
Style | ||||
Style_Name | ||||
Type | ||||
Type_Name | ||||
ProdAnal6 | ||||
ProdAnal6_Name | ||||
UDF_Prod_Anal1 | ||||
UDF_Prod_Anal1_Name | ||||
UDF_Prod_Anal2 | ||||
UDF_Prod_Anal2_Name | ||||
UDF_Prod_Anal3 | ||||
UDF_Prod_Anal3_Name | ||||
UDF_Prod_Anal4 | ||||
UDF_Prod_Anal4_Name | ||||
UDF_Prod_Anal5 | ||||
UDF_Prod_Anal5_Name | ||||
UDF_Prod_Anal6 | ||||
UDF_Prod_Anal6_Name | ||||
DutyPerSingle | Decimal | 8.5 | The duty amount per single bottle. | |
Weight | Decimal | 8.5 | GrossWeight per case | |
Product_CaseUB | Decimal | 8.5 | Product Sales Price Under Bond for a Case | |
Product_SingleUB | Decimal | 8.5 | Product Sales Price Under Bond for a Bottle |
JSON Response sample
[
{
"PUID": 30116,
"ProductCode": "BAROLO",
"EANCase": "1010256325632",
"EANSubCase": "1010245874523",
"ProductDescription": "Barolo",
"ProductDescription2": null,
"Vintage": "2015",
"SPC": 12,
"SS": 75.00000,
"ABV": 13.00000,
"TSinglesAvailable": 959308.0,
"TCaseAvailable": 79942.0,
"OptionExclude": false,
"OptionSingles": "FALSE",
"OptionSellZero": false,
"OptionRetail": true,
"AvailableFrom": "16/11/2017",
"Product_CaseDP": 101.96000,
"Product_SingleDP": 8.49667,
"Producer": "FRA",
"Producer_Name": "Fratelli Giacosa",
"COO": "IT",
"COO_Name": "Italy",
"Region": "BDX",
"Region_Name": "Bordeaux",
"Group": "DRINKS",
"Group_Name": "Drinks",
"Style": "WI",
"Style_Name": "Wine",
"Type": "V",
"Type_Name": "Wine",
"ProdAnal6": null,
"ProdAnal6_Name": null,
"UDF_Prod_Anal1": "BEE",
"UDF_Prod_Anal1_Name": "Beef",
"UDF_Prod_Anal2": null,
"UDF_Prod_Anal2_Name": null,
"UDF_Prod_Anal3": null,
"UDF_Prod_Anal3_Name": null,
"UDF_Prod_Anal4": null,
"UDF_Prod_Anal4_Name": null,
"UDF_Prod_Anal5": null,
"UDF_Prod_Anal5_Name": null,
"UDF_Prod_Anal6": null,
"UDF_Prod_Anal6_Name": null,
"DutyPerSingle": 2.16488,
"Weight": 16.20000,
"Product_CaseUB": 75.98150,
"Product_SingleUB": 6.33179
}
]
XML Response sample
<Products>
<Product>
<PUID>30116</PUID>
<ProductCode>BAROLO</ProductCode>
<EANCase>1010256325632</EANCase>
<EANSubCase>1010245874523</EANSubCase>
<ProductDescription>Barolo</ProductDescription>
<Vintage>2015</Vintage>
<SPC>12</SPC>
<SS>75.00000</SS>
<ABV>13.00000</ABV>
<TSinglesAvailable>959272</TSinglesAvailable>
<TCaseAvailable>79939</TCaseAvailable>
<OptionExclude>false</OptionExclude>
<OptionSingles>FALSE</OptionSingles>
<OptionSellZero>false</OptionSellZero>
<OptionRetail>true</OptionRetail>
<AvailableFrom>16/11/2017</AvailableFrom>
<Product_CaseDP>101.96000</Product_CaseDP>
<Product_SingleDP>8.49667</Product_SingleDP>
<Producer>FRA</Producer>
<Producer_Name>Fratelli Giacosa</Producer_Name>
<COO>IT</COO>
<COO_Name>Italy</COO_Name>
<Region>BDX</Region>
<Region_Name>Bordeaux</Region_Name>
<Group>DRINKS</Group>
<Group_Name>Drinks</Group_Name>
<Style>WI</Style>
<Style_Name>Wine</Style_Name>
<Type>V</Type>
<Type_Name>Wine</Type_Name>
<UDF_Prod_Anal1>BEE</UDF_Prod_Anal1>
<UDF_Prod_Anal1_Name>Beef</UDF_Prod_Anal1_Name>
<DutyPerSingle>2.16488</DutyPerSingle>
<Weight>16.20000</Weight>
<Product_CaseUB>75.98150</Product_CaseUB>
<Product_SingleUB>6.33179</Product_SingleUB>
</Product>
<Product>
<PUID>30117</PUID>
<ProductCode>CHABLIS</ProductCode>
<EANCase>2020214569874</EANCase>
<EANSubCase>2020145236589</EANSubCase>
<ProductDescription>Chablis Clos</ProductDescription>
<ProductDescription2>[Foreign Character Store e.g. Chinese]</ProductDescription2>
<Vintage>2015</Vintage>
<SPC>12</SPC>
<SS>74.00000</SS>
<ABV>13.50000</ABV>
<TSinglesAvailable>-69060</TSinglesAvailable>
<TCaseAvailable>-5755</TCaseAvailable>
<OptionExclude>false</OptionExclude>
<OptionSingles>FALSE</OptionSingles>
<OptionSellZero>false</OptionSellZero>
<OptionRetail>false</OptionRetail>
<AvailableFrom>16/11/2017</AvailableFrom>
<Product_CaseDP>0.00000</Product_CaseDP>
<Product_SingleDP>0.00000</Product_SingleDP>
<Producer>DOM</Producer>
<Producer_Name>Domaine William Fevre</Producer_Name>
<COO>FR</COO>
<COO_Name>France</COO_Name>
<Region>CHAB</Region>
<Region_Name>Chablis</Region_Name>
<Group>DRINKS</Group>
<Group_Name>Drinks</Group_Name>
<Style>WI</Style>
<Style_Name>Wine</Style_Name>
<Type>V</Type>
<Type_Name>Wine</Type_Name>
<UDF_Prod_Anal1>CHI</UDF_Prod_Anal1>
<UDF_Prod_Anal1_Name>Chicken</UDF_Prod_Anal1_Name>
<DutyPerSingle>2.13601</DutyPerSingle>
<Weight>16.20000</Weight>
<Product_CaseUB>0.00000</Product_CaseUB>
<Product_SingleUB>0.00000</Product_SingleUB>
</Product>
</Products>
|