Get Product
The following endpoint can be used to retrieve the details of a product within the Hyfin application.
Endpoint
The following endpoint can be used to retrieve a product. You must replace the {base_url} , {external_id} and {site_id} variables with the appropriate values.
GET
{base_url}/api/v3/site/{site_id}/product/{external_id}
Request
No body is required for this API call
Response
Field
Type
Required
Description
_id
String
--
The id of the product.
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`
Default = `true`
created_at
Date
--
The date the product was created.
updated_at
Date
--
The date the product was last updated.
Sample Response
{
"_id": "6839e415564d3cc2160d945e",
"external_id": "1",
"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"
}