Agregar/Actualizar artículo
La siguiente endpoint se puede utilizar para agregar o actualizar un elemento dentro de la aplicación {app.name}.
Punto Final
La siguiente endpoint se puede utilizar para agregar o actualizar un elemento. Debes reemplazar el site_id variable con el ID del sitio que se proporcionó cuando se creó el sitio.
POST
{base_url}/api/v4/site/{site_id}/item/addUpdate
La misma ruta de acceso se utiliza para agregar o actualizar an Artículo. Si el {_id} se proporciona, el Artículo se actualizará de lo contrario se insertará.
Solicitud
Campo
Tipo
Descripción
id
String
El id del artículo. Este campo es generado por el sistema y no es necesario al crear un nuevo artículo, pero es necesario al actualizar un artículo existente.
name
String
El nombre del artículo.
description
String
La descripción del artículo.
unitPrice
Number
El precio por unidad del artículo.
deleted
Boolean
Esta bandera representa si el registro ha sido eliminado y ya no está disponible para ser utilizado.
Sample Request
{
"_id": "6839e415564d3cc2160d945e",
"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"
]
}