API privée – Commandes | Société des Avis Garantis

Utilisation

L'API privée vous permet de nous envoyer les commandes de vos clients.

Quotas d'utilisation : illimités

Cette API n'est pas soumise à un quota de requêtes.
Authentification : oui

Une authentification par clé est requise pour accéder et envoyer des données.
Délai d'envoi des e-mails : 10 jours

À compter de la date de réception de vos commandes via l'API, vos clients seront sollicités 10 jours plus tard par e-mail.

Envoi de commandes

Les paramètres suivants doivent être utilisés pour personnaliser la requête :

api_key string, obligatoire

Clé privée unique pour accéder à l'API
orders json, obligatoire

Tableau de commandes (encodé en JSON)

id_order string, obligatoire

Identifiant unique de la commande
order_date string, obligatoire

Date et heure de la commande au format YYYY-MM-DD HH:MM:SS
firstname string, obligatoire

Prénom du client
lastname string, obligatoire

Nom du client
email string, obligatoire

Adresse e-mail du client
reference string

Référence unique de la commande
products array

Tableau contenant la liste des produits commandés

id integer, obligatoire

Identifiant unique du produit
name string, obligatoire

Nom du produit
category_id string

Identifiant de la catégorie du produit
category_name string

Nom de la catégorie du produit
qty integer

Quantité du produit dans la commande
unit_price float

Prix unitaire du produit (taxes incluses)
mpn string

Code MPN du produit
ean13 string

Code EAN13 du produit
sku string

Code SKU du produit
upc string

Code UPC du produit
url string

URL du produit

Endpoint
https://api.guaranteed-reviews.com/private/v3/orders

Exemple d'appel (PHP cURL)
<?php 

// Define API endpoint and API key 
$apiEndPoint = "https://api.guaranteed-reviews.com/private/v3/orders";
$apiKey = "YOUR_PRIVATE_KEY";

// Prepare data 
$post = array( 
        'api_key' => $apiKey, 
        'orders' => json_encode( 
            array( 
                array( 
                    'id_order' => '1234', 
                    'order_date' => '2019-01-01 12:00:00', 
                    'firstname' => 'John', 
                    'lastname' => 'Doe', 
                    'email' => 'test@n2d.fr', 
                    'reference' => '12345678', 
                    'products' => array( 
                        array( 
                            'id' => '100', 
                            'name' => 'My Product 100', 
                            'category_id' => 'cat1', 
                            'category_name' => 'Category 1', 
                            'qty' => '1',
                            'unit_price' => '25.90', 
                            'mpn' => 'MPN100', 
                            'ean13' => '1234567890123', 
                            'sku' => 'SKU100', 
                            'upc' => 'UPCCODE', 
                            'url' => 'https://www.mywebsite.com/myproduct/', 
                        ), 
                    ), 
                ), 
            ), 
        ), 
); 

// Prepare CURL request 
$ch = curl_init($apiEndPoint); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($ch, CURLOPT_POSTFIELDS, $post); 

// Execute CURL request 
$response = curl_exec($ch); 

// Close the connection, release resources used 
curl_close($ch); 

// Do anything you want with your response ! 
var_dump($response); 

?>
                    

Valeurs retournées par l'API

L'API retourne une réponse contenant un objet 'success'.

success integer

Retourne '1' si au moins une commande a été importée ou '0' si aucune commande n'a été importée.
orders_count integer

Retourne le nombre total de commandes transmises dans l'appel
orders_imported integer

Retourne le nombre total de commandes effectivement importées
ATTENTION: Une commande ne sera pas ré-importée si une autre commande avec le même id_order ou reference a déjà été envoyée.
message string

Retourne un message éventuel contenant plus d'informations sur une erreur lors de l'importation

Exemple d'une réponse API d'une commande importée avec succès :

JSON
{
	"success": 1,
	"orders_count": 1,
	"orders_imported": 1,
	"message": null
}

Exemple d'une réponse API dans le cas de commandes déjà importées :

JSON
{
	"success": 0,
	"orders_count": 1,
	"orders_imported": 0,
	"message": "Some orders were not imported because they had already been sent (see documentation)"
}