Użycie

Prywatne API pozwala na przesyłanie zamówień Twoich klientów.

  • Limity wykorzystania: nieograniczone
    To API nie podlega limitowi zapytań.
  • Uwierzytelnienie : tak
    Wymagana jest autoryzacja klucza, aby uzyskać dostęp i wysłać dane.
  • Czas wysyłki e-maili: 10 dni
    Od daty otrzymania zamówień za pośrednictwem API, Twoi klienci będą proszeni o 10 dni później za pomocą e-maila.


Wysyłka zamówień

Następujące parametry muszą być użyte do personalizacji zapytania:

  • api_key string, obowiązkowy
    Unikalny klucz prywatny do uzyskania dostępu do API
  • orders json, obowiązkowy
    Tabela zamówień (zakodowana w JSON)
    • id_order string, obowiązkowy
      Unikalny identyfikator zamówienia
    • order_date string, obowiązkowy
      Data i godzina zamówienia w formacie RRRR-MM-DD GG:MM:SS
    • firstname string, obowiązkowy
      Imię klienta
    • lastname string, obowiązkowy
      Nazwa klienta
    • email string, obowiązkowy
      Adres e-mail klienta
    • reference string
      Unikalna referencja zamówienia
    • store_id integer
      Unikalny identyfikator sklepu (jeśli dotyczy)
    • products array
      Tabela zawierająca listę zamówionych produktów
      • id integer, obowiązkowy
        Unikalny identyfikator produktu
      • name string, obowiązkowy
        Nazwa produktu
      • category_id string
        Identyfikator kategorii produktu
      • category_name string
        Nazwa kategorii produktu
      • qty integer
        Ilość produktu w zamówieniu
      • unit_price float
        Cena jednostkowa produktu (w tym podatki)
      • mpn string
        Kod MPN produktu
      • ean13 string
        Kod EAN13 produktu
      • sku string
        Kod SKU produktu
      • upc string
        Kod UPC produktu
      • url string
        URL produktu
Endpoint
https://api.guaranteed-reviews.com/private/v3/orders
Przykład wywołania (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); ?>

Wartości zwracane przez API

API zwraca odpowiedź zawierającą obiekt 'success'.

  • success integer
    Zwraca '1' jeśli co najmniej jedno zamówienie zostało zaimportowane lub '0' jeśli żadne zamówienie nie zostało zaimportowane.
  • orders_count integer
    Zwraca całkowitą liczbę zamówień przekazanych w wywołaniu
  • orders_imported integer
    Zwraca całkowitą liczbę zamówień faktycznie zaimportowanych
    UWAGA: Zamówienie nie zostanie ponownie zaimportowane, jeśli inne zamówienie o tym samym id_order lub reference zostało już wysłane.
  • message string
    Zwraca ewentualny komunikat zawierający więcej informacji o błędzie podczas importu

Przykład odpowiedzi API dla zamówienia zaimportowanego z sukcesem:

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

Przykład odpowiedzi API w przypadku już zaimportowanych zamówień:

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