Get Item
The following endpoint can be used to retrieve the details of an item within the Hyfin application.
Point de terminaison
The following endpoint can be used to retrieve an item. You must replace the base_url , external_id and site_id variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/item/{external_id}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Requis
Description
_id
String
L'identifiant de l'élément. Ce champ est généré par le système et n'est pas requis lors de la création d'un nouvel élément, mais il est requis lors de la mise à jour d'un élément existant.
name
String
Le nom de l'article.
description
String
La description de l'article.
unit_price
Number
Le prix par unité de l'article. Format = 0.00
active
Boolean
--
Ce drapeau représente si l'enregistrement de l'article est actif et disponible pour être utilisé ou non.
Default = `true`
Default = `true`
created_at
Date
--
La date à laquelle l'article a été créé.
updated_at
Date
--
La date à laquelle l'article a été mis à jour pour la dernière fois.
Sample Response
{
"_id": "6839e415564d3cc2160d945e",
"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.",
"unit_price": "15.00",
"created_at": "2025-05-30T19:19:44.143Z",
"updated_at": "2025-05-30T19:19:44.143Z"
}