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.
Punto Final
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
La misma ruta de acceso se utiliza para agregar o actualizar a Producto. Si a Producto ya existe con el {external_id} , el Producto se actualizará de lo contrario se insertará.
Solicitud
Campo
Tipo
Descripción
external_id
String
El identificador único del producto del sistema/base de datos fuente. Si detectamos un registro con el mismo external_id, se actualizará; de lo contrario, se agregará.
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
Sample Request
{
"external_id": "39772641",
"name": "Men's Large T-Shirt",
"unit_price": 14.99,
"active": true
}
Respuesta
Campo
Tipo
Descripción
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
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"
]
}