Tiers.AdresseLivraison
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/adresselivraison |
Lister les enregistrements |
POST |
/v2/adresselivraison |
Créer l'enregistrement |
PUT |
/v2/adresselivraison |
Mettre à jour l'enregistrement |
DELETE |
/v2/adresselivraison |
Supprimer l'enregistrement |
GET |
/v2/adresselivraison/count |
Compter les enregistrements |
POST |
/v2/adresselivraison/count |
Compter les enregistrements |
POST |
/v2/adresselivraison/recherche |
Rechercher des enregistrements |
POST |
/v2/adresselivraison/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/adresselivraison
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/adresselivraison?sort=<sort>&where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/adresselivraison
Créer l'enregistrement.
Corps de la requête (application/json)
Schéma AdresseLivraisonDto - 25 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/adresselivraison" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "numeroTiers": "…", "idModeExpedition": 0}'
PUT /v2/adresselivraison
Mettre à jour l'enregistrement.
Corps de la requête (application/json)
Schéma AdresseLivraisonDto - 25 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/adresselivraison" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "numeroTiers": "…", "idModeExpedition": 0}'
DELETE /v2/adresselivraison
Supprimer l'enregistrement.
Corps de la requête (application/json)
Schéma AdresseLivraisonDto - 25 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/adresselivraison" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "numeroTiers": "…", "idModeExpedition": 0}'
GET /v2/adresselivraison/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/adresselivraison/count?where=<where>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/adresselivraison/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/adresselivraison/count" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/adresselivraison/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/adresselivraison/recherche" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/adresselivraison/save
Créer ou mettre à jour l'enregistrement (upsert).
Corps de la requête (application/json)
Schéma AdresseLivraisonDto - 25 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/adresselivraison/save" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"id": 0, "numeroTiers": "…", "idModeExpedition": 0}'
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.
AdresseLivraisonDto
AdresseLivraisonDto - 25 propriétés
| Propriété | Type | Notes |
|---|---|---|
id |
integer (int32) |
Obtient ou définit l'identifiant unique de l'adresse de livraison. |
numeroTiers |
string |
nullable, Obtient ou définit le numéro du tiers propriétaire de cette adresse de livraison. |
idModeExpedition |
integer (int32) |
Obtient ou définit l'identifiant du mode d'expédition pour cette adresse. |
idConditionLivraison |
integer (int32) |
Obtient ou définit l'identifiant de la condition de livraison. |
delaiTransport |
integer (int32) |
Obtient ou définit le délai de transport en jours pour cette adresse. |
intitule |
string |
nullable, Obtient ou définit l'intitulé descriptif de l'adresse de livraison. |
contact |
string |
nullable, Obtient ou définit le nom du contact pour cette adresse de livraison. |
adresse |
string |
nullable, Obtient ou définit la première ligne de l'adresse. |
complement |
string |
nullable, Obtient ou définit le complément d'adresse. |
codePostal |
string |
nullable, Obtient ou définit le code postal de l'adresse. |
ville |
string |
nullable, Obtient ou définit la ville de l'adresse de livraison. |
region |
string |
nullable, Obtient ou définit le code de la région ou département. |
pays |
string |
nullable, Obtient ou définit le pays de l'adresse de livraison. |
telephone |
string |
nullable, Obtient ou définit le numéro de téléphone du contact. |
fax |
string |
nullable, Obtient ou définit le numéro de télécopie (fax). |
email |
string |
nullable, Obtient ou définit l'adresse email du contact. |
estPrincipale |
boolean |
Obtient ou définit une valeur indiquant si cette adresse est l'adresse de livraison principale du tiers. |
estAdresseFacturation |
boolean |
Obtient ou définit une valeur indiquant si cette adresse peut être utilisée pour la facturation. |
commentaire |
string |
nullable, Obtient ou définit les commentaires libres associés à cette adresse. |
createur |
string |
nullable, Obtient ou définit l'identifiant du créateur de l'enregistrement. |
dateModification |
string (date-time) |
Obtient ou définit la date de dernière modification de l'enregistrement. |
cbMarq |
integer (int32) |
Obtient ou définit le marqueur technique unique Sage. |
dateCreation |
string (date-time) |
Obtient ou définit la date de création de l'enregistrement. |
utilisateurCreateur |
string |
nullable, Obtient ou définit l'identifiant GUID de l'utilisateur créateur. |
informationsLibres |
object |
nullable, Obtient ou définit le dictionnaire des informations libres associées à cette adresse. |