Catalogue.Article

En bref

4 opérations sur 2 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).

Opérations

Méthode	Chemin	Rôle
POST	/v2/articles	Créer l'enregistrement
GET	/v2/articles/{reference}	Lire l'enregistrement désigné
PUT	/v2/articles/{reference}	Mettre à jour l'enregistrement
DELETE	/v2/articles/{reference}	Supprimer l'enregistrement

Rôle déduit

La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.

Détail

POST /v2/articles

Créer l'enregistrement.

Corps de la requête (application/json)

Schéma ArticleDto - 81 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code	Description	Schéma de data
200	OK	ArticleDto
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X POST "https://<votre-connecteur>/v2/articles" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"reference": "…", "designation": "…", "codeFamille": "…"}'

GET /v2/articles/{reference}

Lire l'enregistrement désigné.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
reference	path	string	oui	-

Réponses

Code	Description	Schéma de data
200	OK	ArticleDto
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X GET "https://<votre-connecteur>/v2/articles/<reference>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

PUT /v2/articles/{reference}

Mettre à jour l'enregistrement.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
reference	path	string	oui	-

Corps de la requête (application/json)

Schéma ArticleDto - 81 propriétés (détail : Schémas).

Écriture partielle : seules les propriétés présentes dans le corps sont écrites (voir Conventions).

Réponses

Code	Description	Schéma de data
200	OK	ArticleDto
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X PUT "https://<votre-connecteur>/v2/articles/<reference>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"reference": "…", "designation": "…", "codeFamille": "…"}'

DELETE /v2/articles/{reference}

Supprimer l'enregistrement.

Paramètres

Nom	Emplacement	Type	Obligatoire	Description
reference	path	string	oui	-

Réponses

Code	Description	Schéma de data
200	OK	-
401	Unauthorized	-
403	Forbidden	-

Exemple

curl -s -X DELETE "https://<votre-connecteur>/v2/articles/<reference>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

Schémas

Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.

ArticleDto

ArticleDto - 81 propriétés

Propriété	Type	Notes
reference	string	nullable, Référence de l'article (AR_Ref)
designation	string	nullable, Désignation de l'article (AR_Design)
codeFamille	string	nullable, Code famille (FA_CodeFamille)
typeArticle	TypeArticle	-
raccourci	string	nullable, Raccourci de saisie (AR_Raccourci)
type	integer (int32)	Type d'article (AR_Type : 0=Standard, 1=Gamme, 2=RessourceUnitaire, 3=RessourceMultiple). ⚠️ Non modifiable si l'article est déjà mouvementé (présent dans F_DOCLIGNE).
typeNomenclature	TypeNomenclature	-
typeSuiviStock	TypeSuiviStock	-
typeEscompte	TypeEscompte	-
unitePoids	UnitePoids	-
poidsNet	number (double)	Poids net (AR_PoidsNet)
poidsBrut	number (double)	Poids brut (AR_PoidsBrut)
idUniteVente	integer (int32)	Unité de vente (AR_UniteVen)
delaiLivraison	integer (int32)	Délai de livraison en jours (AR_Delai)
garantie	integer (int32)	Garantie en mois (AR_Garantie)
prixAchat	number (double)	Prix d'achat (AR_PrixAch)
prixUnitaireNet	number (double)	Prix unitaire net (AR_PUNet)
prixVente	number (double)	Prix de vente (AR_PrixVen)
coefficient	number (double)	Coefficient multiplicateur (AR_Coef)
prixEnTTC	boolean	Prix en TTC (AR_PrixTTC)
statistique1	string	nullable, Statistique 1 (AR_Stat01)
statistique2	string	nullable, Statistique 2 (AR_Stat02)
statistique3	string	nullable, Statistique 3 (AR_Stat03)
statistique4	string	nullable, Statistique 4 (AR_Stat04)
statistique5	string	nullable, Statistique 5 (AR_Stat05)
langue1	string	nullable, Désignation en langue 1 (AR_Langue1)
langue2	string	nullable, Désignation en langue 2 (AR_Langue2)
codeEDI	string	nullable, Code EDI (AR_CodeEDI)
codeBarres	string	nullable, Code barres (AR_CodeBarre)
photo	string	nullable, Chemin de la photo (AR_Photo)
idCatalogue1	integer (int32)	Catalogue 1 (CL_No1 - int en base, élargi depuis short : audit 2026-07-06)
idCatalogue2	integer (int32)	Catalogue 2 (CL_No2)
idCatalogue3	integer (int32)	Catalogue 3 (CL_No3)
idCatalogue4	integer (int32)	Catalogue 4 (CL_No4)
idGamme1	integer (int32)	Gamme 1 pour les articles gammes (AR_Gamme1)
idGamme2	integer (int32)	Gamme 2 pour les articles gammes (AR_Gamme2)
horsStatistique	boolean	Article hors statistique (AR_HorsStat)
venteAuDebit	boolean	Vente au débit (AR_VteDebit)
nonImpression	boolean	Non impression sur documents (AR_NotImp)
contremarque	boolean	Article en contremarque (AR_Contremarque)
facturationPoids	boolean	Facturation au poids (AR_FactPoids)
facturationForfait	boolean	Facturation au forfait (AR_FactForfait)
transfere	boolean	Article transféré (AR_Transfere)
publie	boolean	Article publié sur site marchand (AR_Publie)
sommeil	boolean	Article en sommeil (AR_Sommeil)
informationsLibres	object	nullable, Informations libres gérées via InfosLibresController
createur	string	nullable, Créateur de l'enregistrement (cbCreateur)
dateModification	string (date-time)	Date de modification (AR_DateModif)
dateCreation	string (date-time)	Date de création (cbMarq)
utilisateurCreateur	string	nullable, Utilisateur créateur (cbCreateur)
autorisationModificationNomenclatureEnSaisie	boolean	Autorisation modification nomenclature en saisie
interdireCommande	boolean	Interdire commande (AR_InterdireCommande)
exclureReapprovisionnement	boolean	Exclure du réapprovisionnement (AR_Exclure)
substitut	string	nullable, Article de substitution (AR_Substitut)
modeleVente	string	nullable, Intitulé du modèle d'impression Vente (IBOModele2). Écriture seule (non stocké tel quel dans F_ARTICLE).
modeleAchat	string	nullable, Intitulé du modèle d'impression Achat (IBOModele2). Écriture seule (non stocké tel quel dans F_ARTICLE).
modeleStock	string	nullable, Intitulé du modèle d'impression Stock (IBOModele2). Écriture seule (non stocké tel quel dans F_ARTICLE).
modeleInterne	string	nullable, Intitulé du modèle d'impression Interne (IBOModele2). Écriture seule (non stocké tel quel dans F_ARTICLE).
modeleComptoir	string	nullable, Intitulé du modèle d'impression Comptoir (IBOModele2). Écriture seule (non stocké tel quel dans F_ARTICLE).
modeleTousDomaine	string	nullable, Intitulé du modèle d'impression Tous domaines (IBOModele2). Écriture seule (non stocké tel quel dans F_ARTICLE).
codeFiscal	string	nullable, Code fiscal (AR_CodeFiscal)
pays	string	nullable, Pays (AR_Pays)
saisieVariable	boolean	Saisie variable (AR_SaisieVar)
coutStandard	number (double)	nullable, Coût standard (AR_CoutStd)
quantiteCompose	number (double)	nullable, Quantité composé pour fabrication (AR_QteComp)
quantiteOperatoire	number (double)	nullable, Quantité opératoire (AR_QteOperatoire)
prevision	boolean	Nomenclature en réappro/prévision (AR_Prevision)
nature	Nature	-
typeLancement	TypeLancement	-
delaiFabrication	integer (int32)	nullable, Délai de fabrication (AR_DelaiFabrication)
nombreColis	integer (int32)	nullable, Nombre de colis (AR_NbColis)
delaiPeremption	integer (int32)	nullable, Délai de péremption (AR_DelaiPeremption)
delaiSecurite	integer (int32)	nullable, Délai de sécurité (AR_DelaiSecurite)
fictif	boolean	Article fictif (AR_Fictif)
sousTraitance	boolean	Sous-traitance (AR_SousTraitance)
idConditionnement	integer (int32)	Conditionnement (AR_Condition)
cycle	Cycle	-
criticite	Criticite	-
fraisFixe1	FraisFixeDto	-
fraisFixe2	FraisFixeDto	-
fraisFixe3	FraisFixeDto	-

Voir aussi

• Démarrer avec l'API v2
• Conventions de payload
• Tous les groupes

Écrans qui utilisent ce groupe

• Articles et familles
• Assistant IA
• Gammes, nomenclatures, séries et conditionnements
• Panier et documents en cours
• Saisir un document
• Tableau de bord