Programmer l’envoi d’un mail post-achat
Objectif
Cette méthode permet de programmer l’envoi d’un mail post-achat sur une fiche donnée ou sur des fiches issues de votre catalogue qui seront créées à la volée.
Format de réponse
Par défaut, l’API offre une réponse au format JSON. Pour bénéficier d’une réponse en XML, vous devez placer dans votre requête un header de type « Accept » avec la valeur « application/xml ».
Signature
POST https://api.monaviscompte.fr/post-purchase/create
Paramètres
nom | requis | type | description |
---|---|---|---|
private_key | oui | string | clé d’authentification privée |
item_id | non (si cart est fourni) | int | identifiant de la fiche sur laquelle doit porter l’avis |
recipient | oui | string | adresse e-mail de votre client |
first_name | non | string | prénom de votre client |
order_id | non | string | identifiant de la commande |
order_url | non | string | URL vers un récapitulatif de la commande (facture, etc.) |
cart | non (si item_id est fourni) | string | Collection JSON de produits faisant partie du panier d’achat de votre client |
La collection de produits doit respecter le format suivant (sans saut de ligne) :
{
"products":[
{"id":"1","name":"Produit 1","summary":"Description produit 1","picture":"URL image produit 1"},
{"id":"2","name":"Produit 2","summary":"Description produit 2","picture":"URL image produit 2"}
]}
Données retournées
nom | type | description |
---|---|---|
code | int | 0 si le mail a été mis en queue, -1 sinon (voir le message pour plus le détail) |
id | int | identifiant de l’envoi (en cas de succès) |
message | string | détail du succès (ou de l’échec) |
Code de retour
code de retour | raison |
---|---|
HTTP 200 | succès |
HTTP 401 | authentification échouée |
HTTP 404 | la fiche n’existe pas |
Réponse JSON
{
"code"
: "0",
"id"
: "1234",
"message"
: "1 nouvelle commande détectée via API, 1 email mis en file d'attente"
}
Réponse XML
<
post_purchase
>
<
code
>0</code>
<
id
>1234</id>
<
message
>
1 nouvelle commande détectée via API, 1 email mis en file d'attente
</message>
</
post_purchase
>