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 |
designation |
string |
nullable |
codeFamille |
string |
nullable |
typeArticle |
TypeArticle |
— |
raccourci |
string |
nullable |
type |
integer (int32) |
— |
typeNomenclature |
TypeNomenclature |
— |
typeSuiviStock |
TypeSuiviStock |
— |
typeEscompte |
TypeEscompte |
— |
unitePoids |
UnitePoids |
— |
poidsNet |
number (double) |
— |
poidsBrut |
number (double) |
— |
idUniteVente |
integer (int32) |
— |
delaiLivraison |
integer (int32) |
— |
garantie |
integer (int32) |
— |
prixAchat |
number (double) |
— |
prixUnitaireNet |
number (double) |
— |
prixVente |
number (double) |
— |
coefficient |
number (double) |
— |
prixEnTTC |
boolean |
— |
statistique1 |
string |
nullable |
statistique2 |
string |
nullable |
statistique3 |
string |
nullable |
statistique4 |
string |
nullable |
statistique5 |
string |
nullable |
langue1 |
string |
nullable |
langue2 |
string |
nullable |
codeEDI |
string |
nullable |
codeBarres |
string |
nullable |
photo |
string |
nullable |
idCatalogue1 |
integer (int32) |
— |
idCatalogue2 |
integer (int32) |
— |
idCatalogue3 |
integer (int32) |
— |
idCatalogue4 |
integer (int32) |
— |
idGamme1 |
integer (int32) |
— |
idGamme2 |
integer (int32) |
— |
horsStatistique |
boolean |
— |
venteAuDebit |
boolean |
— |
nonImpression |
boolean |
— |
contremarque |
boolean |
— |
facturationPoids |
boolean |
— |
facturationForfait |
boolean |
— |
transfere |
boolean |
— |
publie |
boolean |
— |
sommeil |
boolean |
— |
informationsLibres |
object |
nullable |
createur |
string |
nullable |
dateModification |
string (date-time) |
— |
dateCreation |
string (date-time) |
— |
utilisateurCreateur |
string |
nullable |
autorisationModificationNomenclatureEnSaisie |
boolean |
— |
interdireCommande |
boolean |
— |
exclureReapprovisionnement |
boolean |
— |
substitut |
string |
nullable |
modeleVente |
string |
nullable |
modeleAchat |
string |
nullable |
modeleStock |
string |
nullable |
modeleInterne |
string |
nullable |
modeleComptoir |
string |
nullable |
modeleTousDomaine |
string |
nullable |
codeFiscal |
string |
nullable |
pays |
string |
nullable |
saisieVariable |
boolean |
— |
coutStandard |
number (double) |
nullable |
quantiteCompose |
number (double) |
nullable |
quantiteOperatoire |
number (double) |
nullable |
prevision |
boolean |
— |
nature |
Nature |
— |
typeLancement |
TypeLancement |
— |
delaiFabrication |
integer (int32) |
nullable |
nombreColis |
integer (int32) |
nullable |
delaiPeremption |
integer (int32) |
nullable |
delaiSecurite |
integer (int32) |
nullable |
fictif |
boolean |
— |
sousTraitance |
boolean |
— |
idConditionnement |
integer (int32) |
— |
cycle |
Cycle |
— |
criticite |
Criticite |
— |
fraisFixe1 |
FraisFixeDto |
— |
fraisFixe2 |
FraisFixeDto |
— |
fraisFixe3 |
FraisFixeDto |
— |