Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time
12849 lines (6866 sloc) 296 KB

Admin API

This document is the API specification for BoxBilling

Activity

System activity messages management

admin/activity/log_get_list

Get list of activity messages

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->activity_log_get_list($params);

    .. code-block:: html

        {{ admin.activity_log_get_list() }}

    .. code-block:: javascript

        bb.post("admin/activity/log_get_list", {})

admin/activity/log

Add message to log

Required parameters

m:string - Message text

Optional parameters

admin_id:int - admin id
client_id:int - client id
priority:string - log priority

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->activity_log($params);

    .. code-block:: html

        {{ admin.activity_log() }}

    .. code-block:: javascript

        bb.post("admin/activity/log", {})

admin/activity/log_email

Add email to log

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->activity_log_email($params);

    .. code-block:: html

        {{ admin.activity_log_email() }}

    .. code-block:: javascript

        bb.post("admin/activity/log_email", {})

admin/activity/log_delete

Remove activity message

Required parameters

id:int - Message ID

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->activity_log_delete($params);

    .. code-block:: html

        {{ admin.activity_log_delete() }}

    .. code-block:: javascript

        bb.post("admin/activity/log_delete", {})

Cart

Shopping cart management

admin/cart/get_list

Get list of currently active carts. Carts are removed after checkout.

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->cart_get_list($params);

    .. code-block:: html

        {{ admin.cart_get_list() }}

    .. code-block:: javascript

        bb.post("admin/cart/get_list", {})

admin/cart/get

Get shopping cart contents by id

Required parameters

id:int - shopping cart id

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->cart_get($params);

    .. code-block:: html

        {{ admin.cart_get() }}

    .. code-block:: javascript

        bb.post("admin/cart/get", {})

admin/cart/batch_expire

Remove shopping carts that are older than a week and was not ordered

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->cart_batch_expire($params);

    .. code-block:: html

        {{ admin.cart_batch_expire() }}

    .. code-block:: javascript

        bb.post("admin/cart/batch_expire", {})

Client

Client management

admin/client/get_list

Get list of clients

Optional parameters

status:string - Filters client by status. Available options: active, suspended, canceled

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->client_get_list($params);

    .. code-block:: html

        {{ admin.client_get_list() }}

    .. code-block:: javascript

        bb.post("admin/client/get_list", {})

admin/client/get_pairs

Get clients index

API call examples

.. configuration-block::

    .. code-block:: php

        $result = $api_admin->client_get_pairs($params);

    .. code-block:: html

        {{ admin.client_get_pairs() }}

    .. code-block:: javascript

        bb.post("admin/client/get_pairs", {})

admin/client/get

Get client by id or email. Email is also unique in database

Required parameters

id:int - client ID