Utilice

La API privada le permite enviarnos los pedidos de sus clientes.

  • Cuotas de utilización : ilimitado
    Esta API no está sujeta a un cupo de solicitudes.
  • Autentificación : sí
    Se requiere autenticación por clave para acceder y enviar datos.
  • Plazo de envío de correos electrónicos : 10 días
    A partir de la fecha de recepción de sus pedidos a través de la API, sus clientes serán contactados 10 días después por correo electrónico.


Envío de pedidos

Los siguientes parámetros deben utilizarse para personalizar la consulta:

  • api_key string, obligatorio
    Clave privada única para acceder a la API
  • orders json, obligatorio
    Tabla de comandos (codificado en JSON)
    • id_order string, obligatorio
      Identificador único del pedido
    • order_date string, obligatorio
      Fecha y hora del pedido en formato YYYY-MM-DD HH:MM:SS
    • firstname string, obligatorio
      Nombre del cliente
    • lastname string, obligatorio
      Nombre del cliente
    • email string, obligatorio
      Correo electrónico del cliente
    • reference string
      Referencia única del pedido
    • store_id integer
      Identificador único de la tienda (si aplica)
    • products array
      Tabla que contiene la lista de productos pedidos
      • id integer, obligatorio
        Identificador único del producto
      • name string, obligatorio
        Nombre del producto
      • category_id string
        Identificador de la categoría del producto
      • category_name string
        Nombre de la categoría del producto
      • qty integer
        Cantidad del producto en el pedido
      • unit_price float
        Precio unitario del producto (impuestos incluidos)
      • mpn string
        Código MPN del producto
      • ean13 string
        Código EAN13 del producto
      • sku string
        Código SKU del producto
      • upc string
        Código UPC del producto
      • url string
        URL del producto
Endpoint
https://api.guaranteed-reviews.com/private/v3/orders
Ejemplo de llamada (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); ?>

Valores devueltos por la API

La API devuelve una respuesta que contiene un objeto 'success'.

  • success integer
    Devuelve '1' si al menos un pedido ha sido importado o '0' si no se ha importado ningún pedido.
  • orders_count integer
    Devuelve el número total de pedidos transmitidos en la llamada
  • orders_imported integer
    Devuelve el número total de pedidos efectivamente importados
    ATENCIÓN: Un pedido no será reimportado si otro pedido con el mismo id_order o referencia ya ha sido enviado.
  • message string
    Devuelve un mensaje eventual que contenga más información sobre un error durante la importación

Ejemplo de una respuesta API de un pedido importado con éxito:

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

Ejemplo de una respuesta de API en el caso de pedidos ya importados:

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