Endpoint Productos

Lista de productos

Method: GET URI: /api/v1/productos

Este endpoint permite obtener un listado de productos según los parámetros de búsqueda y ordenación.

Request

• Headers
  • Content-Type: application/json
  • token: <string>
  • secret:<string>
• Params
  • sort_column: campo por el que ordenar. Podrá ser: referencia o nombre. Por defecto será referencia.
  • sort_type: indica el si la ordenación es ascendente o descendente. Podrá ser: asc o desc. Por defecto será asc.
  • paginate_by: número de registros a mostrar. El mínimo será 1 y el máximo 100. Por defecto serán 10.
  • page: número de página a mostrar. Por defecto será 1.
  • referencia: valor a buscar en el campo referencia. La búsqueda se hará con un contiene.
  • nombre: valor a buscar en el campo nombre. La búsqueda se hará con un contiene.
  • cb: valor a buscar en el campo código de barras. La búsqueda se hará de forma exacta.
  • familia_id: id a buscar en el campo familia. La búsqueda se hará de forma exacta.
  • marca_id: id a buscar en el campo marca. La búsqueda se hará de forma exacta.
  • seccion_id: id a buscar en el campo seccion. La búsqueda se hará de forma exacta.
  • temporada_id: id a buscar en el campo temporada. La búsqueda se hará de forma exacta.

Response 1: 200: existen datos

{
 "status": 200,
 "page": 1,
 "paginate_by": 10,
 "records": 1000,
 "data": [
   {
     "id": 1,
     "referencia": "001",
     "nombre": "producto uno",
     "codigo_barras": "8444400003247",
     "familia": {
       "id": 1,
       "nombre": "familia uno"
     },
     "marca": {
       "id": 4,
       "nombre": "marca cuatro"
     },
     "seccion": {
       "id": 8,
       "nombre": "sección ocho"
     },
     "temporada": {
       "id": 5,
       "nombre": "temporada cinco"
     },
     "precio_costo": 20.00,
     "precio_venta": 30.00,
     "tipo_iva": {
       "id": 1,
       "iva": 21.00,
       "re": 5.20
     },
     "stock": 158.00
   },
   {
     "id": 2,
     "referencia": "002",
     "nombre": "producto dos",
     "codigo_barras": "8444400000963",
     "familia": {
       "id": 3,
       "nombre": "familia tres"
     },
     "marcar": {
       "id": 4,
       "nombre": "marca cuatro"
     },
     "seccion": {
       "id": 1,
       "nombre": "sección uno"
     },
     "temporada": {
       "id": 5,
       "nombre": "temporada cinco"
     },
     "precio_costo": 12.59,
     "precio_venta": 18.63,
     "tipo_iva": {
       "id": 2,
       "iva": 10.00,
       "re": 1.4
     },
     "stock": 314.96
   },
   ...
 ]
}

Response 2: 200: no existen datos

{
  "status": 200,
  "page": 1,
  "paginate_by": 10,
  "records": 0,
  "data": []
}

Response 3: 400: petición errónea

{
  "status": 400,
  "error": "Error en la Petición"
}

Response 4: 402: petición no autorizada

{
  "status": 402,
  "error": "No autorizado"
}

Prueba la API de tu instalación aquí

Detalle de producto

Method: GET URI: /api/v1/productos

Este endpoint permite obtener el detalle del producto cuyo id coincide con el parámetro suministrado.

Request

• Headers
  • Content-Type: application/json
  • token: <string>
  • secret:<string>
• Params
  • id: identificador del producto a mostrar.

Response 1: 200: existen datos

{
 "status": 200,
 "data": {
   "id": 10,
   "referencia": "010",
   "nombre": "producto diez",
   "codigo_barras": "8444400003247",
   "proveedor": {
     "id": 3,
     "codigo": "003",
     "razon_fiscal": "proveedor tres"
   },
   "tipo_producto": {
     "id": 5,
     "nombre": "tipo producto cinco",
     "uso": "Material"
   },
   "familia": {
     "id": 17,
     "nombre": "familia uno"
   },
   "marca": {
     "id": 4,
     "nombre": "marca cuatro"
   },
   "seccion": {
     "id": 8,
     "nombre": "sección ocho"
   },
   "temporada": {
     "id": 5,
     "nombre": "temporada cinco"
   },
   "lote": {
     "tratamiento_lotes": 1,
     "caracteristica": {
       "id": 1,
       "nombre": "características"
     },
     "lote_defecto": null
   },
   "descripcion": "descripción del producto",
   "observaciones": "observaciones del producto",
   "descripcion_ampliada": "descripción ampliada del producto",
   "precio_costo": 20.00,
   "precio_venta": 30.00,
   "tipo_iva": {
     "id": 1,
     "iva": 21.00,
     "re": 5.20
   },
   "origen": "N",
   "destino": "N",
   "margenes": [
     {
       "id": 1,
       "tipo": "P",
       "cantidad": 20.00
     },
     {
       "id": 2,
       "tipo": "F",
       "cantidad": 5.00
     },
     ...
   ],
   "tarifas": [
     {
       "id": 1,
       "nombre": "tarifa A",
       "tipo": "margen",
       "descuento": 10.00,
       "margen": 30.00,
       "importe": 27.00
     },
     {
       "id": 2,
       "nombre": "tarifa B",
       "tipo": "descuento",
       "descuento": 15.00,
       "margen": 27.50,
       "importe": 25.50
     },
     ...
   ],
   "magnitudes": [
     {
       "id": 1,
       "nombre": "unidades",
       "ratio": 1,
       "defecto": 1
     },
     {
       "id": 1,
       "nombre": "metros",
       "ratio": 3,
       "defecto": 0
     },
     ...
   ],
   "variantes": {
     "es_padre": "1",
     "padre_variante": {
       "id": 1,
       "nombre": "producto padre"
     },
     "1": {
       "descripcion": "tallas",
       "valor": "M"
     },
     "2": {
       "descripcion": "color",
       "valor": "blanco"
     },
     "3": {}
   },
   "stock_total": 158.00
 }
}

Response 2: 404: no existen datos

{
  "status": 404,
  "error": "Producto no existe"
}

Response 3: 400: petición errónea

{
  "status": 400,
  "error": "Error en la Petición"
}

Response 4: 402: petición no autorizada

{
  "status": 402,
  "error": "No autorizado"
}

Prueba la API de tu instalación aquí