Parametres.Vente.Expedition¶
En bref
8 opérations sur 4 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations¶
| Méthode | Chemin | Rôle |
|---|---|---|
GET |
/v2/expedition |
Lister les enregistrements |
POST |
/v2/expedition |
Créer l'enregistrement |
PUT |
/v2/expedition |
Mettre à jour l'enregistrement |
DELETE |
/v2/expedition |
Supprimer l'enregistrement |
GET |
/v2/expedition/count |
Compter les enregistrements |
POST |
/v2/expedition/count |
Compter les enregistrements |
POST |
/v2/expedition/recherche |
Rechercher des enregistrements |
POST |
/v2/expedition/save |
Créer ou mettre à jour l'enregistrement (upsert) |
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¶
GET /v2/expedition¶
Lister les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
sort |
query | string |
non | — |
where |
query | string |
non | — |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/expedition?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/expedition¶
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma ExpeditionDto — 11 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 | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/expedition" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "modeTransport": "…"}'
PUT /v2/expedition¶
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma ExpeditionDto — 11 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 | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X PUT "https://<votre-connecteur>/v2/expedition" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "modeTransport": "…"}'
DELETE /v2/expedition¶
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma ExpeditionDto — 11 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 | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X DELETE "https://<votre-connecteur>/v2/expedition" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "modeTransport": "…"}'
GET /v2/expedition/count¶
Compter les enregistrements.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
where |
query | string |
non | — |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/expedition/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/expedition/count¶
Compter les enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/expedition/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/expedition/recherche¶
Rechercher des enregistrements.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/expedition/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/expedition/save¶
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma ExpeditionDto — 11 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 | — |
401 |
Unauthorized | — |
403 |
Forbidden | — |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/expedition/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "intitule": "…", "modeTransport": "…"}'
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.
ExpeditionDto¶
ExpeditionDto — 11 propriétés
| Propriété | Type | Notes |
|---|---|---|
id |
integer (int32) |
— |
intitule |
string |
nullable |
modeTransport |
string |
nullable |
referenceArticleFrais |
string |
nullable |
typeFrais |
integer (int32) |
— |
valeurFrais |
number (double) |
— |
fraisTTC |
boolean |
— |
typeFranco |
integer (int32) |
— |
valeurFranco |
number (double) |
— |
francoTTC |
boolean |
— |
typeCalcul |
integer (int32) |
— |