Utilização

A API privada permite que você nos envie os pedidos dos seus clientes.

  • Quotas de utilização: ilimitados
    Esta API não está sujeita a um limite de requisições.
  • Autenticação : sim
    Uma autenticação por chave é necessária para acessar e enviar dados.
  • Prazo de envio dos e-mails: 10 dias
    A contar da data de receção dos seus pedidos via a API, os seus clientes serão solicitados 10 dias depois por e-mail.


Envio de encomendas

Os seguintes parâmetros devem ser utilizados para personalizar a requisição:

  • api_key string, obrigatório
    Chave privada única para aceder à API
  • orders json, obrigatório
    Painel de comandos (codificado em JSON)
    • id_order string, obrigatório
      Identificador único da encomenda
    • order_date string, obrigatório
      Data e hora do pedido no formato YYYY-MM-DD HH:MM:SS
    • firstname string, obrigatório
      Nome do cliente
    • lastname string, obrigatório
      Nome do cliente
    • email string, obrigatório
      Endereço de e-mail do cliente
    • reference string
      Referência única do pedido
    • store_id integer
      Identificador único da loja (se aplicável)
    • products array
      Tabela contendo a lista dos produtos encomendados
      • id integer, obrigatório
        Identificador único do produto
      • name string, obrigatório
        Nome do produto
      • category_id string
        Identificador da categoria do produto
      • category_name string
        Nome da categoria do produto
      • qty integer
        Quantidade do produto no pedido
      • unit_price float
        Preço unitário do produto (taxas incluídas)
      • mpn string
        Código MPN do produto
      • ean13 string
        Código EAN13 do produto
      • sku string
        Código SKU do produto
      • upc string
        Código UPC do produto
      • url string
        URL do produto
Endpoint
https://api.guaranteed-reviews.com/private/v3/orders
Exemplo de chamada (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 retornados pela API

A API retorna uma resposta contendo um objeto 'success'.

  • success integer
    Retorna '1' se pelo menos um pedido foi importado ou '0' se nenhum pedido foi importado.
  • orders_count integer
    Retorna o número total de pedidos transmitidos na chamada
  • orders_imported integer
    Retorna o número total de pedidos efetivamente importados
    ATENÇÃO: Uma encomenda não será re-importada se outra encomenda com o mesmo id_order ou reference já tiver sido enviada.
  • message string
    Retorna uma mensagem eventual contendo mais informações sobre um erro durante a importação

Exemplo de uma resposta API de um pedido importado com sucesso:

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

Exemplo de uma resposta API no caso de pedidos já importados:

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