Saltar al contenido principal

Listar unidades de pieza

GEThttps://carchost.fieldcontrol.com.br/part-units

Lista las unidades de pieza de la cuenta, con paginación, filtros y ordenación.

Requiere los headers X-Api-Key y User-Agent. Límite: 1 solicitud por segundo (más información).

Solicitud​

Parámetros de consulta

limitinteger

Cantidad de ítems por página.

De 1 a 100.Predeterminado: 10.

offsetinteger

Cantidad de ítems que se omiten.

De 0 a 200000.Predeterminado: 0.

qstring

Filtros en el formato campo:valor, separados por espacios (cómo filtrar). Los filtros aceptados están en la tabla de abajo.

Ejemplo: status:available partId:YjJjM2Q0ZTUtZjZhNy04OTAxLWJjZGUtZjEyMzQ1Njc4OTAxOjIyOTE1.

FiltroQué hace
code

Parte del código de la unidad, sin distinguir mayúsculas y minúsculas.

status

Situación de la unidad (p. ej. available, installed, discarded).

usageCondition

Condición de uso (new, semi_new, used, refurbished, defective).

partId

Identificador de la pieza.

storageId

Identificador del inventario.

equipmentId

Identificador del equipo en el que está instalada.

externalId

Identificador de la unidad en su sistema, exactamente igual al registrado.

archived

true para archivadas, false para activas.

sortstring

Ordenación. El prefijo - invierte el orden.

Valores aceptados: id, -id, code, -code, status, -status, value, -value, created_at, -created_at, updated_at, -updated_at.Predeterminado: id.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Respuestas

  • 200

    Lista de unidades de pieza.

  • 401

    Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

  • 403

    Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

  • 422

    Paginación u ordenación inválidas (parametersValidationErr).

  • 429

    Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

  • 500

    Error inesperado en el servidor.