Logo de ShipEngine

API ShipEngine

L'api ShipEngine API permettant le suivi multi-transporteurs, la gestion des retours et des étiquettes.
ShipEngine est disponible via https://www.shipengine.com/docs

Présentation de l'API ShipEngine

L'API ShipEngine offre aux développeurs des outils puissants pour gérer et simplifier les opérations de logistique, incluant la création d'étiquettes d'expédition, le suivi des colis, et la gestion des retours. Parfaitement adaptée aux entreprises de e-commerce, cette API propose des intégrations pour divers transporteurs.

Description de l'API

L'API ShipEngine est une solution complète pour les entreprises souhaitant gérer leurs expéditions de manière efficace et automatisée. Elle permet d'accéder à un réseau mondial de transporteurs, de calculer les frais d'expédition, de créer des étiquettes et de suivre les livraisons en temps réel.

Qu'est-ce que l'API ShipEngine ?

L'API ShipEngine simplifie la gestion des expéditions pour les entreprises en intégrant des fonctionnalités pour gérer les frais de port, les étiquettes et le suivi des colis. Compatible avec de nombreux transporteurs internationaux, elle est particulièrement utile pour les e-commerçants souhaitant centraliser leurs opérations logistiques.

Caractéristiques de l'API

Calcul des frais d'expédition : Comparez les tarifs de différents transporteurs pour choisir l'option la plus économique.
Création d'étiquettes : Créez des étiquettes d'expédition personnalisées pour les principaux transporteurs mondiaux.
Suivi en temps réel : Suivez l'état des colis grâce aux informations de suivi mises à jour.
Gestion des retours : Facilitez le processus de retour pour les clients grâce à des étiquettes de retour automatisées.

Comment intégrer l'API : Exemple d'implémentation

Pour utiliser l'API ShipEngine, vous devez posséder une clé API valide. Voici des exemples de code pour créer une étiquette d'expédition en PHP, JavaScript et Python.


-- php --
// Exemple en PHP pour créer une étiquette
$endpoint = "https://api.shipengine.com/v1/labels";
$apiKey = "VOTRE_CLE_API";
$data = [
    "shipment" => [
        "service_code" => "usps_first_class_mail",
        "ship_to" => [
            "name" => "John Doe",
            "address_line1" => "1234 Main St",
            "city_locality" => "San Francisco",
            "state_province" => "CA",
            "postal_code" => "94104",
            "country_code" => "US"
        ],
        "ship_from" => [
            "name" => "Jane Doe",
            "address_line1" => "5678 Market St",
            "city_locality" => "San Francisco",
            "state_province" => "CA",
            "postal_code" => "94104",
            "country_code" => "US"
        ]
    ]
];

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => $endpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "API-Key: $apiKey",
        "Content-Type: application/json"
    ],
    CURLOPT_POSTFIELDS => json_encode($data)
]);
$response = curl_exec($curl);
curl_close($curl);

echo $response;
?>


// Exemple en JavaScript (Node.js) pour créer une étiquette
const fetch = require('node-fetch');
const endpoint = "https://api.shipengine.com/v1/labels";
const apiKey = "VOTRE_CLE_API";

const data = {
    shipment: {
        service_code: "usps_first_class_mail",
        ship_to: {
            name: "John Doe",
            address_line1: "1234 Main St",
            city_locality: "San Francisco",
            state_province: "CA",
            postal_code: "94104",
            country_code: "US"
        },
        ship_from: {
            name: "Jane Doe",
            address_line1: "5678 Market St",
            city_locality: "San Francisco",
            state_province: "CA",
            postal_code: "94104",
            country_code: "US"
        }
    }
};

fetch(endpoint, {
    method: 'POST',
    headers: {
        'API-Key': apiKey,
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log("Réponse :", data))
.catch(error => console.error("Erreur :", error));


import requests

# Exemple en Python pour créer une étiquette
endpoint = "https://api.shipengine.com/v1/labels"
api_key = "VOTRE_CLE_API"
headers = {
    "API-Key": api_key,
    "Content-Type": "application/json"
}

data = {
    "shipment": {
        "service_code": "usps_first_class_mail",
        "ship_to": {
            "name": "John Doe",
            "address_line1": "1234 Main St",
            "city_locality": "San Francisco",
            "state_province": "CA",
            "postal_code": "94104",
            "country_code": "US"
        },
        "ship_from": {
            "name": "Jane Doe",
            "address_line1": "5678 Market St",
            "city_locality": "San Francisco",
            "state_province": "CA",
            "postal_code": "94104",
            "country_code": "US"
        }
    }
}

response = requests.post(endpoint, headers=headers, json=data)

# Affiche la réponse
if response.status_code == 200:
    print("Étiquette créée :", response.json())
else:
    print("Erreur :", response.status_code)

Cas d'utilisation de l'API

Comparaison des frais d'expédition : Calculez et comparez les coûts de différents transporteurs pour chaque expédition.
Génération d'étiquettes d'expédition : Créez des étiquettes pour chaque commande, prêtes à imprimer pour l'expédition.
Suivi des colis : Intégrez le suivi en temps réel dans votre plateforme pour garder vos clients informés.