CredonixDocs
Referencia de la APIProductos

Consultar

Consulta la información, la categoría y los impuestos de un producto.

Descripción general

Este endpoint devuelve un producto de tu organización con su categoría y sus impuestos. Si el id no existe o pertenece a otra organización, la API responde 404.

Requiere el permiso Leer en Productos.

Endpoint

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

Path param: productId — el id del producto.

Consulta un producto


Devuelve el producto completo. Un producto sin categoría llega con category: null y uno sin impuestos con taxes: [].

Campos de la respuesta

CampoTipoDescripción
idstringIdentificador del producto.
namestringNombre del producto/servicio.
descriptionstring | nullDescripción.
unit_pricestring | nullPrecio unitario, sin decimales fijos ("1234.5", "10.25"). null si no tiene precio.
codestring | nullCódigo producto y/o servicio.
unit_codestring | nullUnidad de medida.
tariff_codestring | nullCódigo de tarifa.
customs_unitstring | nullUnidad de medida aduanera.
categoryobjeto | nullCategoría interna, con id y name. null si el producto no tiene categoría.
taxesarrayImpuestos del producto. Ver abajo.
created_atstringFecha de creación, ISO 8601.
updated_atstringFecha de la última modificación, ISO 8601.

Los campos de texto sin valor llegan en null en un producto recién creado y como "" después de editarlo.

taxes

CampoTipoDescripción
typestringiva, isr o ieps.
categorystringtransferred (trasladado), withheld (retenido) o exempt (exento).
percentagestringPorcentaje del impuesto en puntos porcentuales: "16" es 16 %.

Errores

StatusCódigoCausa
401MISSING_API_KEY, INVALID_API_KEY, API_KEY_REVOKEDAPI key ausente, inválida o revocada.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Leer en Productos.
404NOT_FOUNDEl producto no existe en tu organización. La respuesta incluye "message": "Producto no encontrado.".
Abrir Credonix