Verwendung

Die private API ermöglicht es Ihnen, uns die Bestellungen Ihrer Kunden zu senden.

  • Nutzungsquoten : unbegrenzt
    Für diese API gibt es keine Quote für Anfragen.
  • Authentifizierung : Ja
    Eine Schlüssel-Authentifizierung ist erforderlich, um auf Daten zuzugreifen und diese zu senden.
  • Versandfrist für E-Mails: 10 tage
    Ab dem Datum des Eingangs Ihrer Bestellungen über die API werden Ihre Kunden 10 Tage später per E-Mail kontaktiert.


Bestellungen senden

Die folgenden Einstellungen müssen verwendet werden, um die Abfrage anzupassen :

  • api_key string, obligatorisch
    Einzigartiger privater Schlüssel für den Zugriff auf die API
  • orders json, obligatorisch
    Bestelltabelle (im JSON-Format)
    • id_order string, obligatorisch
      Eindeutige Bestell-ID
    • order_date string, obligatorisch
      Bestelldatum und -uhrzeit im Format YYYY-MM-DD HH:MM:SS
    • firstname string, obligatorisch
      Vorname des Kunden
    • lastname string, obligatorisch
      Kundenname
    • email string, obligatorisch
      E-Mail-Adresse des Kunden
    • reference string
      Eindeutige Bestellreferenz
    • store_id integer
      Eindeutige Shop-ID (falls zutreffend)
    • products array
      Tabelle mit der Liste der bestellten Produkte
      • id integer, obligatorisch
        Eindeutige Produkt-ID
      • name string, obligatorisch
        Produktname
      • category_id string
        Produktkategorie-Identifikator
      • category_name string
        Produktkategorie-Name
      • qty integer
        Menge des Produkts in der Bestellung
      • unit_price float
        Einzelpreis des Produkts (inkl. Steuern)
      • mpn string
        MPN-Code des Produkts
      • ean13 string
        EAN13-Code des Produkts
      • sku string
        Produkt-SKU-Code
      • upc string
        Produkt-UPC-Code
      • url string
        Produkt-URL
Endpoint
https://api.guaranteed-reviews.com/private/v3/orders
Beispielaufruf (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); ?>

Von der API zurückgegebene Werte

Die API gibt eine Antwort mit einem 'success'-Objekt zurück.

  • success integer
    Gib '1' zurück, wenn mindestens eine Bestellung importiert wurde, oder '0', wenn keine Bestellung importiert wurde.
  • orders_count integer
    Gibt die Gesamtzahl der im Aufruf übermittelten Bestellungen zurück
  • orders_imported integer
    Gibt die Gesamtzahl der tatsächlich importierten Bestellungen zurück
    ACHTUNG:<\/b> Eine Bestellung wird nicht erneut importiert, wenn bereits eine andere Bestellung mit derselben id_order<\/i> oder reference<\/i> versendet wurde.
  • message string
    Gibt eine mögliche Nachricht zurück, die weitere Informationen zu einem Fehler beim Import enthält.

Beispiel einer API-Antwort einer erfolgreich importierten Bestellung:

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

Beispiel einer API-Antwort im Falle bereits importierter Bestellungen:

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