API - Account - Addresses¶

Addresses list¶

URL: /account/addresses/
Method: GET

Code sample:¶

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

# fetch data
$url = '/account/addresses/';
$post_data = array();
$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:

{
    has_error: false,
    messages: [ ],
    results: {
        123456: {},
        234567: {}
    }
}

Address details¶

URL: /api/account/addresses/?address_id=1234
Method: GET

Code sample:¶

# fetch data
$url = '/api/account/addresses/?address_id=1234';
$post_data = array();

Succes message:

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

Address edit/add¶

URL: /api/account/addresses/
Method: POST

Code sample:¶

# fetch data
$url = '/api/account/addresses/';
$post_data = array(
    'current_address' => null,
    'contact_name' => 'John Doe',
    'telephone' => '0123456789',
    'address' => '123 Street, 10th floor',
    'country' => 1234,
    'state' => 12,
    'city' => 12345,
    'zipcode' => '012345',
    'fax' => '',
);

Succes message: request_message contains the address ID

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

Error message:

{
    has_error: true,
    messages: {
        city_id: "Alegeti orasul" 
    },
    results: [ ]
}

Address delete¶

URL: /account/addresses/?deleteaddress=1234
Method: GET

Code sample:¶

# fetch data
$url = '/account/addresses/?deleteaddress =1234';
$post_data = array();

Succes message: request_message contains the address ID

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

Error message:

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