API - Wishlist¶

Add or remove products from Favorites list¶

URL: /wishlist/quick-add/1234/
Method: GET/POST (POST needed for extra options)

Code sample:¶

$api_id = 1;
$api_key = 'testpass';
$hostname = 'https://example.com'; // no trailing slash

# fetch data
$url = '/wishlist/quick-add/1234/';
$post_data = array(
    'price_alert' => null
);
$user_token = 'xxx'; // is required here. Get it from Your DB after Token generation
$extra_headers = array(
    'X-API-ID: ' . $api_id,
    'X-API-Hash: ' . md5($api_key . $url. http_build_query($post_data)),
    'X-User-Token: ' . $user_token
);

header('Content-Type: application/json; charset=utf-8');
echo sendRequest($hostname . $url, $post_data, $extra_headers);

Succes message - if product exists in Favorites list, will be deleted:

{
    has_error: false,
    messages: [ ],
    results: {
        request_status: "ok",
        request_message: "deleted" 
    }
}

Succes message - if product does not exist in Favorites list, will be added:

{
    has_error: false,
    messages: [ ],
    results: {
        request_status: "ok",
        request_message: "added" 
    }
}

Error message:

{
    has_error: true,
    messages: [
        "Invalid product" 
    ],
    results: [ ]
}

List products from Wishlistlist¶

URL: /wishlist/g/ or /wishlist/81dc9bdb52d04dc20036dbd8313ed055/
Method: GET

Code sample:¶

...
$url = '/wishlist/g/';
// $url = '/wishlist/81dc9bdb52d04dc20036dbd8313ed055/'; // for public / private wishlist
...

Succes message - if product exists in Favorites list, will be deleted:

{
    has_error: false,
    messages: {
        section: "wishlist-details" 
    },
    results: {
        productinfo: [],
        wishlistinfo: {}
    }
}

List public wishlists¶

URL: /wishlist/
Method: GET

Code sample:¶

...
$url = '/wishlist/';
...

Succes message

{
    has_error: false,
    messages: [ ],
    results: [...]
}

List private wishlists¶

URL: /account/wishlist/
Method: GET

Code sample:¶

...
$url = '/account/wishlist/';
...

Succes message

{
    has_error: false,
    messages: [ ],
    results: [...]
}

Add wishlist from cart¶

URL: /wishlist/add/
Method: POST

Code sample:¶

...
$url = '/wishlist/add/';
$post_data = array(
    'wishlist_name' => 'test',
    'customer_comment' => 'description',
    'is_public' => 1,
    'price_alert' => null,
    'customer_name' => 'John Doe',
    'email' => 'test@example.com'
);
...

Succes message

{
    has_error: false,
    messages: [ ],
    results: {
        id: 156940,
        hash: "79bd25d71cc655f330c1c9210626a6c4",
        products: []
    }
}

Error message

{
    has_error: true,
    messages: {
        no_products: "No products in cart" 
    },
    results: [ ]
}

Send wishlist to a friend¶

URL: /wishlist/send/81dc9bdb52d04dc20036dbd8313ed055/
Method: POST

Code sample:¶

...
$url = '/wishlist/send/81dc9bdb52d04dc20036dbd8313ed055/';
$post_data = array(
    'name' => 'test',
    'email' => 'test1@example.com',
    'friend_email' => 'test2@example.com',
    'message' => 'Hello world',
);
...

Succes message

{
    has_error: false,
    messages: [ ],
    results: {
        request_status: "ok",
        request_message: "" 
    }
}

Error message

{
    has_error: true,
    messages: [
        "Adresa de email a prietenului nu este valida" 
    ],
    results: [ ]
}

Edit account wishlists¶

URL: /account/wishlist/?makeprivate=1234
Method: GET
Allowed actions: makepublic, makeprivate, delete

Code sample:¶

...
$url = '/account/wishlist/?makeprivate=1234';
...

Succes message

{
    has_error: false,
    messages: [ ],
    results: {
        request_status: "ok",
        request_message: "" 
    }
}

Edit wishlist options¶

URL: /api/etc/tools?action=edit-wishlist
Method: POST

Code sample:¶

...
$url = '/api/etc/tools?action=edit-wishlist';
$post_data = array(
    'hash' => '81dc9bdb52d04dc20036dbd8313ed055',
    'price_alert' => 1,
    'is_public' => 0
);
...

Succes message

{
    has_error: false,
    messages: [ ],
    results: {
        request_status: "ok",
        request_message: "" 
    }
}

Error message

{
    has_error: true,
    messages: [
        "Invalid hash" 
    ],
    results: [ ]
}