Skip to content
Factuplan Factuplan Documentación API para Desarrolladores | Factuplan

Productos

Maneja todas las operaciones CRUD para los productos en la API.

Endpoints

Section titled “Endpoints”

Obtener todos los productos

Section titled “Obtener todos los productos”

GET /products

Parámetros de consulta:

  • query: Parámetros de filtrado y ordenamiento (opcional)
[
  {
    "id": "f8d9f15c-1b1e-4e67-8ac1-2d89e37e1b72",
    "deletedAt": null,
    "createdAt": "2025-06-01T15:23:45.120Z",
    "updatedAt": "2025-06-01T15:23:45.120Z",
    "name": "Nombre del producto",
    "description": "Descripción del producto",
    "code": "ABC123",
    "isService": false,
    "manageStock": true,
    "currentStock": 100,
    "price": "99.99",
    "category": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Categoría ejemplo"
    },
    "priceType": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Precio minorista"
    },
    "tax": {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "name": "IVA",
      "percentage": "12.00"
    }
  }
]

Filtros

Section titled “Filtros”
CampoOperadorEjemplo
namelikeGET /products?query=filter.name__like=producto
codelikeGET /products?query=filter.code__like=ABC
categoryIdeqGET /products?query=filter.categoryId__eq=uuid
isServiceeqGET /products?query=filter.isService__eq=true

Obtener un producto por ID

Section titled “Obtener un producto por ID”

GET /products/{id}

Parámetros de URL:

  • id: ID del producto a buscar
{
  "id": "f8d9f15c-1b1e-4e67-8ac1-2d89e37e1b72",
  "deletedAt": null,
  "createdAt": "2025-06-01T15:23:45.120Z",
  "updatedAt": "2025-06-01T15:23:45.120Z",
  "name": "Nombre del producto",
  "description": "Descripción del producto",
  "code": "ABC123",
  "isService": false,
  "manageStock": true,
  "currentStock": 100,
  "price": "99.99",
  "category": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Categoría ejemplo"
  },
  "priceType": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "Precio minorista"
  },
  "tax": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "IVA",
    "percentage": "12.00"
  }
}

Crear un nuevo producto

Section titled “Crear un nuevo producto”

POST /products

{
  "name": "Nombre del producto",
  "description": "Descripción del producto",
  "code": "ABC123",
  "categoryId": "uuid-categoria",
  "priceTypeId": "uuid-tipo-precio",
  "taxId": "uuid-impuesto",
  "isService": false,
  "manageStock": true,
  "currentStock": 100,
  "companyId": "uuid-compania",
  "price": "99.99"
}

Actualizar un producto existente

Section titled “Actualizar un producto existente”

PUT /products/{id}

Parámetros de URL:

  • id: ID del producto a actualizar
{
  "name": "Nuevo nombre del producto",
  "description": "Nueva descripción del producto",
  "code": "ABC123",
  "categoryId": "uuid-categoria",
  "priceTypeId": "uuid-tipo-precio",
  "taxId": "uuid-impuesto",
  "isService": false,
  "manageStock": true,
  "currentStock": 100,
  "companyId": "uuid-compania",
  "price": "99.99"
}

Eliminar un producto

Section titled “Eliminar un producto”

DELETE /products/{id}

Parámetros de URL:

  • id: ID del producto a eliminar
No content