Listado de items

Endpoint que permite consultar los productos o servicios registrados en la aplicación

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Desde cual producto/servicio se quiere consultar. Por ejemplo para consultar desde el producto/servicio 20, se envía start=20.

integer

Cantidad de productos/servicios a partir del inicio que se desea retornar. Por defecto retorna 30 productos/servicios. Si este valor es mayor que 30, la aplicación retorna error.

string

Orden ascendente o descendente en el cual se quieren retornar los productos/servicios. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).

string

Campo por el cual se desea ordenar, las opciones posibles son name, id, reference, description.

string

Cadena de texto que se quiere utilizar para buscar los productos/servicios que en su nombre o referencia contienen dicho texto. Por ejemplo si se desea buscar los productos/servicios que contengan la palabra cuaderno, se envía query=cuaderno.

boolean

Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían los productos. Actualmente la información que se envía en metadata incluye el total de productos que tiene registrada la empresa.

string

Identificador de bodega/almacén. Si se especifica este parámetro se retornan únicamente los productos no inventariables y los inventariables que estén en la bodega/almacén.

string

Nombre del producto o servicio. Longitud máxima permitida: 150.

string

Para Costa Rica, el atributo reference es un objeto compuesto por los siguientes atributos: type(string) tipo de referencia. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic aquí. reference (string) código de referencia establecido para el producto.

string

Array de objetos que indica las listas de precio asociadas al producto o servicio. Los objetos deben contener: idPriceList (number, obligatorio):identificador de la lista de precios; price (double) : precio en la lista. Para indicar el precio general del producto/servicio se puede enviar únicamente un objeto con atributo de price. Para listas de precio de porcentaje se puede omitir el atributo price. Si no se desea asociar el producto/servicio a una lista de precios se puede enviar el precio del producto o servicio directamente.

string

Descripción del producto o servicio. Longitud máxima permitida: 500.

string

Filtrar por el id de la lista de precios.

string

Identificador de categoría de ítem. Si se especifica este parámetro se retornan únicamente los productos asociados a la categoría.

string

Indica el tipo de producto. Las opciones posibles son simple o kit

string

Identificador de atributo variante. Si se especifica este parámetro se retornan únicamente los productos que tengan el atributo variante enviado como parámetro.

string

Identificador de la opción de un atributo variante. Si se especifica este parámetro se retornan únicamente los productos que tengan la opción enviada como parámetro.

string

Identificador del item con variantes (item padre). Si se especifica este parámetro se retornan únicamente los productos que sean variantes (hijos) del item padre..

string

Identificador del campo adicional. Si se especifica este parámetro se retornan únicamente los productos que tengan el campo adicional especificado.

string

Valor del campo adicional. Si se especifica este parámetro se retornan únicamente los productos que tengan el valor especificado en el campo adicional. Este parámetro depende el parámetro customField_id

string

Estado del producto o servicio, las opciones posibles son: active o inactive. Se debe tener en cuenta que un producto o servicio que se encuentre inactivo no se puede editar; si se desea editar, se debe enviar entre los atributos que se van a editar el estado en active.

boolean

Filtrar items inventariables, envía true si deseas obtener únicamente items inventariables.

string

Identificador de atributos que se desean obtener en la respuesta separados por coma (,). Ej: variantAttributes (si se desean obtener atributos variantes),itemVariants (si se desean obtener items variantes),ledger (si se desea obtener la contabilidad del item).

enum

El modo simple permite traer los items excluyendo los siguientes atributos: category, attachments, customFields, itemCategory, inventory(solo con la unidad dentro) e images; para los items de tipo combo se excluye también subitems, kitWarehouse; para los items con variantes: itemVariants y para los items variantes: variantAttributes. El modo avanzado retorna el item sin excluir ninguno de los atributos.

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json