Add/Update Item

The following endpoint can be used to add or update an item within the Hyfin application.

Endpoint

The following endpoint can be used to add or update an item. You must replace the {base_url} and {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

The same endpoint is used to add or update an item. If an item already exists with the {externalId} , the item will be updated otherwise it will be inserted.

Request

Field

Type

Description

externalId

String

The unique item id from the source system/database. If we detect a record with the same externalId, it will be updated, otherwise it will be added.

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.

deleted

Boolean

This flag represents whether the record is deleted and no longer available to be used.

Sample Request

			
{
  "externalId": "439772921",
  "name": "Men's Large T-Shirt",
  "unitPrice": 1499,
  "deleted": false
}

Response

Field

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

_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"
  ]
}