get-products
Este método obtiene el listado de productos que el usuario tiene creados en la plataforma (se utiliza paginación para la consulta ordenada).
Notas
Si necesitas mas información sobre cómo funciona la paginación consulta la sección: Paginación
Path del método
get-products
Endpoint final
PRODUCCION
https://aceptabits.com/api/thirdparty/v1/get-products
SANDBOX DE PRUEBAS
https://sandbox.aceptabits.com/api/thirdparty/v1/get-products
Método de petición HTTP
GET
Lista de parámetros
| Parámetro | Obligatorio | Descripción | valor |
|---|---|---|---|
| page | Si | Es la página que se utilizara en la paginación de la petición | Ejemplo: 1, 2, 3, etc. Este valor debe ser numérico y entero, indicara la página actual a la cual se hará la consulta |
| limit | Si | Es el límite de elementos que se utilizara en la paginación de la petición | Ejemplo: 5, 10, 20, 50, etc. Este valor debe de ser numérico y entero, con un valor máximo posible de 100, si se envía un número mayor a 100 se realizara la consulta con el valor 100 |
| order_list | Si | Es el orden de listado para mostrar la información utilizando la fecha de creación como referencia | Se aceptan dos valores el 1 y el 2: 1 = ordenara los resultados por fecha de creación de manera ascendente 2 = ordenara los resultados por fecha de creación de manera descendente |
| code_shop | No | Es el código de la tienda a la que se requiere obtener el listado de productos en especifico | ejemplo: pgbsho0635214789653205 Este código es único de cada tienda, se obtiene al consultar el listado de tiendas o al generar una tienda nueva, consulte los métodos: get-shops, add-shop o show-shop para mas detalles |
| search | No | Se utiliza como filtro de búsqueda para la consulta de los productos, el filtro se aplicara dentro de:name code code_shop name_shopPara más información de estos campos consulta el método add-product, show-product o en esta misma seccion en Ejemplo de respuesta EXITOSA | Ejemplo: pgbpro9653365214, pgbsho6199, velas, computadora, cuaderno profesional, etc. Se puede enviar una cadena de texto, un numero o cualquier valor que se quiera utilizar como filtro |
Lista de códigos
Exitoso
| Código | Descripción |
|---|---|
| 0042 | Lista de productos obtenida con éxito |
Error
| Código | Descripción |
|---|---|
| 0000 | El Token API no es correcto y la autenticación del usuario ha fallado |
| 0003 | El Token API no es correcto y la autenticación del usuario ha fallado |
| 1205 | El Token API no es correcto y la autenticación del usuario ha fallado |
| 1350 | El orden de listado es requerido |
| 1351 | El orden de listado debe de contener un valor valido para el orden ascendente o descendente |
| 1579 | El campo página de la paginación es requerido |
| 1580 | El campo límite de la paginación es requerido |
| 1206 | El Token API no es correcto y la autenticación del usuario ha fallado |
| 1207 | Ocurrió un problema al obtener el listado de productos, inténtelo nuevamente o consulte con soporte técnico para más ayuda |
Ejemplo de respuesta EXITOSA
Exitoso
Código HTTP 200
{
"status": true,
"success": {
"code": "0042"
},
"data": {
"data": [
{
"code": "pgbpro3373249555686112",
"name": "Monitor curvo 27 pulgadas",
"price_mxn": "2000.55000000",
"code_shop": "pgbsho40996222369461182",
"name_shop": "Tienda general",
"created_at": "2024-08-03T01:15:26.000000Z",
"created_at_format": "2024-08-02 20:15:26",
"isEditable": "-1"
},
{
"code": "pgbpro4348528913927633",
"name": "Mouse inalambrico V2563",
"price_mxn": "350.00000000",
"code_shop": "pgbsho40996222369461182",
"name_shop": "Tienda general",
"created_at": "2024-08-06T21:07:34.000000Z",
"created_at_format": "2024-08-06 16:07:34",
"isEditable": "-1"
},
{
"code": "pgbpro5948375637395668",
"name": "calculadora de mano",
"price_mxn": "280.00000000",
"code_shop": "pgbsho40996222369461182",
"name_shop": "Tienda general",
"created_at": "2024-08-07T04:52:15.000000Z",
"created_at_format": "2024-08-06 23:52:15",
"isEditable": "-1"
}
],
"current_page": 1,
"last_page": 1,
"per_page": 10,
"from": 1,
"to": 3,
"total": 3
}
}
Descripción de la respuesta
- Revisar el listado de
códigos EXITOSOpara conocer el significado desuccesscode. data- Se obtiene la información de los productos y la información actual de la paginacióncurrent_page- Indica cual es la página actual en la paginaciónlast_page- Indica cual es el último número de página posible (este valor cambia dependiendo del límite de elementos por página que se envió con el parámetro limit)per_page- Indica el límite de elementos mostrados por paginafrom- indica el índice inicial de la numeración de los productos mostrado en esta paginato- indica el índice final de la numeración de los productos mostrado en esta paginatotal- Indica el número de total de elementos que existendata- Arreglo donde se listan los productos que tiene creados el usuario en la plataformacode- Código del producto (este código es único para cada producto dado de alta)name- Nombre del productoprice_mxn- Precio en MXN (Peso mexicano) del productocode_shop- Código de la tienda a la que pertenece el productoname_shop- Nombre de la tienda a la que pertenece el productocreated_at- Fecha y hora de creación del producto (UTC)created_at_format- Fecha y hora de creación del producto (America/Mexico_City)isEditable- indica si el producto se puede o no editar, los valores posibles son:- 0 = no se puede editar
- -1 = si se puede editar
Ejemplo de respuesta FALLIDA
Error
Código HTTP 400, Código HTTP 401, Código HTTP 500
{
"status": false,
"error": {
"code": "1350"
}
}
Descripción de la respuesta
- Revisar el listado de
códigos ERRORpara conocer la causa y saber cómo corregir - Si se obtiene un código HTTP
500comunicarse a soporte técnico - Si se obtiene un código HTTP
401revisar que el Token API este correcto
Notas
Si tienes alguna duda recuerda que siempre puedes contactar con el equipo de soporte para desarrolladores ingresando en el siguiente enlace: Soporte para desarrolladores.