CredonixDocs
Referencia de la APIProductos

Editar

Actualiza parcialmente un producto existente.

Descripción general

Este endpoint actualiza parcialmente un producto. Todos los campos del cuerpo son opcionales y siguen las mismas reglas que en Crear producto:

  • Omitido → el campo no cambia.
  • null o "" en unit_price → el producto queda sin precio.
  • null o "" en category_id → el producto queda sin categoría.
  • taxes → reemplaza todos los impuestos del producto. Envía [] para quitarlos todos; si lo omites, se conservan.

Puedes enviar note para dejar una nota en la actividad del producto. Una solicitud exitosa devuelve 200 con el producto completo. Después de editar, los campos de texto sin valor llegan como "".

Requiere el permiso Crear en Productos.

Endpoint

PATCHhttps://app.credonix.mx/api/v1/products/{productId}

Path param: productId — el id del producto.

Actualización mínima


Envía solo los campos que quieras cambiar. El resto del producto queda igual.

{ "unit_price": "10.25" }

Quitar todos los impuestos


taxes reemplaza la lista completa de impuestos. Con [] el producto queda sin impuestos. Para cambiar un impuesto, envía la lista completa como quieres que quede.

{ "taxes": [] }

Quitar el precio con una nota


Con unit_price: null el producto queda sin precio. note no cambia el producto: se guarda como nota en su actividad. Como no se envió taxes, los impuestos se conservan.

{
  "unit_price": null,
  "note": "Precio por cotizar"
}

Reglas de los campos

CampoTipoRequeridoNotas
namestringNoNombre del producto/servicio. No puede estar vacío.
descriptionstring | nullNoTexto libre.
unit_pricestring | nullNoPrecio unitario como texto. Se quitan las comas y debe ser un número mayor o igual a 0. null o "" quitan el precio.
codestring | nullNoCódigo producto y/o servicio. Texto libre.
unit_codestring | nullNoUnidad de medida. Texto libre.
tariff_codestring | nullNoCódigo de tarifa. Texto libre.
customs_unitstring | nullNoUnidad de medida aduanera. Texto libre.
category_idstring | nullNoid de una categoría de tu organización. null o "" quitan la categoría.
taxesarrayNoReemplaza todos los impuestos. Cada impuesto sigue las reglas de Crear producto. [] los quita todos.
notestringNoNota para la actividad del producto. Máximo 500 caracteres.

Errores

StatusCódigoCausa
400VALIDATION_ERRORUn campo no cumple sus reglas. errors indica el campo y el motivo.
400CATEGORY_NOT_FOUNDcategory_id no es una categoría de tu organización.
401MISSING_API_KEY, INVALID_API_KEY, API_KEY_REVOKEDAPI key ausente, inválida o revocada.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Crear en Productos.
404NOT_FOUNDEl producto no existe en tu organización. Se responde antes de validar el cuerpo, con "message": "Producto no encontrado.".
Abrir Credonix