Saltar al contenido principal

Listar productos

GEThttps://carchost.fieldcontrol.com.br/products

Lista los productos de la cuenta, con paginación y filtros. El listado se ordena por el identificador.

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: code:FIL archived:false.

FiltroQué hace
name

Parte del nombre del producto, sin distinguir mayúsculas y minúsculas. Hasta 50 caracteres.

code

Parte del código del producto, sin distinguir mayúsculas y minúsculas. Hasta 100 caracteres.

external_id

Identificador del producto en su sistema (external.id), exactamente igual al registrado.

archived

true para archivados, false para activos.

productType

Tipo del producto. Hoy este filtro se acepta pero no se aplica, y el listado devuelve productos de todos los tipos.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Respuestas

  • 200

    Lista de productos.

  • 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

    Filtro o paginación inválidos (parametersValidationErr).

  • 429

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

  • 500

    Error inesperado en el servidor.