Add/Update Product

The following endpoint can be used to add or update a product within the Hyfin application. The products are then added to lines on an invoice.

Endpoint

The following endpoint can be used to add or update a product. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.

POST

{base_url}/api/v3.1/site/{site_id}/product/addUpdate

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

Request

Field

Type

Description

external_id

String

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

name

String

The name of the product.

description

String

The description of the product.

unit_price

Number

The price per unit of the product. Format = 0.00

active

Boolean

This flag represents whether the product record is active and available to be used or not.
Default = true

Sample Request

			
{
  "external_id": "39772641",
  "name": "Men's Large T-Shirt",
  "unit_price": 14.99,
  "active": true
}

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.

errors

String [ ]

A list of errors. Will only be returned if success is false.

Sample Response (Successful)

			
{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0"
}

Sample Response (Failed)

			
{
  "success": false,
  "errors": [
    "invalid field2",
    "missing field_name"
  ]
}