Calculer un tarif

Calcule un prix avec la logique tarifaire réelle de votre compte. Requiert le scope write (méthode POST).

# Compte de reference de TOUS les exemples de cette page :
#   pricePerKg = 9 EUR (forfait jusqu'a 4 kg), minimumPrice = 7 EUR.
# Un compte sans pricePerKg (null) paierait 7 EUR le meme colis. Le tarif
# depend de VOTRE grille : appelez /rates, ne recopiez pas le chiffre.
curl -X POST "https://api.arelpro.com/pro/api/v1/rates" \
  -H "Authorization: Bearer sk_live_VOTRE_CLE" \
  -H "X-Client-Id: VOTRE_CLIENT_ID" \
  -H "Content-Type: application/json" \
  -d '{ "weight": 2.5, "deliveryAddress": { "postalCode": "75001", "city": "Paris", "countryCode": "FR" } }'

Réponse :

{
  "success": true,
  "eligible": true,
  "coverageChecked": true,
  "rate": {
    "price": 9,
    "currency": "EUR",
    "weightInKg": 2.5,
    "minimumPrice": 7,
    "pricePerKg": 9,
    "pricingModel": "professional_tiered",
    "scheduledDelivery": null
  }
}

Le tarif est sous la clé rate : il n'y a pas de champ price à la racine. Le poids vous revient sous le nom weightInKg, et non weight comme dans votre requête.

Compte de référence de ces exemples : pricePerKg: 9, minimumPrice: 7. Les prix affichés ici n'ont de sens que pour cette grille — un compte sans pricePerKg paierait 7 € le même colis de 2,5 kg. Si un autre document Arel montre un prix différent pour ce colis, c'est qu'il illustre un autre compte. Seul l'appel à /rates indique votre prix.

weight (ou parcelDetails.weight) suffit pour un devis de prix sans adresse : la réponse porte alors eligible: null et coverageChecked: false. Cela ne confirme pas que la destination est desservie. pricingModel vaut scheduled_slot, professional_tiered ou professional_minimum, selon la grille de votre compte.

{
  "success": true,
  "eligible": false,
  "error": "ZONE_NON_AUTORISEE",
  "reason": "Cette destination ne fait pas partie des zones autorisées sur votre compte.",
  "rate": null
}

Options de livraison proposées à vos acheteurs

Cet appel authentifié (scope read) renvoie le catalogue de votre compte sous deliveryOptions. AREL configure les horaires et leurs libellés. Vous gardez la main sur le prix facturé à votre acheteur : rate.price est le prix de votre prestation AREL, indépendant de votre prix de vente au checkout.

Sans créneau actif, mode vaut standard et services contient une seule option : id: "standard", serviceCode: "AREL_STANDARD", nom « Livraison AREL », deliveryWindow: null. N'affichez alors aucun horaire. Avec des créneaux actifs, mode vaut slots et chaque service contient sa fenêtre officielle : début, fin, spansNextDay et fuseau Europe/Paris.

Les devis éligibles renvoient également ce catalogue à la racine, à côté de rate. Après vérification de la destination, proposez ses services et conservez l'identifiant choisi ainsi que deliveryOptions.revision. À la création du bordereau, transmettez les deux champs deliveryOptionId et deliveryOptionsRevision. Le serveur contrôle ce choix et enregistre la fenêtre officielle sur le bordereau.

scheduledDelivery vaut null pour un envoi express. Si vous passez un créneau, il porte trois champs : date, timeSlot (le libellé normalisé) et slotId — l'id du créneau configuré sur votre compte, ou null si vous avez fourni un libellé libre du type 14h-16h.

Les deux champs ne peuvent pas être renseignés arbitrairement en même temps. Un créneau de votre compte n'est reconnu que par son id ou son libellé exact. Deux branches, deux résultats :

• vous envoyez "14h-16h" (libellé libre) → timeSlot: "14h-16h", slotId: null ;
• vous envoyez "s1" (un id de votre compte) → slotId: "s1", et timeSlot vous revient réécrit avec le libellé du créneau (par ex. "Matin") — pas la valeur que vous aviez envoyée.

Ne comparez donc jamais le timeSlot renvoyé à celui que vous avez envoyé pour vérifier le succès : sur un id, l'égalité est fausse alors que tout est correct.