Ajouter/Mettre à jour l'article
The following endpoint can be used to add or update an item within the Hyfin application.
Point de terminaison
Le point d'extrémité suivant peut être utilisé pour ajouter ou mettre à jour un élément. Vous devez remplacer le {base_url} et {site_id} variables with your issued host and the site id that was provided when the site was created.
POST
{base_url}/api/v4/site/{site_id}/item/addUpdate
Le même point de terminaison est utilisé pour ajouter ou mettre à jour an Article. Si an Article existe déjà avec le {externalId} , le Article sera mis à jour sinon il sera inséré.
Demande
Champ
Type
Description
externalId
String
Le numéro d'élément unique du système/base de données source. Si nous détectons un enregistrement avec le même externalId, il sera mis à jour, sinon il sera ajouté.
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.
deleted
Boolean
Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.
Sample Request
{
"externalId": "439772921",
"name": "Men's Large T-Shirt",
"unitPrice": 1499,
"deleted": false
}
Réponse
Champ
Type
Description
success
Boolean
Whether the record was added or updated successfully.
action
String
Informs whether the record was added or updated. Will only be returned if success is true.
One of added, updated
One of added, updated
_id
String
The auto generated id assigned to the record.
updatedAt
Date
The date the record was last updated.
errors
String [ ]
A list of errors. Will only be returned if success is false.
Sample Response (Successful)
{
"success": true,
"action": "added",
"_id": "60f720d248f143332af022e0",
"updatedAt": "2025-05-30T19:19:44.143Z"
}
Sample Response (Failed)
{
"success": false,
"errors": [
"invalid field2",
"missing field_name"
]
}