V1.0.0 Stable

Documentation API Arel Pro

Créez des envois, consultez les tarifs et recevez les événements de suivi. Parcourez section par section.

Endpoints · Zones de livraison

Consulter vos zones de livraison

Affichez les zones attribuées à votre compte par AREL et les sous-zones exclues dans votre application.

GET/delivery-zones

Cet appel requiert votre clé API avec la permission read et votre en-tête X-Client-Id. Il renvoie uniquement les affectations du compte authentifié, sans paramètre à fournir. Il ne crée aucune livraison ni aucun portefeuille.

bash
curl "https://api.arelpro.com/pro/api/v1/delivery-zones" \
  -H "Authorization: Bearer sk_live_VOTRE_CLE" \
  -H "X-Client-Id: VOTRE_CLIENT_ID"

Exemple de réponse HTTP 200 :

json
{
  "success": true,
  "deliveryCoverage": {
    "status": "configured",
    "zones": [
      { "id": "Z01", "name": "Paris" }
    ],
    "blockedSubZones": [],
    "referenceVersion": "VERSION_DU_REFERENTIEL",
    "revision": 3
  }
}

Zones et exclusions

Champ de deliveryCoverageSignification
zonesZones attribuées : code id et nom name. Le nombre de zones est zones.length.
blockedSubZonesSous-zones exclues : code id, zone mère zoneId et nom name.
referenceVersionVersion du référentiel géographique. Utilisez la valeur renvoyée, sans la coder en dur.
revisionRévision des affectations, mise à jour quand AREL modifie les zones du compte.

Une sous-zone exclue reste indisponible même si sa zone mère figure dans zones. Une exclusion peut rester enregistrée après le retrait de sa zone mère pour être conservée à sa réouverture. AREL gère ces affectations : contactez votre interlocuteur pour demander une ouverture.

Distinguer une liste vide d’une indisponibilité

RéponseTraitement
200 · configuredAffectations configurées. Une liste zones: [] signifie qu’aucune zone n’est attribuée.
200 · unconfiguredAffectations pas encore définies par AREL. Les deux listes sont vides et la révision vaut 0.
503 · COVERAGE_UNAVAILABLELecture indisponible. Réessayez ; ne remplacez pas vos affectations par une liste vide.
json
{
  "success": false,
  "error": "COVERAGE_UNAVAILABLE",
  "message": "La lecture de vos zones de livraison est momentanément indisponible. Réessayez ou contactez AREL."
}

Les erreurs d’authentification habituelles s’appliquent : HTTP 401 pour une clé absente, invalide ou expirée, ou un Client ID absent ; HTTP 403 si le Client ID ne correspond pas à la clé ou si la permission read manque, et HTTP 429 en cas de dépassement de la limite d’appels.

Chaque appel lit les affectations actuelles et renvoie Cache-Control: no-store. Rechargez-les à l’ouverture de votre écran ou de votre sélecteur. Le même contenu reste disponible dans GET /account, sous account.deliveryCoverage.

Vérifier chaque adresse au checkout

Cette liste permet de présenter votre couverture. Pour confirmer qu’une adresse est actuellement desservie, appelez POST /rates avec le code postal, la commune et le pays. Proposez AREL uniquement si eligible === true. Les zones sont à nouveau vérifiées lors de la création du bordereau.

Pour un parcours atelier, vérifiez la destination de chacune des deux courses : l’atelier à l’aller, puis l’adresse du client au retour.

Vous êtes un particulier ?

L'application Arel envoie vos biens.

Un bien à faire parvenir à quelqu'un, livré le jour même par la communauté. Suivi et remise sécurisée dans l'application.

Découvrir l'application