Return to documentation index

point_of_sale_skus

The point_of_sale_skus API retrieves a list of all of the POS SKUs in the database

Parameters

• api_key (string) Required - The API key for the account

Response

The point_of_sale_skus API returns a JSON array of POS SKUs. Each member of the array includes these attributes:

• id - Unique identifier.
• updated_at - The date that this POS SKU was last edited.
• created_at - The date that this POS SKU was added to the system.
• beverage_sku_ids - Identifier of the beverage SKU matched to this POS SKU, or nil. These identifiers may refer to a SKU retrieved by the wine_list API, the beer_list API, or the spirit_list API
• status - The current status of the POS SKU. A value of 0 indicates a SKU that has never been mapped, a value of 1 indicates a SKU that is currently mapped, and a value of 2 indicates a SKU whose mapping was deleted.
• name - POS SKU name sent by the POS Manager.
• *pos_id - POS SKU id sent by the POS Manager.
• *sku - POS SKU sku value sent by the POS Manager.
• category - POS SKU category sent by the POS Manager.
• metadata - POS SKU metadata sent by the POS Manager.

If you pass the optional with_inventory parameter, the API returns a JSON array of POS SKUs with different information. Each member of the array includes these attributes:

• id - Unique identifier.
• current_inventory - Current inventory of the associated Beverage SKU

NOTE: If you pass the with_inventory parameter, the array will not include POS SKUs that are not mapped to a beverage SKU.

Sample Request

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

Sample Response

{
  "point_of_sale_skus": [
    {
      "id": 59732,
      "updated_at": "2012-04-18T08:58:53-07:00",
      "created_at": "2012-04-18T08:58:53-07:00",
      "beverage_sku_id": null,
      "status": 0,
      "name": "$10 TASTING",
      "pos_id": "11677",
      "sku": "11677",
      "category": 0,
      "metadata": "11677 - $10 TASTING"
    },
    {
      "id": 59733,
      "updated_at": "2012-04-18T08:58:54-07:00",
      "created_at": "2012-04-18T08:58:54-07:00",
      "beverage_sku_id" :null,
      "status": 0,
      "name": "$11 TASTING",
      "pos_id": "11236",
      "sku": "11236",
      "category": 0,
      "metadata": "11236 - $11 TASTING"
    }
  ]
}

Sample Request with inventory data

https://dashboard.onpremisewine.com/point_of_sale_skus.json?api_key=ABCDEF123456&with_inventory=1

Sample Response

{
  "point_of_sale_skus": [
    {
      "id": 59732,
      "current_inventory": 16
    },
    {
      "id": 59733,
      "current_inventory": 21
    }
  ]
}