Gebruik

De privé-API stelt u in staat om de bestellingen van uw klanten naar ons te verzenden.

  • Contingenten voor gebruik : onbeperkt
    Voor deze API geldt geen quota voor verzoeken.
  • Authenticatie : ja
    Er is een fout opgetreden bij het registreren van de gebruiker.
  • Verzendtermijn van e-mails: 10 dagen
    Vanaf de datum van ontvangst van uw bestellingen via de API, zullen uw klanten 10 dagen later per e-mail worden benaderd.


Bestellingen verzenden

De volgende parameters moeten worden gebruikt om de query aan te passen:

  • api_key string, verplicht
    Unieke privésleutel voor toegang tot de API
  • orders json, verplicht
    Tag
    • id_order string, verplicht
      Unieke bestelidentificatie
    • order_date string, verplicht
      Datum en tijd van de bestelling in het formaat YYYY-MM-DD HH:MM:SS
    • firstname string, verplicht
      Voornaam van de klant
    • lastname string, verplicht
      Naam van de klant
    • email string, verplicht
      E-mailadres van de klant
    • reference string
      Unieke referentie van de bestelling
    • store_id integer
      Unieke winkelidentificatie (indien van toepassing)
    • products array
      Statistieken dashboard
      • id integer, verplicht
        Unieke productidentificatie
      • name string, verplicht
        Naam van het product
      • category_id string
        Productcategorie-identificatie
      • category_name string
        Naam van de productcategorie
      • qty integer
        Hoeveelheid van het product in de bestelling
      • unit_price float
        Eenheidsprijs van het product (inclusief belastingen)
      • mpn string
        MPN-code van het product
      • ean13 string
        EAN13-code van het product
      • sku string
        Product SKU-code
      • upc string
        Product UPC-code
      • url string
        URL Google Reviews
      • image_url string
        URL van de productafbeelding
Endpoint
https://api.guaranteed-reviews.com/private/v3/orders
Voorbeeldaanroep (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/', 'image_url' => 'https://www.mywebsite.com/images/myproduct.jpg', ), ), ), ), ), ); // 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); ?>

Waarden geretourneerd door de API

De API retourneert een antwoord met een object 'success'.

  • success integer
    Retourne '1' als ten minste één bestelling is geïmporteerd of '0' als er geen bestelling is geïmporteerd.
  • orders_count integer
    Geeft het totale aantal bestellingen terug dat in de oproep is doorgegeven
  • orders_imported integer
    Geeft het totale aantal daadwerkelijk geïmporteerde bestellingen terug
    LET OP:<\/b> Een bestelling zal niet opnieuw worden geïmporteerd als er al een andere bestelling met dezelfde id_order of referentie is verzonden.
  • message string
    Geeft een eventueel bericht terug met meer informatie over een fout tijdens de import.

Voorbeeld van een API-respons van een succesvol geïmporteerde bestelling:

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

Voorbeeld van een API-respons in het geval van al geïmporteerde bestellingen:

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