Aller au contenu principal

Fichier - format et nommage

Description.​

Ce guide vous explique le format du fichier attendu.

Format.​

Nous nous attendons à recevoir un fichier au format CSV (séparateur ; / encodage UTF-8) contenant les informations suivantes :

  • colonne 1: identifiant client voir info
  • colonne 2: identifiant colis voir info
  • colonne 3: type d'évènement : PRODUCT_RETURN ou SEND_USER voir info
  • colonne 4: date de l'évènement au format ISO 8601 voir info

Ce fichier ne doit pas comporter d'en-tête.

Colonne 1 : identifiant client​

En tant que client Hipli​

Vous trouverez votre identifiant client (nom d'utilisateur) dans l'interface Hipli, dans la partie Admin > Serveur de fichiers.

Hipli - Account

En tant que logisticien pour un client Hipli​

Vous trouverez les identifiants de vos clients (colonne identifiant) dans l'interface Hipli, dans la partie Admin > Clients.

Hipli - Logistician

Colonne 2 : identifiant colis​

Vous trouverez l'identifiant colis sur le colis lui-même, sous la forme d'un QR code ou d'un code barre. L'identifiant est de la forme suivante et se situe sous le code barre ou le QR code :

  • HIP000000000000
  • ABC000000000000A0000000000

Les deux formats sont acceptés dans cette colonne.

Nous acceptons également la valeur https://hipli.co/HIP000000000000 qui correspond à la valeur du QR code une fois scanné.

Colonne 3 : type d'évènement​

Nous acceptons les valeurs suivantes dans cette colonne :

  • SEND_USER : qui correspond à un envoi d'un colis Hipli à un de vos clients. Lorsque vous envoyez un colis à un de vos clients, vous pouvez, via cet évènement, nous indiquer que le colis a été envoyé à votre client.
  • PRODUCT_RETURN : qui correspond à un retour produit. Lorsqu'un colis précédemment envoyé à un client vous revient par le biais d'un retour client, vous pouvez, via cet évènement, nous indiquer que le colis est revenu chez vous.

Colonne 4 : date de l'évènement​

Le format ISO 8601 est le suivant : YYYY-MM-DDTHH:MM:SSZ (format UTC)

Un exemple de date : 2021-04-10T11:22:10Z ou 2021-04-10T12:22:10+01

Wikipedia ISO 8601

Cette date correspond à la date à laquelle l'évènement s'est produit.

Nommage du fichier​

Le nom du fichier n'a pas d'importance, ce qui compte, c'est qu'il possède bien l'extension .csv.

Le nom du fichier peut être en majuscule ou en minuscule, mais il doit être unique s'il est déposé sur un serveur (le fichier sera supprimé après traitement).

Exemples acceptés :

  • SCAN-001.csv
  • HIPLI-20230410_122210.csv
  • return123.csv

Exemples non acceptés :

  • SCAN-001.txt
  • HIPLI-20230410_122210
  • return123.xls

Exemple de fichier​

Voici un exemple de fichier contenant 3 évènements :

c2q1r2gds7zkb9kghthchcsg;HIP100000000141;SEND_USER;2024-01-12T11:31:16Z
c2q1r2gds7zkb9kghthchcsg;HIP100000000142;SEND_USER;2024-01-12T11:31:16Z
c2q1r2gds7zkb9kghthchcsg;HIP100000000143;PRODUCT_RETURN;2024-01-12T11:31:16Z