Utilizzo

L'API privata ti consente di inviarci gli ordini dei tuoi clienti.

  • Quote di utilizzo : illimitato
    Questa API non è soggetta a una quota di richieste.
  • Autenticazione : sì
    È necessaria un'autenticazione tramite chiave per accedere e inviare dati.
  • Termine di invio delle e-mail: 10 giorni
    A partire dalla data di ricezione dei tuoi ordini tramite l'API, i tuoi clienti saranno contattati 10 giorni dopo via e-mail.


Invio di ordini

Per personalizzare la query è necessario utilizzare i seguenti parametri:

  • api_key string, obbligatorio
    Chiave privata unica per accedere all'API
  • orders json, obbligatorio
    Tabella degli ordini (codificata in JSON)
    • id_order string, obbligatorio
      Identificativo unico dell'ordine
    • order_date string, obbligatorio
      Data e ora dell'ordine nel formato YYYY-MM-DD HH:MM:SS
    • firstname string, obbligatorio
      Nome del cliente
    • lastname string, obbligatorio
      Nome del cliente
    • email string, obbligatorio
      Indirizzo e-mail del cliente
    • reference string
      Riferimento unico dell'ordine
    • store_id integer
      Identificativo unico del negozio (se applicabile)
    • products array
      Tabella contenente l'elenco dei prodotti ordinati
      • id integer, obbligatorio
        Identificativo unico del prodotto
      • name string, obbligatorio
        Nome del prodotto
      • category_id string
        Identificativo della categoria del prodotto
      • category_name string
        Nome della categoria del prodotto
      • qty integer
        Quantità del prodotto nell'ordine
      • unit_price float
        Prezzo unitario del prodotto (tasse incluse)
      • mpn string
        Codice MPN del prodotto
      • ean13 string
        Codice EAN13 del prodotto
      • sku string
        Codice SKU del prodotto
      • upc string
        Codice UPC del prodotto
      • url string
        URL del prodotto
Endpoint
https://api.guaranteed-reviews.com/private/v3/orders
Esempio di chiamata (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' => '[email protected]', 'reference' => '12345678', 'store_id' => 0, '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); ?>

Valori restituiti dall'API

L'API restituisce una risposta contenente un oggetto 'success'.

  • success integer
    Restituisce '1' se almeno un ordine è stato importato o '0' se nessun ordine è stato importato.
  • orders_count integer
    Restituisce il numero totale di ordini trasmessi nella chiamata
  • orders_imported integer
    Restituisce il numero totale di ordini effettivamente importati
    ATTENZIONE:<\/b> Un ordine non verrà ri-importato se un altro ordine con lo stesso id_order<\/i> o riferimento<\/i> è già stato inviato.
  • message string
    Restituisce un messaggio eventuale contenente ulteriori informazioni su un errore durante l'importazione

Esempio di una risposta API di un ordine importato con successo:

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

Esempio di una risposta API nel caso di ordini già importati:

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