Aller au contenu principal

Appel API

Cette solution permet d'envoyer des commandes de manière unitaire ou en lot, soit en "temps réel", soit de manière groupée avec une fréquence minimum de 1 lot par jour.

Une fois votre compte créé, Hipli vous remettra deux informations : votre identifiant et votre token (la création de compte se fait via demande auprès d'Hipli).

A retenir

Gardez ces informations secrètes, ce sont elles qui permettent d'identifier vos différents appels.

Pour chaque appel, le serveur vous répondra un code HTTP 202 (Accepted) avec un corps vide.

En cas d'erreur, le serveur vous retourna un code HTTP 400 ou 500.

Si vous voulez de l'aide pour comprendre l'erreur, contactez l'équipe technique d'Hipli

L'URL d'accès au service est le suivant : https://hipli.pro

(Il est possible de vérifier que le service est opérationnel en faisant un GET sur l'URL https://hipli.pro/status retournant OK)

L'appel à ce service peut se faire commande par commande (appel unitaire) ou en lot :

Chaque appel se fait ainsi :

POST /shop/order

avec en headers :

Content-Type: application/json
X-Hipli-ShopToken: {TOKEN}

(Le token est celui qui vous été transmis lors de la création de votre compte)

Le corps de la requête doit contenir l'objet suivant en JSON (respecter la casse et envoyer en UTF-8) :

NomTypeObligatoireDescriptionTailleExemple
sourceIdChaine de caractèresObligatoireReprésente un identifiant unique de votre système (utile pour les regroupements pour une même commande). D'usage, il est recommandé d'utiliser votre numéro de commande.Max 50 caractèresORD-1234
sourceShopChaine de caractèresObligatoireReprésente votre identifiant transmis lors de la création de votre compte.Max 50 caractèresSHOP-HIPLI
orderDateChaine de caractères - date ISO-8601ObligatoireReprésente la date de votre commande au format ISO-8601.23 caractères2023-01-13T10:15:30.00Z
destinationCountryChaine de caractèresObligatoireCode pays au format ISO 3166-Alpha 3 (voir liste ici https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements)3 caractèresFRA
numberOfProductNumériqueObligatoireReprésente le nombre d'articles (Hors colis Hipli) dans la commande de l'utilisateur. Attention si vous ajoutez le colis Hipli comme un article supplémentaire à votre commande, pensez à le retirer lors du comptage.Nombre inférieur à 504
hipliSkuChaine de caractèreFacultatifReprésente le numéro de série du colis Hipli utilisé pour l'expédition. Ce champ peut être le contenu du code barre générique représentant le format, ou l'identifiant unique (code barre ou QRCode) ou une chaine de caractère parmi les valeurs (MINUS, HIPLUS, MAGNUS, MAXIMUS, RIGIDE)Max 50 caractèresMAGNUS
mailLangChaine de caractèreFacultatifLangue de l'email envoyé au client (défaut : FR) - Valeurs autorisées : FR, ENMax 5 caractèresFR
clientObjet JSONObligatoireObjet "Client" (voir après)Représente les informations du client

Objet Client :

NomTypeObligatoireDescriptionTailleExemple
firstNameChaine de caractèresObligatoirePrénom de l'utilisateurMax 50 caractèresPierre
lastNameChaine de caractèresObligatoireNom de famille de l'utilisateurMax 50 caractèresLeresteux
mailChaine de caractèresObligatoireAdresse mail de l'utilisateur (sera utilisée pour le mail envoyé par Hipli)Max 50 caractèrespierre.leresteux@hipli.fr
addr1Chaine de caractèresFacultatifPremière partie de l'adresse postale de l'utilisateurMax 100 caractères52 quai frissard
addr2Chaine de caractèresFacultatifSeconde partie de l'adresse postale de l'utilisateurMax 100 caractèresImmeuble Le Bassin
cityChaine de caractèresFacultatifReprésente la ville de l'utilisateurMax 100 caractèresLe Havre
zipCodeChaine de caractèresFacultatifReprésente le code postal de l'utilisateurMax 10 caractères76600
countryChaine de caractèresFacultatifReprésente le pays de l'utilisateurMax 50 caractèresFRANCE
phoneChaine de caractèresFacultatifReprésente le numéro de téléphone de l'utilisateurMax 30 caractères0607080910

Voici des exemples de contenu de la requête :

JSON minimal (uniquement les champs obligatoires) :

{
  "sourceId": "ORD-1234",
  "sourceShop": "SHOP-HIPLI",
  "orderDate": "2023-01-13T10:15:30.00Z",
  "destinationCountry": "FRA",
  "numberOfProduct": 4,
  "client": {
    "firstName": "Pierre",
    "lastName": "Leresteux",
    "mail": "pierre.leresteux@hipli.fr"
  }
}

JSON complet (tous les champs) :

{
  "sourceId": "ORD-1234",
  "sourceShop": "SHOP-HIPLI",
  "orderDate": "2023-01-13T10:15:30.00Z",
  "destinationCountry": "FRA",
  "numberOfProduct": 4,
  "hipliSku": "MINUS",
  "mailLang": "FR",
  "client": {
    "firstName": "Pierre",
    "lastName": "Leresteux",
    "mail": "pierre.leresteux@hipli.fr",
    "addr1": "52 quai frissard",
    "addr2": "Immeuble Le Bassin",
    "city": "Le Havre",
    "zipCode": "76600",
    "country": "FRANCE",
    "phone": "0607080910"
  }
}

Contact / Questions​

En cas de question ou de soucis, contactez votre référent Hipli ou l'équipe technique