Toutes les collections
API
Get Rates API
Comment fonctionne l'API Get Rates
Comment fonctionne l'API Get Rates

Tout savoir sur l'appel API Get Rates

Mis à jour il y a plus d’une semaine

Cette méthode récupère les tarifs de Transporteur pour un envoi spécifique pour plus de 170 Transporteurs avec un seul appel API.

💡Avec cette méthode, vous pouvez :

  • Récupérer tous les tarifs de votre Transporteur en temps réel

  • Comparer vos tarifs de Transporteur pour choisir les meilleures options pendant la préparation de la commande

  • Améliorer le taux de conversion en affichant les tarifs en temps réel au paiement de la commande

  • Appliquer une majoration en plus de vos frais d'expédition

Table des matières

1. Avant de commencer

Pour effectuer des tests, vous pouvez utiliser le Transporteur ShippyPro générique afin de générer des tarifs test. Consultez cet article si vous avez besoin d'aide pour configurer un Transporteur générique ShippyPro.

📌 Vous pouvez également ajouter l'attribut CarrierOptions afin d'obtenir des tarifs pour des services de Transporteurs spécifiques.

📌 L'API GetRates fonctionnera selon les règles d'expédition appliquées. Si votre appel GetRates vous ne vous retourne aucun tarif ou aucune erreur pour un envoi spécifique, veuillez vérifier que les règles d'expédition ont été configurées correctement et ne bloquent pas ces SKU.

📌N'oubliez pas d'entrer la valeur TransactionID de la commande dans l'API_GetRates pour utiliser la règle du service d'expédition, ou elle sera ignorée. Si le champ TransactionID n'est pas renseigné, le filtre pour Service d'expédition ne pourra pas être appliqué.

Afin d'évaluer correctement le numéro de transaction, vous devez disposer d'un ordre préalablement importé d'une place de marché ou créé manuellement via PutOrder.

📌 Si vos tarifs GetRates ne correspondent pas aux tarifs affichés dans “À expédier”, veuillez vérifier si votre GetRates and vos Mon Profil > Unités de mesure de préférence correspondent !

📌 En renvoyant le RateID de la réponse à l'appel API d'expédition, vous pourrez également utiliser notre fonction d'analyse des factures. (cette fonction n'est pas prise en charge par tous les transporteurs. Veuillez demander à notre équipe si le coursier que vous souhaitez utiliser prend en charge cette fonction.)

📌Vous pouvez filtrer cet appel pour des services spécifiques en remplissant le champ RateCarriers avec CarrierName et CarrierID, que vous pouvez récupérer sur la page ShippyPro APIKEYS. Par exemple : RateCarriers: [“CarrierName|CarrierID,CarrierName|CarrierID”]

⚠️ La réponse à l'appel GetRates est-elle lente ?

Nous vous recommandons d'utiliser des filtres en remplissant le champ RateCarriers.

Si plusieurs connexions de courriers sont présentes, le fait de les interroger toutes pour recevoir les tarifs peut allonger le temps d'attente.

📍 Pour obtenir les tarifs d'Amazon et de l'AMF vous devez avoir la commande de référence déjà importée sur la plateforme ShippyPro dans la rubrique "A expédier"

2. Comment ça marche

Pour appeler l'API GetRate, ces paramètres de corps doivent être passés :

Nom

Type de donnée

Obligatoire

Vide

Description

Longueur max

to_address

Array

true

false

Information adresse de l'expéditeur

name

string

true

false

Nom de l'expéditeur

company

string

true

true

Entreprise de l'expéditeur

street1

string

true

false

Rue 1 de l'expéditeur

Selon le Transporteur spécifique

street2

string

true

true

Rue 2 de l'expéditeur

Selon le Transporteur spécifique

city

string

true

false

Ville de l'expéditeur

state

string

true

false

État de l'expéditeur

zip

string

true

false

Code postal de l'expéditeur

Selon le pays

country

string

true

false

Pays de l'expéditeur (ISO 3166)

2 car.

phone

string

true

false

Téléphone de l'expéditeur

Longueur du numéro de téléphone spécifique au pays

email

string

false

false

Email de l'expéditeur

64 car.

from_address

Array

true

false

Information adresse du destinataire

name

string

true

false

Nom du destinataire

company

string

true

true

Entreprise du destinataire

street1

string

true

false

Rue 1 du destinataire

street2

string

true

true

Rue 2 du destinataire

city

string

true

false

Ville du destinataire

state

string

false

true

État du destinataire

zip

string

true

false

Code postal du destinataire

Selon le pays

country

string

true

false

Pays du destinataire (ISO 3166)

2 car.

phone

string

true

false

Téléphone du destinataire

Selon le pays

email

string

true

false

Email du destinataire

parcels

Array

true

false

Information des colis (Minimum 1)

4 objets chacun

dimension_unit

string

false

false

Unité de mesure de la longueur du colis : "CM" (par défaut), "IN"

2 car.

length

int

true

false

Longueur du colis

width

int

true

false

Largeur du colis

height

int

true

false

Hauteur du colis

weight_unit

string

false

false

Unité de mesure du poids du colis : "KG" (par défaut), "LB", "OZ"

2 car.

weight

float

true

false

Poids du colis

2 décimales

Insurance

float

false

false

Valeur de l'assurance (par défaut : 0)

InsuranceCurrency

string

false

false

Monnaie de l'assurance (par défaut : "EUR"), consultez ici

3 car.

CashOnDelivery

float

false

false

Valeur de a livraison en contre-remboursement (par défaut : 0)

CashOnDeliveryCurrency

string

false

false

Monnaie du contre-remboursement (par défaut : "EUR"), consultez ici

3 car.

ContentDescription

string

true

false

Description du contenur

255 car.

TotalValue

string

false ⚠️

true

Valeur de la commande y compris la monnaie (ex. 120.50 EUR) ⚠️ Obligatoire pour les envois internationaux

ShippingService

string

true

true

Client a sélectionné un service d'expédition (ex. Express, Standard)

RateCarriers

Array

false

false

Tarifs uniquement pour certains Transporteurs ["DHLExpress", …]

TransactionID

string

false

false

Votre numéro de commande de référence interne

35 car.

⚠️ Notez que l'attribut de réponse delivery_days peut être un nombre (ex. 2) ou un intervalle (ex. "2-5").

3. Référence API Get Rates

Consultez notre Documentation API pour voir un exemple de requête et de réponse de l'API Get Rates.

💡 Comment filtrer cet appel pour seulement certains Transporteurs connectés ?

Vous pouvez filtrer cet appel pour des services spécifiques en remplissant le champ RateCarriers avec CarrierName et CarrierID que vous pourrez retrouver sur la page APIKEYS.


Ex. RateCarriers: [“CarrierName|CarrierID,CarrierName|CarrierID”]

Contactez nos Experts pour en savoir plus sur nos API et passez un nouveau cap avec votre entreprise !

:muscolo:


Avez-vous trouvé la réponse à votre question ?