API - Shopping - Checkout¶

Get checkout data¶

URL: /shopping/checkout/
Method: GET

Code sample:¶

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

# fetch data
$url = '/shopping/checkout/';
$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: {
        cart: {},
        online_orders: [ ],
        available_points: 44,
        countries: {},
        states: [],
        has_delayed_payment: false,
        has_electronic: false,
        all_in_stock: true,
        customer_addresses: [],
        customer_companies: [ ],
        has_freeshipping: false,
        payment_methods: [],
        payment_methods_groups: [],
        payment_tokens: [],
        locations: {},
        locations_states: [ ],
        vouchers: [ ]
    }
}

Match shipping method for a new address¶

URL: /api/shopping/match_new_address/?city_id=285
Method: GET

Code sample:¶

...
$url = '/api/shopping/match_new_address/?city_id=285';
...

Succes message: request_message contains the Shipping method ID

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

Get States and Cities¶

URL: /api/countries-states/
Method: POST

Code sample:¶

...
$url = '/api/countries-states/';
$post_data = array(
    'shipping_only' => true,
);
...

Succes message:

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

Get Pickup points cities¶

URL: /api/cities/?state=15
Method: POST
Parameters: state=15

Code sample:¶

...
$url = '/api/cities/?state=15';
$post_data = array(
    'pickup_point_only' => true,
);
...

Succes message:

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

Get Pickup points¶

URL: /api/checkout/pickup_points?city_id=13102
Method: GET
Parameters: city_id=13102

Code sample:¶

...
$url = '/api/checkout/pickup_points?city_id=13102';
$post_data = array();
...

Succes message:

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

Get payment methods¶

URL: /api/shopping/matched_payment_methods?shipping_method=10002
Method: GET
Parameters: address_id=address_118071&city_id=0&buyer=person&express_delivery=0&pickup_point_id=0

Code sample:¶

...
$url = '/api/shopping/matched_payment_methods?shipping_method=10002&address_id=address_118071&city_id=0&buyer=person&express_delivery=0&pickup_point_id=0';
...

Succes message:

{
    has_error: false,
    messages: [ ],
    results: {
        payment_methods: [],
        payment_methods_groups: [],
        selected_shipper_id: "1",
        selected_city_id: "13820",
        all_in_stock: true,
        has_electronic: false,
        has_freeshipping: null,
        has_delayed_payment: false,
        express_shipping_cost: 0,
        package_open_cost: 0
    }
}

Refresh cart info¶

URL: /api/checkout/cart/
Method: GET
Parameters: shipping_method=0&payment_method=0&address_id=0&assembly=0&city_id=0&pickup_point_id=0&express_delivery=0&package_open=0

Code sample:¶

...
$url = '/api/checkout/cart/?shipping_method=0&payment_method=0&address_id=0&assembly=0&city_id=0&pickup_point_id=0&express_delivery=0&package_open=0';
...

Succes message:

{
    has_error: false,
    messages: [ ],
    results: {
        cart: {},
        vouchers: [ ],
        available_points: 44,
        shipping_method: null,
        payment_method: null,
        pickup_point: null
    }
}

Send order¶

URL: /shopping/confirm/
Method: POST

Code sample:¶

...
$url = '/shopping/confirm/';
$post_data = array(
    'new_customer' => array(),
    'new_company' => array(),
    'new_address' => array(),
    'shipper_id' => 1,
    'selected_city_id' => 13820,
    'comments' => '',
    'buyer' => 'person',
    'shipping_method' => 10002,
    'address_id' => 'address_118071',
    'payment_method' => 8,
    'installments' => array(8 => 6),
    'assembly' => 0,
    'express_delivery' => 0,
    'package_open' => 0,
    'sms_notify' => 1,
    'skip_email_notify' => 0,
    'telephone_notify' => 0,
    'agree' => 1,
    'ref' => 'google_ads',
    'ref_src' => 'android'
);
...

Succes message: normal payment

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

Succes message: online payment & payment URL

{
    has_error: false,
    messages: [ ],
    results: {
        order_id: 22354,
        payment_url: "https://example.com/shopping/online-payment/b9729099aa4fa6e69c8f343fd5c45d95/",
        form_content: "..." 
    }
}