Get Item

Use this when you need one item as Hyfin has it, by its _id.


The following endpoint can be used to retrieve the details of an item within the Hyfin application.


Endpoint

The following endpoint can be used to retrieve an item. You must replace the base_url , _id and site_id variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/item/{_id}
Request
No body is required for this API call
Response
Field
Type
Description
_id
String
The id we assign to this item. Leave it out when creating an item, and send it when updating one.
externalId
String
Your own id for this item, from your software. Send the same externalId again to update this item instead of adding a new one. We match on this value but do not stop duplicates, so keep it unique within the site.
name
String
The name of the item.
description
String
The description of the item.
unitPrice
Number
The price per unit of the item. This is an integer number of cents, so 1035 means $10.35.
createdAt
The date the item was created. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updatedAt
The date the item was last updated. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
deleted
Boolean
This flag represents whether the record is deleted and no longer available to be used.
Sample Response
			
{
  "_id": "6839e415564d3cc2160d945e",
  "externalId": "439772921",
  "name": "Garlic Soy Tikkudak Wings",
  "description": "Tikkudak is a specialty where fried chicken is baked in a charcoal oven to create a smoky and crispy flavor.",
  "unitPrice": 1500,
  "createdAt": "2025-05-30T19:19:44.143Z",
  "updatedAt": "2025-05-30T19:19:44.143Z"
}


		

Related