Saltar al contenido principal

GET | /

Función que Realiza

Obtiene un listado paginado de productos con filtro de búsqueda opcional.

Funcionamiento​

  • URL Completa: {domain}/api/v1/products/
  • Acción: GET
  • Requiere Api-Key?: Si
  • Requiere una Sesión?: Si
  • Recibe datos mediante: Query
    • Cantidad de datos: 3
  • Responde con contenido?: Si
  • Responde únicamente con código de estado?: No
    • Código: 200 | Ok
  • Códigos de error: Vea la sección Errores

Contenido que se recibe por Query​

page = Int (Requerido)
pageSize = Int (Requerido)
search? = String (Opcional)

Contenido que devuelve​

{
  "meta": {
    "page": Int,
    "pageSize": Int,
    "count": Int,
    "total": Int
  },
  "products": [
    {
      "id": "String",
      "code": "String",
      "description": "String"
    }
  ]
}

Códigos de Error​

HTTP CodeCustom CodeMessage
422INVALID_REQUEST_DATALos datos enviados son inválidos o insuficientes.
401INVALID_API_KEYLa API Key proporcionada no es válida.
401INVALID_SESSIONLa sesión no es válida o ha expirado.
401INSUFFICIENT_PERMISSIONSNo tienes los permisos suficientes para acceder.