Read an Item · YourBarMate

GET /items/:id

Status codes

200 on success
404 on item not found

Response properties

id: The item identifier
category: The ID of the category
name: The name of the Item
account_code: Optional string with the account code (optional)
vessel: The vessel object: (optional)
- size: Size of the vessel in the specified unit
- unit: One of "l", "dl", "cl", "ml", "kg", "g" or "quantity"
- display_unit: When set, the vessel will be always converted to this unit when displayed. One of "kg", "l", "dl", "cl" (optional)
- type: See vessel and bundle types (optional)
supplier contains information about the supplier: (optional)
- id: The id of the supplier
- reference: The supplier reference for this item (optional)
bundles: The array of bundle objects: (optional)
- type: See vessel and bundle types
- size: The number of vessels in the bundle, or the number of bundles on the pallet if type is "PX"
- unit: Set to g, if the bundle is by weight (optional)
- pallet_bundle: Only if type is "PX". Specifies the bundle on the pallet:
  - type: See vessel and bundle types
  - size: The number of vessels in the bundle
price: The integer price in cents (optional)
price_per: One of "vessel", "l", "kg" or "100g" (optional)
order_by: One of "vessel" or "kg" (optional)
count_fractions: Expresses how fractional counts will be represented. Can be one of "l", "dl", "cl", "ml", "kg", "g", "quantity", "quarters", "decimal", "none" (optional)
links: Object for replacement links with two properties: (optional)
- replacement: The id of the item that is replacing this item (optional)
- replaces: An array of ids of items this item is replacing (optional)
master_data_locked: Either not defined or Boolean true. Master data is locked once the item is in stock. If it is true, vessel and order_by cannot be changed anymore. (optional)
archived: The timestamp of when the item was archived. (optional)
deleted: The timestamp of when the item was deleted. (optional)

Example response

{
  "id": "itm_oh0IyIjqvd",
  "category": "cat_KaNDv51Gh0",
  "name": "Vodka",
  "vessel": {
    "size": 7,
    "unit": "dl",
    "type": "BO"
  },
  "bundles": [
    {
      "type": "CT",
      "size": 6
    }
  ],
  "price": 750,
  "supplier": {
    "id": 1693919950079,
    "reference": "1100992"
  }
}