Ir al contenido
ERPDocs
llms.txt

Artículos

Listar artículos

Lista los artículos por código con búsqueda por nombre, código o código de barras y filtros de estado, tipo, vistas, alícuota de IVA, marca y familia.

GET/api/v1/items/list

Permiso
items.view
Empresa
Opera sobre la empresa activa
Tipo
Lectura: no cambia nada
Respuesta
JSON

Encabezados

  • Cookietextorequerido

    La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.

  • X-Expected-Companyuuidrequerido

    La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.

Parámetros de la consulta

  • searchtextoadmite null

    hasta 120 caracteres

  • statusopción

    Valores: active inactive allPor defecto: active

  • itemTypeopciónadmite null

    Valores: resale_product finished_product productive_input non_productive_input service kit

  • isSoldsí o no
  • isPurchasedsí o no
  • tracksStocksí o no
  • vatRateIduuidadmite null
  • brandIduuidadmite null
  • familyIduuidadmite null
  • sortopción

    Valores: code relevancePor defecto: code

  • countTotalsí o no
  • pageentero

    Por defecto: 1mínimo 1

  • pageSizeentero

    Por defecto: 25mínimo 1, máximo 100

Respuesta

200 con este JSON.

  • itemslista de objetorequerido
    Campos de cada elemento (18)
    • iduuidrequerido
    • codetextorequerido
    • nametextorequerido
    • itemTypeopciónrequerido

      Valores: resale_product finished_product productive_input non_productive_input service kit

    • isSoldsí o norequerido
    • isPurchasedsí o norequerido
    • tracksStocksí o norequerido
    • stockUnitIduuidrequerido
    • unitNametextorequerido
    • vatRateIduuidrequerido
    • vatRatePercentagecualquierarequerido
    • brandIduuidrequeridoadmite null
    • brandNamecualquierarequerido
    • familyIduuidrequeridoadmite null
    • familyPathcualquierarequerido
    • statusopciónrequerido

      Valores: active inactive

    • versionenterorequerido

      mínimo 1

    • createdAtfecha y horarequerido
  • totalentero

    mínimo 0

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

401Falta la credencial o venció.
403La credencial no tiene el permiso items.view.
409La empresa activa no es la de X-Expected-Company.
422Datos inválidos o una regla de negocio rota, con el detalle por campo.
503Sistema ocupado: reintentá después de Retry-After segundos.

La lista completa está en Errores.