Articles in this section

See more

Get Location Menu Product

Avatar
John Twomey
  • Updated
Follow

Retrieve a Menu item for a Location

GET ~/locations/:hashed-location-id/menu/products/:posId

Request

Field Type Description
:hashed-location-id String

The hashed ID of the location you're targeting. See Hashed Location IDs
:posId String

The POS id of the Product

 Response

Field Type Description
posId String

The POS id of the Product
name String

The display name of the Product
description String

A short description of the Product (sometimes unavailable)
unitPrice String

The price of the Product in cents
tags String[]

Array of strings to help group Products together
menuDir String[]

An array of strings representing a menu directory. Eg. For a Flat White - ["coffee/hot", "drinks/coffee"] would signify the product exists on the menu under "Coffee" with the submenu being "Hot", and also on the menu under "Drinks" with the submenu "Coffee".
type String

Either a type of 'single' or 'bundle'. Defaults to 'single' 
includedItems Object[]

Array of items that are included in a bundle 
  name String

The name of the included item
  posId String

The posId of the included item
  productIds Object

A list of product IDs to help identify the included item
    gtin-8 String

The GTIN-8 (EAN/UCC-8) product code
    gtin-12 String

The GTIN-12 (UPC-A) product code
    gtin-13 String

The GTIN-13 (EAN/UCC-13) product code
    gtin-14 String

The GTIN-14 (EAN/UCC-14 or ITF-14) product code
    sku String

The Stock Keeping Unit (SKU) of the included item
    plu String

The Price Look Up (PLU) code
    barcodes String[]

A generic array of barcodes.
  quantity String

The quantity of the included item
  unitPrice String

The unitPrice of the included item
  options Object[]

Array of options that can be added to the Product
    posId String

The POS id of the option
    name String

The display name of the option
    min String

The minimum number that can be selected (0 for no min)
    max String

The maximum number that can be selected (0 for no max)
    variants Object[]

The available Variants for the option
      posId String

The POS id of the Variant
      name String

The display name of the Variant
      price String

The price of the Variant in cents
productIds Object

A list of product IDs to help identify the menu item
  gtin-8 String

The GTIN-8 (EAN/UCC-8) product code
  gtin-12 String

The GTIN-12 (UPC-A) product code
  gtin-13 String

The GTIN-13 (EAN/UCC-13) product code
  gtin-14 String

The GTIN-14 (EAN/UCC-14 or ITF-14) product code
  sku String

The Stock Keeping Unit (SKU) of the item
  plu String

The Price Look Up (PLU) code
  barcodes String[]

A generic array of barcodes.
options Object[]

Array of options that can be added to the Product
  posId String

The POS id of the option
  name String

The display name of the option
  min Number

The minimum number that can be selected (0 for no min)
  max Number

The maximum number that can be selected (0 for no max)
  variants Object[]

The available Variants for the option
    posId String

The POS id of the Variant
    name String

The display name of the Variant
    price String

The price of the Variant in cents
surcounts Object[]

Array of Surcount objects that can be applied to a Product
  posId String

The POS id of the Surcount
  name String

The display name of the Surcount
  amount String

The amount in cents to surcharge/discount (positive/negative)
  type String

Whether this is an 'absolute' or 'percentage' Surcount

Examples

Response


{
  "posId": "eggs12",
  "name": "Toasted Sourdough & Eggs",
  "description": "Just ye old classic",
  "price": "1100",
  "tags": [
    "Breakfast",
    "Lunch"
  ],
  "surcounts": [{
    "posId": "100_percent_discount",
    "name": "Free Item",
    "amount": "-100",
    "type": "percentage"
  }],
  "options": [{
    "name": "How would like the eggs cooked?",
    "min": 1,
    "max": 1,
    "posId": "egg_cook_type",
    "variants": [{
      "name": "Poached",
      "posId": "poached_egg"
    }, {
      "name": "Scrambled",
      "posId": "scrambled_egg"
    }, {
      "name": "Fried",
      "posId": "fried_egg"
    }, {
      "name": "Hard Boiled",
      "posId": "hard_boiled_eggs"
    }]
  }, {
    "posId": "egg_extras",
    "name": "Extras",
    "min": 0,
    "max": 3,
    "variants": [{
      "posId": "extra_bacon",
      "name": "Bacon",
      "price": 200
    }, {
      "posId": "extra_sliced_avocado",
      "name": "Sliced Avocado",
      "price": 420
    }, {
      "posId": "extra_chorizo",
      "name": "Chorizo",
      "price": 420
    }]
  }]
}

Response: when product not found

HTTP/1.1 404 Not Found

 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.