beverage_sku_lists

The beverage_sku_lists API retrieves a list of all beverage SKU lists for an account. Each beverage SKU list provides information for ordering and grouping beverage SKUs of a particular type.

Parameters

api_key (string) Required - The API key for the account
last_updated_at (datetime) Optional - If this parameter is supplied, only lists and items 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 beverage_sku_lists API returns a JSON array of beverage SKU lists. Each member of the array includes these attributes:

id - Unique identifier.
updated_at - The date that this list was last edited.
created_at - The initial date that this list was created.
name - The display name of the list. Currently, this is null for all lists.
list_type - An integer identifying the type of list. See below for the possible values for this attribute.
beverage_sku_list_items - An array of beverage SKU list items. See below for the description of these objects.

List Type values

Each beverage SKU list has one of these list_type values:

0 - Wine list
1 - Inventory list
2 - Beer list
3 - Spirit list

Beverage SKU List Item attributes

Each list contains an array of beverage SKU list items. Each member of this array includes these attributes:

id - Unique identifier.
updated_at - The date that this list item was last edited.
created_at - The initial date that this list item was created.
ordinal - Relative display order of this item in the list. Ordinals do not necessarily start at zero, and may skip numbers.
beverage_sku_id - Identifier for a beverage SKU to be displayed in this position. This identifier may refer to a SKU retrieved by the wine_list API, the beer_list API, or the spirit_list API, depending on which list this item belongs to.
beverage_sku_list_id - Identifier for the beverage SKU list that contains this beverage SKU list item.
beverage_sku_list_group_id - Identifier for the beverage SKU list group that contains this beverage SKU list item. This may be null for items that are not in any group.
added_at - The date that the beverage SKU for this item was most recently made available for sale.
eighty_sixed_at - The date that the beverage SKU for this item was most recently removed from sale.
status - A status code for the beverage SKU. A value of 0 indicates an active SKU. A value of 1 indicates an inactive (deleted) SKU. A value of 3 indicates a stock SKU that is maintained for inventory purposes only but that should not be displayed for sale. Other values are reserved for internal use only and should not be displayed for sale.

Notes

The inventory list is not designed to be displayed to customers, and in some accounts may contain a mix of wines, beers, and spirits.

Sample Request

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

Sample Response

{
  "beverage_sku_lists": [
    {
      "id": 18,
      "updated_at": "2012-09-28T20:14:00-07:00",
      "created_at": "2011-10-07T10:08:57-07:00",
      "name": null,
      "list_type": 0,
      "beverage_sku_list_items": [
        {
          "id": 31167,
          "updated_at": "2012-05-23T14:00:26-07:00",
          "created_at": "2012-04-21T02:19:01-07:00",
          "ordinal": 0,
          "beverage_sku_id": 2977,
          "beverage_sku_list_id": 18,
          "beverage_sku_list_group_id": null,
          "added_at": "2012-04-21T02:19:01-07:00",
          "eighty_sixed_at": null,
          "status": 0
        },
        {
          "id": 38264,
          "updated_at": "2012-09-14T14:01:52-07:00",
          "created_at": "2012-04-28T05:39:11-07:00",
          "ordinal": 1,
          "beverage_sku_id": 15526,
          "beverage_sku_list_id": 18,
          "beverage_sku_list_group_id": 5422,
          "added_at": "2012-09-14T14:01:52-07:00",
          "eighty_sixed_at": null,
          "status": 1
        },
        {
          "id": 57287,
          "updated_at": "2012-07-24T14:08:43-07:00",
          "created_at": "2012-07-24T14:08:27-07:00",
          "ordinal": 2,
          "beverage_sku_id": 29052,
          "beverage_sku_list_id": 18,
          "beverage_sku_list_group_id": 1235,
          "added_at": "2012-07-24T14:08:43-07:00",
          "eighty_sixed_at": null,
          "status": 0
        },
        {
          "id": 4731,
          "updated_at": "2012-09-27T13:34:15-07:00",
          "created_at": "2011-11-08T18:09:11-08:00",
          "ordinal": 3,
          "beverage_sku_id": 2603,
          "beverage_sku_list_id": 18,
          "beverage_sku_list_group_id": 1235,
          "added_at": "2011-11-08T18:09:11-08:00",
          "eighty_sixed_at": null,
          "status": 0
        }
      ]
    }
  ]
}