Skip to main content

API Création d'un Regroupement de Clients

Usage​

Permet à un Partenaire de créer un Regroupement de Clients ou un sous-Regroupement de Clients (en précisant le parent).

Endpoint : POST /publishers

Paramètres du BODY​

ChampsTypeOblig ?Commentaire
publisher_idstringOUICode = Identifiant unique du Regroupement de Clients à créer. Taille : jusqu'à 46 caractères. Regex : [A-Za-z0-9-]
siren_siretstringOUILe numéro Siren/Siret sera validé avec l'algorithme de Luhn. Taille : 9 ou 14 caractères
legal_namestringOUIRaison sociale. Taille : jusqu'à 50 caractères. Regex : ^[a-zA-Z0-9çéèàùâêîôûäëïöüñÿÇÄÂÀËÊÈÉÏÎÖÔÜÛÙŸÑ'"\-&\*/\s\.]+$
vat_numberstringNONNuméro de TVA intracommunautaire. Taille : jusqu'à 32 caractères. Regex : ^$|^([A-Z]{2} ?[0-9]{2} ?([0-9]{9}))$
parent_publisher_idstringNONCode du Regroupement de Clients auquel le nouveau Regroupement de Clients doit être rattaché. Si non renseigné, le nouveau Regroupement de Clients sera créé directement sous le plus haut Regroupement de Clients du Partenaire

Exemple de requête​

curl --location 'https://api.laposte.fr/digiposte/v3/publishers/' \
--header 'Authorization: bearer UA15MZm3B4bYmsmdfwQsSDsoe0g' \
--header 'X-Okapi-Key: CT5hp0tcjLhA16LWO3cKRJBgKxybktR5HtnKLtMpyqQuG87+ZXBvsu286QmyT9aH' \
--header 'Content-Type: application/json' \
--data '{
"publisher_id": "88-DEMODGP",
"legal_name": "REGROUPEMENT ABC",
"siren_siret": "35600000000048",
"parent_publisher_id": "88",
"vat_number": "FR39356000000"
}'

Règles de gestion​

  • Le Partenaire doit être authentifié et disposer des droits nécessaires pour utiliser cette API.
  • Le code du Regroupement de Clients à créer doit être unique et ne doit pas déjà être attribué, y compris en dehors du périmètre du Partenaire.
  • La raison sociale est renseignée et valide.
  • Si un parent est renseigné, il doit correspondre à un Regroupement de Clients accessible dans le périmètre du Partenaire.
  • Si aucun parent n'est renseigné, le nouveau Regroupement de Clients est créé directement sous le Distributeur de rattachement du Partenaire.
  • Tous les champs obligatoires sont renseignés et tous les champs transmis respectent les formats attendus.
  • Effet attendu : le Regroupement de Clients est créé dans Digiposte.

Retour en cas de succès​

  • Code retour : 204 No Content
  • Body : vide

Règles métier et cas d'erreur​

Cas d'erreur (si plusieurs erreurs, les libellés sont présents dans le champ error_label séparés par des points-virgules) :

Cas d'erreurCode retour
Token expiré401 Unauthorized : "Unauthorized user"
Le Partenaire n'a pas les droits d'utiliser cette API403 Forbidden : "Your account cannot access to this resource"
Le code du Regroupement de Clients est manquant400 Bad Request : "publisher_id is required"
La raison sociale est manquante400 Bad Request : "legal_name is required"
Le code du Regroupement de Clients ne respecte pas le format attendu ou dépasse la taille maximale400 Bad Request : "publisher_id size must be between 0 and 46 and match ^[-' 0-9a-zA-Z]+$"
Le code parent correspond à un Client au lieu d'un Regroupement de Clients400 Bad Request : "Parent publisher is not a publisher"
Le code parent n'existe pas dans le périmètre du Partenaire404 Not Found : "parent_publisher_id <parent_publisher_id> not found"
La raison sociale ne respecte pas le format attendu400 Bad Request : "legal_name must match ^[a-zA-Z0-9çéèàùâêîôûäëïöüñÿÇÄÂÀËÊÈÉÏÎÖÔÜÛÙŸÑ'\"\-&\*/\s\.]+$"
La raison sociale dépasse la taille maximale400 Bad Request : "legal_name size must be between 0 and 50"
Le siren_siret ne respecte pas le format attendu ou l'algorithme de Luhn400 Bad Request : "siren_siret must match the Luhn algorithm"
Le numéro de TVA ne respecte pas le format attendu400 Bad Request : "vat_number must match ^$|^([A-Z]{2} ?[0-9]{2} ?([0-9]{9}))$"
Le code Regroupement de Clients est déjà attribué409 Conflict : "Publisher_id already exists"

Documentation API​

Créer un Regroupement de Clients

POST 

/publishers

Permet à un Partenaire de créer un Regroupement de Clients ou un sous-Regroupement de Clients (en précisant le parent).

Règles de gestion​

  • Le code du Regroupement de Clients à créer doit être unique et ne doit pas déjà être attribué, y compris en dehors du périmètre du Partenaire.
  • Si un parent est renseigné, il doit correspondre à un Regroupement de Clients accessible dans le périmètre du Partenaire.
  • Si aucun parent n'est renseigné, le nouveau Regroupement de Clients est créé directement sous le Distributeur de rattachement du Partenaire.

Request​

Responses​

Le Regroupement de Clients est créé dans Digiposte.