Filtrage et tri

Les endpoints GET qui supportent le filtrage utilisent la librairie QueryKit. Les paramètres filter et sort permettent de construire des requêtes dynamiques.

Syntaxe de filtrage

Le paramètre filter accepte des expressions combinées avec des opérateurs logiques.

Opérateurs de comparaison

Opérateur	Signification	Exemple
`==`	Égal	`articleReference == "ART001"`
`!=`	Différent	`activityCode != "ABC"`
`>`	Supérieur	`totalStockQuantity > 100`
`>=`	Supérieur ou égal	`movedQuantity >= 50`
`<`	Inférieur	`totalStockQuantity < 10`
`<=`	Inférieur ou égal	`movedQuantity <= 0`
`@=`	Contient (string)	`articleReference @= "ART"`
`_=`	Commence par	`articleReference _= "ART"`

Opérateurs logiques

Opérateur	Signification	Exemple
`&&`	ET	`activityCode == "ABC" && totalStockQuantity > 0`
`\|\|`	OU	`movementCode == "ENT" \|\| movementCode == "SOR"`

Exemples

GET /articles?filter=articleReference _= "ART" && activityCode == "001"
GET /articles/stock?filter=totalStockQuantity > 0 && gradeCode == "STD"
GET /articles/movements?filter=movementDirection == "E" && movedQuantity >= 10

Champs filtrables par endpoint

GET /articles

Champ API	Description
`articleReference`	Référence article
`articleType`	Type (0, 1, 2)
`articleCategory`	Catégorie
`rotationClass`	Classe de rotation
`supplierReference1` à `supplierReference5`	Références fournisseur
`brandCode`, `articleFamily`, `modelCode`	Classification
`customField1` à `customField18`	Champs personnalisés

GET /articles/stock

Champ API	Description
`articleReference`	Référence article
`stockUnitID`	Code propriétaire
`activityCode`	Code activité
`stockImageExtractionDate`	Date du snapshot
`totalStockQuantity`	Quantité totale
`totalAvailableForSaleQuantity`	Quantité disponible à la vente
`totalBlockedQuantity`	Quantité bloquée
`gradeCode`	Code qualité
`articleLotNumber`	Numéro de lot

GET /articles/movements

Champ API	Description
`id`	Identifiant du mouvement
`articleReference`	Référence article
`movementTimestamp`	Date du mouvement
`movedQuantity`	Quantité déplacée
`movementDirection`	Sens (E=entrée, S=sortie)
`movementCode`	Code mouvement
`movementReason`	Motif du mouvement
`gradeCode`	Code qualité
`activityCode`	Code activité
`stockUnitID`	Code propriétaire

Syntaxe de tri

Le paramètre sort accepte une liste de champs séparés par des virgules. Préfixez par - pour un tri descendant.

GET /articles?sort=articleReference
GET /articles/stock?sort=-totalStockQuantity,articleReference
GET /articles/movements?sort=movementTimestamp,-movedQuantity