Get Product

Use this when you need one product as Hyfin has it, by its external_id.


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.1/site/{site_id}/product/{external_id}
Request
No body is required for this API call
Response
Field
Type
Description
_id
String
The id of the product.
external_id
String
Your own id for this product, from your software. Send the same external_id again to update this product instead of adding a new one. We match on this value but do not stop duplicates, so keep it unique within the site.
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
created_at
Timestamp
The date the product was created. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updated_at
Timestamp
The date the product was last updated. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
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"
}


		

Related