Getting Started
Constellation Brands APIs provide instant access to a variety of datasets including Items, Brands, and Worker Demographics. Explore the available APIs to see setup instructions and sample responses.
Accessing Our APIs
Most Constellation Brands APIs require an API key. Some APIs containing sensitive data will require additional authentication, as outlined in the documentation below. You will receive an API key and additional instructions via email once approved.
How to Register and Authenticate
Example API request in cURL using only an API key:
curl "https://mocksvc.mulesoft.com/mocks/60329a89-e440-4f72-90cb-b6b0564f949e/api/1.0/1002?apiKey=YourAPIKey"
The above command returns the following JSON:
{
"beverageSegmentCode": "100",
"beverageSegmentDescription": "WINE",
"brandCode": "343",
"gtin": "620654020010",
"id": "1002",
"itemCode": "100",
"itemDescription": "INNA EST RIES VQA 750/12",
"subBrandCode": "2391",
"typeCode": "102",
"universalSKUCode": "23011",
"universalSKUDescription": "INNISKILLIN NIAGARA EST COL RIESLING 750ML",
"upc": "062065402001",
"varietalBlendCode": "632",
"vintageDescription": "N/A"
}
- Request an API key by providing information about your application
- The Constellation Brands API team will review your request and respond via email with credentials to access the API
- Make an API request with the following query parameter (if required) to authenticate your call:
| Query Parameter Name | Description | Example |
|---|---|---|
| apiKey | ID provided by CBI upon registration | 4eb335ddb09f56260ec913551b2496ac |
Bottle Shots API
https://api.cbrands.com/api/1.0/bottleShots
This API returns promotional digital assets (“bottle shots”, “tasting notes”, etc) from the Constellation Brands Global Brand Center. It includes some identifying information about the product as well as a variety of image formats:
- Mini image (PNG)
- Standard final JPEG (JPG)
- Web image (full-size PNG)
The API can return a specific product (based on GTIN) or all product images modified since a specific date.
Authentication
The Bottle Shots API requires only an API key for authentication. Submit a request for a key and use it as shown in the requests below.
Result Details
The following attributes are returned by the Bottle Shots API:
| Attribute Name | Description | Type |
|---|---|---|
| id | 35-digit item ID from Global Brand Center | string |
| name | Product name from Global Brand Center | string |
| dateCreated | Date and time this bottle shot was added to Global Brand Center | string |
| datePublished | Lorem ipsum dolor sit amet, cu eos sumo graecis deserunt | string |
| dateModified | Date and time this bottle shot was last modified | string |
| extension | File extension of the original image | string |
| upc | Full UPC (barcode) value for the product | string |
| brandFamily | Brand family description for the product | string |
| brand | Brand name description for the product | string |
| varietal | Numeric varietal code | string |
| vintage | Vintage year, if specified in Global Brand Center | string |
| itemSize | Product volume in mL, unless otherwise noted | string |
| webImage | URL for the full-size PNG bottle shot | string |
| miniImage | URL for the PNG thumbnail image | string |
| standardFinalJpeg | URL for the full-size JPG bottle shot | string |
| thul | Lorem ipsum dolor sit amet, cu eos sumo graecis deserunt | string |
| transparentPNG | URL for the full-size PNG bottle shot | string |
Result Headers
The response also includes the following header information:
| Variable | Description | Type |
|---|---|---|
| X-CBI-NumberOfRecords | The number of records requested - default 50 if not specified | integer |
| X-CBI-Page | Offset page for results, Nth set of results - default 1 if not specified | integer |
Get All Bottle Shots
https://api.cbrands.com/api/1.0/bottleShots will return the following JSON:
[
{
"brand": "Chateau Smith",
"brandFamily": "Charles Smith",
"dateCreated": "2017-01-05T21:10:18Z",
"dateModified": "2017-01-06T16:24:26Z",
"datePublished": "2016-12-16T18:12:09Z",
"extension": "psd",
"id": "9135BEC3-CF40-4819-B7C9C16DD7E92BF1",
"itemSize": "750",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/final/5be7df2b-2a56-417f-84fe-dec1227f9116/mini-0AA4663D-852F-4DA2-97877C3DF1AD6BA7.png",
"name": "2014 CHS Cabernet Sauvignon 750ml Bottle Shot",
"standardFinalJpeg": "https://d3cy9zhslanhfa.cloudfront.net/media/final/5be7df2b-2a56-417f-84fe-dec1227f9116/Standard Final JPG-CHS_Bottle_Shot.jpg",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/final/5be7df2b-2a56-417f-84fe-dec1227f9116/thul-7ECA50DA-3BF8-4872-9BC1D6B268CFD9F2.png",
"upc": "184745000126",
"varietal": "Cabernet Sauvignon",
"vintage": "2014",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/final/5be7df2b-2a56-417f-84fe-dec1227f9116/webimage-4D27936B-F803-4DC7-80DB39A24800A652.png"
}
{
"brand": "Chateau Smith",
"brandFamily": "Charles Smith",
"dateCreated": "2017-01-05T21:10:18Z",
"dateModified": "2017-01-06T16:24:26Z",
"datePublished": "2016-12-16T18:12:09Z",
"extension": "psd",
"id": "9135BEC3-CF40-4819-B7C9C16DD7E92BF1",
"itemSize": "750",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/final/5be7df2b-2a56-417f-84fe-dec1227f9116/mini-0AA4663D-852F-4DA2-97877C3DF1AD6BA7.png",
"name": "2014 CHS Cabernet Sauvignon 750ml Bottle Shot",
"standardFinalJpeg": "https://d3cy9zhslanhfa.cloudfront.net/media/final/5be7df2b-2a56-417f-84fe-dec1227f9116/Standard Final JPG-CHS_Bottle_Shot.jpg",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/final/5be7df2b-2a56-417f-84fe-dec1227f9116/thul-7ECA50DA-3BF8-4872-9BC1D6B268CFD9F2.png",
"upc": "184745000126",
"varietal": "Cabernet Sauvignon",
"vintage": "2014",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/final/5be7df2b-2a56-417f-84fe-dec1227f9116/webimage-4D27936B-F803-4DC7-80DB39A24800A652.png"
}
]
Retrieves all bottle shots that have been modified since the specified date.
HTTP Request
https://api.cbrands.com/api/1.0/bottleShots
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
| dateModified | Retrieve bottle shots modified after this date. ISO8601 format: yyyy-mm-ddThh:mm:ssZ. Example: 2016-12-25T10:30:00Z | string |
| numberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Header Variables
Header variables are optional and can be used instead of query parameters. Header variables will override query parameters if both are used.
| Variable | Description | Type |
|---|---|---|
| X-CBI-NumberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| X-CBI-Page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Get a Specific Bottle Shot
https://api.cbrands.com/api/1.0/bottleShots/184745000126 will return the following JSON:
{
"brand": "Kim Crawford",
"brandFamily": "Kim Crawford",
"dateCreated": "2017-02-16T20:29:25Z",
"dateModified": "2017-02-16T20:29:53Z",
"datePublished": "2013-04-23T18:20:43Z",
"extension": "psd",
"id": "EF550946-3A61-4B36-B238B6F6C36D7EB8",
"itemSize": "750",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/final/b9e2caeb-0bb0-446c-a32e-70c4904e8206/mini-C94F8787-B4BB-4899-95B2C5F56D22F85E.png",
"name": "2016 KIM Rosé 750ml Bottle Shot - New Package",
"standardFinalJpeg": "https://d3cy9zhslanhfa.cloudfront.net/media/final/b9e2caeb-0bb0-446c-a32e-70c4904e8206/Standard Final JPG-KIM_Rose_750ml_2016_CBI_30333.jpg",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/final/b9e2caeb-0bb0-446c-a32e-70c4904e8206/thul-FA4E2B9F-DC56-4C0D-99442DC51BE1D0C5.png",
"upc": "",
"varietal": "Rose",
"vintage": "2016",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/final/b9e2caeb-0bb0-446c-a32e-70c4904e8206/webimage-B92EABA4-EB8B-4F73-A22664CE2D9D03C1.png"
}
This endpoint retrieves a specific bottle shot based on the product’s GTIN.
HTTP Request
https://api.cbrands.com/api/1.0/bottleShots/{gtin}
URI Parameters
| Parameter | Decription | Type |
|---|---|---|
| gtin | The GTIN of the product to retrieve | string |
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
| numberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Header Variables
Header variables are optional and can be used instead of query parameters. Header variables will override query parameters if both are used.
| Variable | Description | Type |
|---|---|---|
| X-CBI-NumberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| X-CBI-Page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Get All Tasting Notes
https://api.cbrands.com/api/1.0/tastingNotes will return the following JSON:
[
{
"brand": "Ruffino",
"brandFamily": null,
"dateCreated": "2018-04-02T22:44:33Z",
"dateModified": "2018-04-02T22:44:33Z",
"datePublished": "2018-04-02T17:08:10Z",
"extension": "pdf",
"id": "0BCBCCCB-A231-4E85-81AAB1915E99C880",
"itemSize": "",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/0BCBCCCB-A231-4E85-81AAB1915E99C880/mini-401AEAAA-FFB9-4C5C-AF8B63B531BAC5A5.jpg",
"name": "2015 RUF Alauda Toscana NSRP Tasting Note",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/0BCBCCCB-A231-4E85-81AAB1915E99C880/thul-A4C23CB6-6AA9-4F6B-A71CC1E00E0C2903.jpg",
"upc": "",
"varietal": null,
"vintage": "2015",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/0BCBCCCB-A231-4E85-81AAB1915E99C880/webimage-07B95B8A-2C8D-4B19-A219F3C3EC0AD223.jpg"
}
]
Retrieves all tasting notes that have been modified since the specified date.
HTTP Request
https://api.cbrands.com/api/1.0/tastingNotes
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
| dateModified | Retrieve bottle shots modified after this date. ISO8601 format: yyyy-mm-ddThh:mm:ssZ. Example: 2016-12-25T10:30:00Z | string |
| numberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Header Variables
Header variables are optional and can be used instead of query parameters. Header variables will override query parameters if both are used.
| Variable | Description | Type |
|---|---|---|
| X-CBI-NumberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| X-CBI-Page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Get All Hot Sheets
https://api.cbrands.com/api/1.0/hotSheets will return the following JSON:
[
{
"brand": "SIMI",
"brandFamily": null,
"dateCreated": "2018-03-30T12:02:59Z",
"dateModified": "2018-03-30T12:02:59Z",
"datePublished": "2018-03-29T13:24:10Z",
"extension": "pdf",
"id": "9124619A-4610-489A-B34ACC039932A525",
"itemSize": "750",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/9124619A-4610-489A-B34ACC039932A525/mini-B729B00F-DE7B-42D6-BA52C84221D65DE0.jpg",
"name": "2014 SIMI Landslide Cabernet Sauvignon Hot Sheet Decanter Magazine 90 Points Highly Recommended Award",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/9124619A-4610-489A-B34ACC039932A525/thul-D46AB21D-4982-4DE9-A84BC2CE549E2B3E.jpg",
"upc": "",
"varietal": "Cabernet Sauvignon",
"vintage": "2014",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/9124619A-4610-489A-B34ACC039932A525/webimage-17EB3220-D30B-43B0-B296DA44E2C3AF79.jpg"
}
]
Retrieves all Hot Sheets that have been modified since the specified date.
HTTP Request
https://api.cbrands.com/api/1.0/hotSheets
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
| dateModified | Retrieve bottle shots modified after this date. ISO8601 format: yyyy-mm-ddThh:mm:ssZ. Example: 2016-12-25T10:30:00Z | string |
| numberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Header Variables
Header variables are optional and can be used instead of query parameters. Header variables will override query parameters if both are used.
| Variable | Description | Type |
|---|---|---|
| X-CBI-NumberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| X-CBI-Page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Get All Shelf Talkers
https://api.cbrands.com/api/1.0/shelfTalkers will return the following JSON:
[
{
"brand": "SIMI",
"brandFamily": null,
"dateCreated": "2018-03-30T12:02:59Z",
"dateModified": "2018-04-02T12:45:46Z",
"datePublished": "2018-03-29T13:30:23Z",
"extension": "pdf",
"id": "25FBD197-0C87-44ED-AC867E8AE83657B8",
"itemSize": "750",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/25FBD197-0C87-44ED-AC867E8AE83657B8/mini-2AFD7351-C935-4F71-819D35C20562350F.jpg",
"name": "2014 SIMI Landslide Cabernet Sauvignon Shelf Talker Decanter Magazine 90 Points Highly Recommended Award",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/25FBD197-0C87-44ED-AC867E8AE83657B8/thul-5D012650-9C13-45C7-8EE0095927955C2D.jpg",
"upc": "",
"varietal": "Cabernet Sauvignon",
"vintage": "2014",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/25FBD197-0C87-44ED-AC867E8AE83657B8/webimage-CF8D6B93-2318-4869-95DA8CB9652E076B.jpg"
}
]
Retrieves all shelf talkers that have been modified since the specified date.
HTTP Request
https://api.cbrands.com/api/1.0/shelfTalkers
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
| dateModified | Retrieve bottle shots modified after this date. ISO8601 format: yyyy-mm-ddThh:mm:ssZ. Example: 2016-12-25T10:30:00Z | string |
| numberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Header Variables
Header variables are optional and can be used instead of query parameters. Header variables will override query parameters if both are used.
| Variable | Description | Type |
|---|---|---|
| X-CBI-NumberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| X-CBI-Page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Get All Neck Hangers
https://api.cbrands.com/api/1.0/neckHangers will return the following JSON:
[
{
"brand": "Spoken Barrel",
"brandFamily": null,
"dateCreated": "2018-02-16T21:00:22Z",
"dateModified": "2018-02-16T21:00:22Z",
"datePublished": "2018-02-15T16:02:09Z",
"extension": "pdf",
"id": "6C1D7642-BB7C-4CCC-B0183782BFD5986B",
"itemSize": "",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/6C1D7642-BB7C-4CCC-B0183782BFD5986B/mini-3A3FFA99-FF24-4293-9DE111DB7BBE5F49.jpg",
"name": "2015 SPO Meritage String Tie Necker 2018 Tastings.com World Wine Championships Silver Medal 89 Points",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/6C1D7642-BB7C-4CCC-B0183782BFD5986B/thul-D47A4CCC-DE42-477D-ACF1E24D5161F5DE.jpg",
"upc": "",
"varietal": "Red Meritage",
"vintage": "2015",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/6C1D7642-BB7C-4CCC-B0183782BFD5986B/webimage-7873B00B-A581-4397-A131DF010BDDC4D4.jpg"
}
]
Retrieves all neck hangers that have been modified since the specified date.
HTTP Request
https://api.cbrands.com/api/1.0/neckHangers
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
| dateModified | Retrieve bottle shots modified after this date. ISO8601 format: yyyy-mm-ddThh:mm:ssZ. Example: 2016-12-25T10:30:00Z | string |
| numberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Header Variables
Header variables are optional and can be used instead of query parameters. Header variables will override query parameters if both are used.
| Variable | Description | Type |
|---|---|---|
| X-CBI-NumberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| X-CBI-Page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Get All Recipes
https://api.cbrands.com/api/1.0/recipes will return the following JSON:
[
{
"brand": "SVEDKA",
"brandFamily": null,
"dateCreated": "2017-10-03T20:47:34Z",
"dateModified": "2017-10-03T20:47:34Z",
"datePublished": "2017-10-03T20:05:17Z",
"extension": "pdf",
"id": "F683D2F7-063D-496C-8E1DF9F9DD23240C",
"itemSize": "",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/F683D2F7-063D-496C-8E1DF9F9DD23240C/mini-7434E1FF-DE1E-4388-930205DCAF8477D2.jpg",
"name": "SVK Vodka \"Candy Corn Jelly Shots\" Recipe",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/F683D2F7-063D-496C-8E1DF9F9DD23240C/thul-9FA394BD-3CEC-45E0-91B957D50BFE29D8.jpg",
"upc": "",
"varietal": "Vodka",
"vintage": "",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/F683D2F7-063D-496C-8E1DF9F9DD23240C/webimage-C2F2F85A-9EDA-47A0-ACFD3E1C3976F554.jpg"
}
]
Retrieves all recipes that have been modified since the specified date.
HTTP Request
https://api.cbrands.com/api/1.0/recipes
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
| dateModified | Retrieve bottle shots modified after this date. ISO8601 format: yyyy-mm-ddThh:mm:ssZ. Example: 2016-12-25T10:30:00Z | string |
| numberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Header Variables
Header variables are optional and can be used instead of query parameters. Header variables will override query parameters if both are used.
| Variable | Description | Type |
|---|---|---|
| X-CBI-NumberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| X-CBI-Page | Offset page for results, return Nth set of results - default 1 if not specified | integer |
Product API
https://api.cbrands.com/v3/items
This API returns information about our Products including, but not limited to:
- Item identification information (SKUs, UPCs, GTINs, COLAs, etc)
- Item descriptions
- Varietal information
- Item sizes
- Digital assets (bottle shots, tasting notes)
Authentication
The Product API requires only an API key for authentication. Submit a request for a key and use it as shown in the requests below.
Get All Items
https://api.cbrands.com/v3/items will return the following JSON:
[
{
"id": "10",
"shortCode": "10",
"shortDescription": "HERM FORW ICB 750/12",
"longCode": "003202",
"longDescription": "UNKNOWN",
"masterSkuDescription": "HERM FORW ICB 750/12",
"masterSkuCode": "003202",
"subBrandCode": "1376",
"subBrandDescription": "HERMIT",
"brandCode": "327",
"brandDescription": "HERMIT",
"brandFamilyCode": "296",
"brandFamilyDescription": "HERMIT",
"brandOwnerCode": "103",
"brandOwnerDescription": "CONSTELLATION BRANDS CANADA, INC.",
"upcNumber": "006365700360",
"gtin": "063657003602",
"masterPackageCode": "327-219-999",
"masterPackageDescription": "HERMIT 750 N/A",
"universalSkuCode": "22894",
"universalSkuDescription": "HERMIT APERA 750ML",
"beverageType": "WINE",
"varietalBlendCode": "BR2",
"varietalBlendDescription": "FORTIFIED WINE",
"varietalClassCode": "999",
"varietalClassDescription": "N/A",
"accountSegmentSubBrandCode": "UNK",
"accountSegmentSubBrandDescription": "UNKNOWN",
"vintageCode": "999",
"vintageDescription": "N/A",
"packageTypeCode": "102",
"packageTypeDescription": "GLASS",
"singleServePackage": false,
"item02Description": "UNKNOWN",
"item01Code": "10",
"item02Code": "003202",
"item01Description": "HERM FORW ICB 750/12"
},
{
"id": "100",
"shortCode": "100",
"shortDescription": "INNA EST RIES VQA 750/12",
"longCode": "083790",
"longDescription": "UNKNOWN",
"masterSkuDescription": "INNA EST RIES VQA 750/12",
"masterSkuCode": "083790",
"subBrandCode": "2391",
"subBrandDescription": "INNISKILLIN NIAGARA EST COL",
"brandCode": "343",
"brandDescription": "INNISKILLIN NIAGARA",
"brandFamilyCode": "309",
"brandFamilyDescription": "INNISKILLIN",
"brandOwnerCode": "103",
"brandOwnerDescription": "CONSTELLATION BRANDS CANADA, INC.",
"upcNumber": "062065402001",
"gtin": "620654020010",
"masterPackageCode": "343-219-999",
"masterPackageDescription": "INNISKILLIN NIAGARA 750 N/A",
"universalSkuCode": "23011",
"universalSkuDescription": "INNISKILLIN NIAGARA EST COL RIESLING 750ML",
"beverageType": "WINE",
"varietalBlendCode": "632",
"varietalBlendDescription": "RIESLING",
"varietalClassCode": "999",
"varietalClassDescription": "N/A",
"accountSegmentSubBrandCode": "UNK",
"accountSegmentSubBrandDescription": "UNKNOWN",
"vintageCode": "999",
"vintageDescription": "N/A",
"packageTypeCode": "102",
"packageTypeDescription": "GLASS",
"singleServePackage": false,
"item02Description": "UNKNOWN",
"item01Code": "100",
"item02Code": "083790",
"item01Description": "INNA EST RIES VQA 750/12"
},
{
"id": "100806",
"shortCode": "100806",
"shortDescription": "WB SVB CA 750/12 2CL",
"longCode": "100806",
"longDescription": "CA 2CL",
"masterSkuDescription": "WB SVB CA 750/12",
"masterSkuCode": "80002186",
"subBrandCode": "1917",
"subBrandDescription": "WOODBRIDGE BY ROBERT MONDAVI",
"brandCode": "631",
"brandDescription": "WOODBRIDGE BY ROBERT MONDAVI",
"brandFamilyCode": "466",
"brandFamilyDescription": "ROBERT MONDAVI",
"brandOwnerCode": "100",
"brandOwnerDescription": "CONSTELLATION BRANDS US OPERATIONS, INC",
"upcNumber": "008600386186",
"gtin": "086003861862",
"masterPackageCode": "631-219-999",
"masterPackageDescription": "WOODBRIDGE BY ROBERT MONDAVI 750 N/A",
"universalSkuCode": "21715",
"universalSkuDescription": "WOODBRIDGE BY ROBERT MONDAVI SAUVIGNON BLANC 750ML",
"beverageType": "WINE",
"varietalBlendCode": "667",
"varietalBlendDescription": "SAUVIGNON BLANC",
"varietalClassCode": "114",
"varietalClassDescription": "FUME/SAUVIGNON BLANC",
"accountSegmentSubBrandCode": "138",
"accountSegmentSubBrandDescription": "WOODBRIDGE BY ROBERT MONDAVI 750ML",
"vintageCode": "999",
"vintageDescription": "N/A",
"packageTypeCode": "102",
"packageTypeDescription": "GLASS",
"singleServePackage": false,
"item02Description": "CA 2CL",
"item01Code": "100806",
"item02Code": "100806",
"item01Description": "WB SVB CA 750/12 2CL"
}
]
Retrieves all items, limited to a specified (or defaulted) number of records.
HTTP Request
https://api.cbrands.com/v3/items
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
| numberOfRecords | The number of records to retrieve - default 50 if not specified | integer |
| recordIndex | The index of the first record to return (1 based) - default 1 if not specified | integer |
Get a Specific Item
https://api.cbrands.com/v3/items/100806 will return the following JSON:
{
"id": "100806",
"shortCode": "100806",
"shortDescription": "WB SVB CA 750/12 2CL",
"longCode": "100806",
"longDescription": "CA 2CL",
"masterSkuDescription": "WB SVB CA 750/12",
"masterSkuCode": "80002186",
"subBrandCode": "1917",
"subBrandDescription": "WOODBRIDGE BY ROBERT MONDAVI",
"brandCode": "631",
"brandDescription": "WOODBRIDGE BY ROBERT MONDAVI",
"brandFamilyCode": "466",
"brandFamilyDescription": "ROBERT MONDAVI",
"brandOwnerCode": "100",
"brandOwnerDescription": "CONSTELLATION BRANDS US OPERATIONS, INC",
"upcNumber": "008600386186",
"gtin": "086003861862",
"masterPackageCode": "631-219-999",
"masterPackageDescription": "WOODBRIDGE BY ROBERT MONDAVI 750 N/A",
"universalSkuCode": "21715",
"universalSkuDescription": "WOODBRIDGE BY ROBERT MONDAVI SAUVIGNON BLANC 750ML",
"beverageType": "WINE",
"varietalBlendCode": "667",
"varietalBlendDescription": "SAUVIGNON BLANC",
"varietalClassCode": "114",
"varietalClassDescription": "FUME/SAUVIGNON BLANC",
"accountSegmentSubBrandCode": "138",
"accountSegmentSubBrandDescription": "WOODBRIDGE BY ROBERT MONDAVI 750ML",
"vintageCode": "999",
"vintageDescription": "N/A",
"packageTypeCode": "102",
"packageTypeDescription": "GLASS",
"singleServePackage": false,
"item02Description": "CA 2CL",
"item01Code": "100806",
"item02Code": "100806",
"item01Description": "WB SVB CA 750/12 2CL"
}
This endpoint retrieves a specific item based on the item’s id.
HTTP Request
https://api.cbrands.com/v3/items/{itemId}
URI Parameters
| Parameter | Decription | Type |
|---|---|---|
| itemId | The ID of the item to retrieve | string |
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |
Get an Item’s Digital Assets
https://api.cbrands.com/v3/items/100806/digitalAssets will return the following JSON:
{
"bottleShots": [
{
"brand": "Woodbridge by Robert Mondavi",
"brandFamily": "Robert Mondavi",
"dateCreated": "2016-01-19T16:09:49Z",
"dateModified": "2018-01-31T14:52:03Z",
"datePublished": "2016-01-19T19:02:00Z",
"extension": "psd",
"id": "E8AB533B-905E-45C8-8529B6968612A879",
"itemSize": "750",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/E8AB533B-905E-45C8-8529B6968612A879/C035386D-3C5D-4143-9865629944AE141B/mini-00895962-0507-4A92-B5FFBBE37835C3D6.png",
"name": "WBR Sauvignon Blanc 750ml Bottle Shot with Capsule",
"standardFinalJpeg": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/E8AB533B-905E-45C8-8529B6968612A879/Standard Final JPG-WBR_750ml_SauvBlanc_wcapsule_NV.jpg",
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/E8AB533B-905E-45C8-8529B6968612A879/C035386D-3C5D-4143-9865629944AE141B/thul-0D228C38-39B1-4C21-AFF1232D430B6DD0.png",
"upc": "086003861862",
"varietal": "Sauvignon Blanc",
"vintage": "",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/E8AB533B-905E-45C8-8529B6968612A879/C035386D-3C5D-4143-9865629944AE141B/webimage-5B3DA1F1-13EC-490B-9C1F1F089F22CA50.png",
"transparentPNG": null
}
],
"tastingNotes": [
{
"id": "BB60D46A-6A83-45FF-ACFAFD865D696285",
"name": "2016 WBR Sauvignon Blanc NSRP Tasting Note",
"dateCreated": "2017-07-13T23:06:17Z",
"datePublished": "2017-07-13T18:39:00Z",
"dateModified": "2018-02-05T19:08:29Z",
"extension": "PDF",
"tastingFlavor": null,
"blend": null,
"ph": null,
"residualSugars": null,
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/BB60D46A-6A83-45FF-ACFAFD865D696285/webimage-5E087897-DA1E-42FE-AD9C04E6CBC890E5.jpg",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/BB60D46A-6A83-45FF-ACFAFD865D696285/mini-0BF927F1-585E-4822-990826B880397D77.jpg",
"standardFinalJpeg": null,
"high": null,
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/BB60D46A-6A83-45FF-ACFAFD865D696285/thul-AED1F202-7217-498D-8E27FF077EC9DD02.jpg",
"webPNG": null,
"transparentPNG": null
},
{
"id": "39450C12-1710-4378-A61A854D2F8B6B04",
"name": "2015 WBR Sauvignon Blanc NSRP Tasting Note",
"dateCreated": "2016-10-24T14:51:14Z",
"datePublished": "2016-10-21T17:21:00Z",
"dateModified": "2018-02-05T19:07:57Z",
"extension": "pdf",
"tastingFlavor": null,
"blend": "77% Sauvignon Blanc, 13% French Colombard, 9% Verdelho, 1% Chardonnay ",
"ph": "3.31",
"residualSugars": "2.7",
"webImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/39450C12-1710-4378-A61A854D2F8B6B04/webimage-4DCC506D-2A05-4D09-A24E5CA167A12490.jpg",
"miniImage": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/39450C12-1710-4378-A61A854D2F8B6B04/mini-9AAFC246-31C5-4E8C-8B4CE61B33AD9212.jpg",
"standardFinalJpeg": null,
"high": null,
"thul": "https://d3cy9zhslanhfa.cloudfront.net/media/A00BE735-E84A-43D8-811178338E465C9A/39450C12-1710-4378-A61A854D2F8B6B04/thul-9C1440D1-0DC9-44E8-AF96711CCD163F4E.jpg",
"webPNG": null,
"transparentPNG": null
}
]
}
This endpoint retrieves an item’s available digital assets, including bottle shots and tasting notes. Both arrays of bottle shots and tasting notes contain objects that have contextual information about the digital asset as well as different sized images of the assets.
HTTP Request
https://api.cbrands.com/v3/items/{itemId}/digitalAssets
URI Parameters
| Parameter | Decription | Type |
|---|---|---|
| itemId | The ID of the item to retrieve digital assets for | string |
Query Parameters
| Parameter | Description | Type |
|---|---|---|
| apiKey | The API key you received upon registration | string |