Get Item

Utilisez ceci lorsque vous avez besoin d'un article tel que Hyfin le possède, à partir de son _id.


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 , _id and site_id variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/item/{_id}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Description
_id
String
L'identifiant que nous attribuons à cet article. Omettez-le lors de la création d'un article et envoyez-le lors de la mise à jour d'un article.
externalId
String
Votre propre identifiant pour cet article, provenant de votre logiciel. Envoyez à nouveau le même externalId pour mettre à jour cet article au lieu d'en ajouter un nouveau. Nous faisons la correspondance sur cette valeur, mais nous n'empêchons pas les doublons; gardez-la donc unique au sein du site.
name
String
Le nom de l'article.
description
String
La description de l'article.
unitPrice
Number
Le prix par unité de l'article. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
createdAt
La date à laquelle l'article a été créé. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updatedAt
La date à laquelle l'article a été mis à jour pour la dernière fois. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
deleted
Boolean
Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.
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"
}


		

Voir aussi