beverages

Changed on

Lists all beverages in the system.

put/api/beverages/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this beverage.

Request body

namestring required

Name of the beverage, such as "Potrero Pale".

producer_idinteger required
beverage_type'beer' | 'wine' | 'soda' | 'kombucha' | 'other'
  • beer - Beer
  • wine - Wine
  • soda - Soda
  • kombucha - Kombucha
  • other - Other/Unknown
stylestring nullable

Beverage style within type, eg "Pale Ale", "Pinot Noir".

descriptionstring nullable

Free-form description of the beverage.

vintage_yearstring date nullable

Date of production, for wines or special/seasonal editions

abv_percentnumber double nullable

Alcohol by volume, as percentage (0.0-100.0).

calories_per_mlnumber double nullable

Calories per mL of beverage.

carbs_per_mlnumber double nullable

Carbohydrates per mL of beverage.

color_hexstring

Approximate beverage color

original_gravitynumber double nullable

Original gravity (beer only).

specific_gravitynumber double nullable

Final gravity (beer only).

srmnumber double nullable

Standard Reference Method value (beer only).

ibunumber double nullable

International Bittering Units value (beer only).

star_ratingnumber double nullable

Star rating for beverage (0: worst, 5: best)

untappd_beer_idinteger nullable

Untappd.com resource ID (beer only).

Response

idinteger required
namestring required

Name of the beverage, such as "Potrero Pale".

beverage_type'beer' | 'wine' | 'soda' | 'kombucha' | 'other'
  • beer - Beer
  • wine - Wine
  • soda - Soda
  • kombucha - Kombucha
  • other - Other/Unknown
stylestring nullable

Beverage style within type, eg "Pale Ale", "Pinot Noir".

descriptionstring nullable

Free-form description of the beverage.

vintage_yearstring date nullable

Date of production, for wines or special/seasonal editions

abv_percentnumber double nullable

Alcohol by volume, as percentage (0.0-100.0).

calories_per_mlnumber double nullable

Calories per mL of beverage.

carbs_per_mlnumber double nullable

Carbohydrates per mL of beverage.

color_hexstring

Approximate beverage color

original_gravitynumber double nullable

Original gravity (beer only).

specific_gravitynumber double nullable

Final gravity (beer only).

srmnumber double nullable

Standard Reference Method value (beer only).

ibunumber double nullable

International Bittering Units value (beer only).

star_ratingnumber double nullable

Star rating for beverage (0: worst, 5: best)

untappd_beer_idinteger nullable

Untappd.com resource ID (beer only).

Changes

  • 8d1d025a79e9Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/json)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/x-www-form-urlencoded)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: multipart/form-data)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/json)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/x-www-form-urlencoded)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: multipart/form-data)

    • info

      removed the required write-only property producer_id from the response with the status