Get Product
The following endpoint can be used to retrieve the details of a product within the Hyfin application.
Punto Final
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}
Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Requerido
Descripción
_id
String
--
El ID del producto.
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
El nombre del producto.
description
String
La descripción del producto.
unit_price
Number
El precio por unidad del producto. Format = 0.00
active
Boolean
--
Esta bandera representa si el registro del producto está activo y disponible para ser utilizado o no.
Default = `true`
Default = `true`
created_at
Date
--
La fecha en que se creó el producto.
updated_at
Date
--
La fecha en que se actualizó por última vez el producto.
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"
}