Return to documentation index

spirits

The spirits API retrieves a list of all spirits sold by the account. This may include spirits that are currently out of stock.

Parameters

  • api_key (string) Required - The API key for the account
  • last_updated_at (datetime) Optional - If this parameter is supplied, only spirits whose last edited date is after the supplied date and time will be returned. The parameter should be formatted as "YYYY-MM-DD HH:MM:SS" and will be interpreted as a UTC date and time value.

Response

The spirits API returns a JSON array of spirits. Each member of the array includes these attributes:

  • id - Unique identifier.
  • updated_at - The date that this spirit was last edited.
  • created_at - The initial date that this spirit was created.
  • name - The display name of the spirit.
  • description - The description of the spirit. This attribute will always be blank.
  • abv - The alcohol by volume of the spirit.
  • ingredients - The ingredients used in the spirit (most important for cocktails)
  • ingredients_description - Description of the primary ingredient in the spirit.
  • hidden_search_terms - Search terms for which this spirit should be returned. This attribute is not itself displayed on the Tastevin iOS user interface.
  • proof - The proof of the spirit.
  • accolades - Array of accolades for this spirit. Each accolade is characterized by the accolade attributes below.
  • cocktail - True if this spirit is a cocktail, false for back bar spirits

Accolade attributes

  • id - Unique identifier.
  • updated_at - The date that this accolade was last edited.
  • created_at - The initial date that this accolade was created.
  • beverage_id - The unique identifier of the spirit to which this accolade belongs.
  • author - The author of the accolade.
  • body - The text of the accolade.
  • owner_id - The unique identifier of the account that input this accolade.
  • published_at - The date of publication of this accolade.
  • source - The source of this accolade.
  • title - The title of this accolade.

Notes

The id attribute is used by the spirit_list API to indicate the spirit to which each spirit SKU belongs.

Sample Request

https://dashboard.onpremisewine.com/spirits.json?api_key=ABCDEF123456

Sample Response

{
  "beverages": [
    {
      "id": 15098,
      "updated_at": "2012-05-29T15:17:40-07:00",
      "created_at": "2012-04-03T12:23:41-07:00",
      "name": "Sidecar",
      "description": "",
      "abv": null,
      "ingredients": "Hennessy VS Cognac, fresh lemon juice and simple syrup",
      "ingredients_description": "Hennessy V.S. is a blend of around 40 different \"eaux-de-vie\" selected for their vivacity from the best growing areas of the Cognac region.  In 1865, Maurice Hennessy, the great grandson of the founder, Richard Hennessy, was the first to systematically classify Cognacs. Inspired by a decorative star symbol on his office window, he awarded a varying number of stars to designate the different quality levels. Thus was born the House of Hennessy's first Three Star Cognac, better known today as V.S. (Very Special) This grading system was soon adopted by the rest of the trade.\r\n\r\nSimple Syrup is a liquid sugar that is 2 parts water to one part sugar.",
      "hidden_search_terms": null,
      "proof": null,
      "accolades": [],
      "cocktail": false
    },
    {
      "id": 15101,
      "updated_at": "2012-05-09T14:45:01-07:00",
      "created_at": "2012-04-03T15:41:40-07:00",
      "name": "Pousse Cafe",
      "description": "The three \"s\" of a good Pousse Cafe: Suck, Swish & Swallow\r\nGrenadine, Creme de Menthe, Orange Liqueur, Silver Tequila, 151 rum.",
      "abv": null,
      "ingredients": "Grenadine, Creme de Menthe, Orange Liqueur, Silver Tequila, 151 rum",
      "ingredients_description": "",
      "hidden_search_terms": null,
      "proof": null,
      "accolades": [],
      "cocktail": true
    },
    {
      "id": 46845,
      "updated_at": "2012-09-26T11:35:32-07:00",
      "created_at": "2012-09-26T11:35:22-07:00",
      "name": "Eagle Rare \"10 Year Single Barrel\"",
      "description": "",
      "abv": null,
      "ingredients": "Bourbon Whiskey",
      "ingredients_description": "Eagle Rare Single Barrel Bourbon Whiskey is masterfully crafted and carefully aged for no less than ten years, each barrel is discriminately selected. The rareness of this great breed of bourbon is evident in its complex aroma, as well as the smooth and lingering taste. Each bottle of Eagle Rare offers consistent flavors, but with a seemingly individual personality from each unique barrel. Eagle Rare is a bourbon that lives up to its name with its lofty, distinctive taste experience.",
      "hidden_search_terms": "",
      "proof": null,
      "accolades": [],
      "cocktail": false
    },
    {
      "id": 46846,
      "updated_at": "2012-09-26T11:36:26-07:00",
      "created_at": "2012-09-26T11:36:07-07:00",
      "name": "Don Julio \"AƱejo\"",
      "description": "",
      "abv": null,
      "ingredients": "Tequila",
      "ingredients_description": "It is wonderfully complex with expressions of cooked agave and wild honey. It also includes notes of cherries and strawberries with vanilla and oaky butterscotch. Don Julio Anejo is distinctively full-bodied with astonishing depth of character and bright and lightly spiced finish with the essence of wild honey in the background.",
      "hidden_search_terms": null,
      "proof": null,
      "accolades": [],
      "cocktail": false
    }
  ]
}