Get wines’ data of all wines of a family by its Id.
To be used when you have a family’s id (FAMILYVINCOD) and you want to get wines’ informations of all wines belonging to that family, in the LANGUAGE of your choice.
By default it will only return main attributes in order to save time request.
You can add FILTERS to the request to add informations.
Request
https://api.vincod.com/3/json/wine/GetWinesByFamilyId/<language>/<FAMILYVINCOD>?<FILTERS>&apiKey=<YOURAPIKEY>
Parameters
Format : json or xml
Target : wine
Method : GetWinesByFamilyId
LANGUAGE : fr, en, es, de, jp, cn, ru, … < titles are automatically translated, if producer hasn’t supplied contents translation it will be returned in default language (fr or en is the latest exists)
FAMILYVINCOD : id of the family
FILTERS : GrapesVarieties, Fields, Recipes, Shops, Reviews, Products, Skus < set to 0 or 1 to exclude or include < by default all excluded
Other optional parameters :
includeOrpheline=true < include wines whose winery is marked as orphan (excluded by default)
CurrentVintageOnly=1 < return only the current vintage of each wine
Note — search filters
Unlike GetWinesByOwnerId, this endpoint does not support the filter_json_winery / filter_json_winetype / filter_json_vintageyear / filter_json_appellation query filters. These are only available on GetWinesByOwnerId. If you need to filter a family’s wines by winery, vintage, wine type or appellation, use GetWinesByOwnerId with filter_json and combine it with the family scope on your side, or filter the response client-side.
Warning
Be wise with this request. If the family has a lot of wines, and you don’t use the page parameter, this single response will contain every matching wine at once (no automatic cap) — this can take a long time.
We recommend exploring level by level considering there can only be wines on a winery or range level:
first GetCatalogueByVincod to get catalogue structure
then following the structure GetWinesByRangeId if any or GetWinesByWineryId
Pagination
For families with large catalogs, use the page parameter to paginate results.
https://api.vincod.com/3/json/wine/GetWinesByFamilyId/<language>/<FAMILYVINCOD>?page=<N>&<FILTERS>&apiKey=<YOURAPIKEY>
Without page : returns every matching wine in a single response (no limit)
With page=N : returns 50 wines per page
When using pagination, the response includes :
totalresult — total number of wines available
nbpage — total number of pages
Iterate from page=1 to page={nbpage} to retrieve the full family.
Example — page 1 of a family’s catalog :
https://api.vincod.com/3/json/wine/GetWinesByFamilyId/fr/<FAMILYVINCOD>?page=1&apiKey=<YOURAPIKEY>
Sample default request
https://api.vincod.com/3/json/wine/GetWinesByFamilyId/en/253F71TMQI?apiKey=#
{
"wines": {
"totalresult": "12",
"nbpage": "1",
"wine": [
{
"vincod": "1NFZCE",
"name": "Code M - Médoc",
"name_standard": "Code M, AOC Médoc, Red, 2022",
"ownername": "Producta Vignobles",
"familyname": "Nos Marques",
"wineryname": "Code M",
"rangename": "",
"appellation": "AOC Médoc",
"region": "Bordeaux",
"country": "France",
"winecategory": "Vin Tranquille",
"winetype": "Red",
"winetypecolor": "Rouge",
"vintageyear": "2022",
"picture": "https://cdn.vin.co/_clients_folder/5768PY4G8T/5768py4g8t_code_m___medoc___nm_png_98626_retina.png",
"dateupdate": "1684769946",
"vincodperso": "",
"wineid": "31206",
"ownerid": "5768",
"familyvincod": "253F71TMQI",
"wineryid": "12964",
"wineryvincod": "12964DA04T",
"parentid": "12964DA04T",
"rangevincod": "",
"idfiche": "99389",
"id": "63491"
},
{
"vincod": "6WD10E",
"name": "Flore & Marius - IGP Atlantique Rouge",
"name_standard": "Flore & Marius, IGP Atlantique, Red, 2022",
"ownername": "Producta Vignobles",
"familyname": "Nos Marques",
"wineryname": "Flore & Marius",
"rangename": "",
"appellation": "IGP Atlantique",
"region": "",
"country": "France",
"winecategory": "Vin Tranquille",
"winetype": "Red",
"winetypecolor": "Rouge",
"vintageyear": "2022",
"picture": "https://cdn.vin.co/_clients_folder/5768PY4G8T/5768py4g8t_flore_e_marius___igp_atlantique_rouge___nm_png_98600_retina.png",
"dateupdate": "1687534257",
"vincodperso": "",
"wineid": "31223",
"ownerid": "5768",
"familyvincod": "253F71TMQI",
"wineryid": "12976",
"wineryvincod": "12976DA0GC",
"parentid": "12976DA0GC",
"rangevincod": "",
"idfiche": "99457",
"id": "63510"
}
]
}
}