"Waiting payment" gateway is dedicated to sales agents and allows them to place "waiting payment" orders, that customers will pay later. The customer will receive an email with order details and a payment link and can decide to make the payment by clicking the "Pay" button directly from his my-account area.

When a new sales agent register from dedicated dashboard page, it prevent autologin and sales agent can login only after administrator approval. On approval, sales agent receive an email notification which warns that his account is active.

You can customize redirect by using dedicated hooks:

• apply_filters( 'wcb2bsa_waiting_approvation', $message )
• apply_filters( 'wcb2bsa_send_activation_notification', $send )

Send email to admin on every new sales agent account registration. Very useful if moderate registration option is enabled.

Add sales agent data (name, email, phone) in transactional emails, to simplify the contact between the customer and the reference sales agent.

Add sales agent data (name, email, phone) in customers MyAccount dashboard page, to simplify the contact between the customer and the reference sales agent.

Choose what to apply the commission to. By changing this option, only the next orders will be affected. You can customize this option for each order on order edit page.

You can customize redirect by using dedicated hooks:

• apply_filters( 'wcb2bsa_order_item_types_eligible_for_commission', $items )

Consider only orders placed directly from sales agent.

In his dashboard, sales agent can view only orders placed directly by him. Orders placed from his customers are excluded from counts, statistics, commissions calculation.

Allow sales agents to edit customer account and addresses data in checkout and in my-account pages when switched on his account.

Allow sales agents to edit and adjust product price in cart page when make purchase in behalf of their customers.

If you want, in each product you can set a minimum price, so the sales agent can change the price but without being able to go below the minimum price.

You can customize cart price arguments input field by using dedicated hooks:

• apply_filters( 'wcb2bsa_cart_input', $args )

Add a new commissions column in WooCommerce orders list. In case of a large number of orders or on poorly performing servers, it may slow down the page loading, therefore it is advisable to disable this option in case of excessive slowdowns or out of memory problems in "WooCommerce -> Orders" page.

You can customize cart price arguments input field by using dedicated hooks:

• apply_filters( 'wcb2bsa_cart_input', $args )

Assign automatically customer to a sales agent on registration. Also available these special options:

• Random: assign a random sales agent among those available
• Allow to choose: add a dropdown menu in checkout, so guest customers or customers without a sales agent can choose sales agent among those available

For each product shows a box on the loop pages with an approximate calculation of commissions estimated earnings.

When a sales agent purchase in behalf of customers, show stock availability in product list pages (loops).

By default, WooCommerce B2B Sales Agents allows you to assign sales agents to users with the default role "customer". Optionally, choose which roles you want to extend this behavior to.

You can customize roles by using dedicated hooks:

• apply_filters( 'wcb2bsa_has_role_customer', $roles )

By default, WooCommerce B2B Sales Agents allows you to assign commissions and access to dedicated dashboard to users with the default role "sales agent". Optionally, choose which roles you want to extend this behavior to.

You can customize roles by using dedicated hooks:

• apply_filters( 'wcb2bsa_has_role_sales_agent', $roles )

Choose base page for your sales agents dashboard area.

On new installations, WooCommerce B2B Sales Agents automatically create a new page named "Sales agents dashboard" as draft with the proper shortcode [woocommerce_my_account]. To enable, simply publish it.

You can customize link to dashboard message by using dedicated hooks:

• apply_filters( 'wcb2bsa_link_to_dashboard', $notice, $link, $button, $text )

Create an unique affiliation link (displayed in the sales agent dashboard) for each sales agents. When a customer uses the affiliate link to register an account, his profile will be assigned to the agent who owns used affiliate link.

You can customize affiliation link by using dedicated hooks:

• apply_filters( 'wcb2bsa_affiliate_baseurl', $url )
• apply_filters( 'wcb2bsa_affiliate_permalink', $url )
• apply_filters( 'wcb2bsa_affiliate_parameter', $parameter )
• apply_filters( 'wcb2bsa_affiliate_cookie_duration', $duration )

Allow sales agents to create new subagents, that will be automatically assigned to him.

Extends new subagent form adding checkout billing fields.

You can customize redirect by using dedicated hooks:

• apply_filters( 'wcb2bsa_new_subagent_form_fields', array $fields )

Allow sales agents to create new customers, that will be automatically assigned to him.

Extends new customer form adding checkout billing fields.

You can customize redirect by using dedicated hooks:

• apply_filters( 'wcb2bsa_new_customer_form_fields', array $fields )

Allow sales agents to update their customers order status.

Allow sales agents to add note to their customers order.

Allow select widgets to enable and display to sales agents.

Here is a list of all available widgets:

• Managed subagents number: number of sales agents that depend on current profile (subagents)
• Managed customers number: total number of customers managed by current profile.
  NB: this number includes both direct customers and customers assigned to subagents
• Total orders number: total number of orders managed by current profile.
  NB: this number includes both orders by direct customers and orders by customers assigned to subagents
• Total orders value: total amount value of orders managed by current profile.
  NB: this amount includes both orders by direct customers and orders by customers assigned to subagents
• Your earnings: total amount value of commissions virtually generated and assigned to current profile.
  NB: this amount includes only orders by direct customers and not orders by customers assigned to subagents NB: this amount doesn't indicate an actual and real profit, but only an assumed one, as it includes all commissions, regardless of the order status.
• Your paid earnings: total amount value of commissions deemed valid and already paid.
  NB: this amount includes only orders by direct customers and not orders by customers assigned to subagents
• Your pending earnings: total amount value of commissions deemed valid but not yet paid.
  NB: this amount includes only orders by direct customers and not orders by customers assigned to subagents
  NB: a commission is considered valid if order status is one of the following:
  • Completed
  • On hold
  • Pending
  • Processing
• Current commission percentage: global commission percentage on orders from customers directly assigned to current profile.
• Your subcommission earnings: total amount value of commissions virtually generated and assigned to current profile.
  NB: this amount includes only orders by customers assigned to subagents and not orders by direct customers NB: this amount doesn't indicate an actual and real profit, but only an assumed one, as it includes all commissions, regardless of the order status.
• Your paid subcommission earnings: total amount value of commissions deemed valid and already paid.
  NB: this amount includes only orders by customers assigned to subagents and not orders by direct customers
• Your pending subcommission earnings: total amount value of commissions deemed valid but not yet paid.
  NB: this amount includes only orders by customers assigned to subagents and not orders by direct customers
  NB: a commission is considered valid if order status is one of the following:
  • Completed
  • On hold
  • Pending
  • Processing
• Current subcommission percentage: global commission percentage on orders from customers assigned to a subagent.
• Total earnings: total amount value of commissions virtually generated and assigned to current profile.
  NB: this amount includes both orders by direct customers and orders by customers assigned to subagents (it's a sum of "Your earnings" and "Your subcommission earnings") NB: this amount doesn't indicate an actual and real profit, but only an assumed one, as it includes all commissions, regardless of the order status.
• Total paid earnings: total amount value of commissions deemed valid and already paid.
  NB: this amount includes both orders by direct customers and orders by customers assigned to subagents (it's a sum of "Your paid earnings" and "Your paid subcommission earnings")
• Total pending earnings: total amount value of commissions deemed valid but not yet paid.
  NB: this amount includes both orders by direct customers and orders by customers assigned to subagents (it's a sum of "Your pending earnings" and "Your pending subcommission earnings")
  NB: a commission is considered valid if order status is one of the following:
  • Completed
  • On hold
  • Pending
  • Processing

Allow select charts to enable and display to sales agents.

Allow to change sales agents area endpoint slugs.

Summary of templates status, with a list of templates overridden by your parent/child theme and a warning message that they need to be updated.

Assign a sales agent to customer.

Enable/Disable sales agent profile. If status is "Inactive", sales agent cannot login and work.

Unique identifier that allows to recognize the sales agent and assign a customer who registers through affiliate link.

Build you sales agents hierarchy by assigning a sales agent manager.

Assign a global commission to sales agent that will be apply on each purchase.

Assign a global subcommission to sales agent that will be apply on each purchase by his subagent customers.

If enabled, sales agent will receive new order notification when an assigned customer make a purchase.

Allows you to restrict the data used in orders and earnings list and in calculating the values of the widgets in the sales agents dashboard to specific time periods. Very useful in case of numerous orders to improve performance.

It allows you to make a note of the preferred payment method of the sales agent with the relevant data to make payments of the accrued commissions.

You can customize payment methods list by using dedicated hooks:

• apply_filters( 'wcb2bsa_payment_methods', array $methods )

Assign or change order sales agent.

Choose or change what to apply the commission to.

When a new order is placed, WooCommerce B2B Sales Agents establishes whether the order was placed by admin, or directly by the customer, or by the sales agent on behalf of the customer. It is possible to change this data.

Set for each product a minimum price, so sales agent can change the price in cart but without being able to go below the minimum price.

Set for each product custom commissions according to sales agent.

Allow coupon usage to customers assigned to selected sales agents. No sales agents selected means no restrictions.

Bulk update product commissions. WooCommerce B2B Sales Agents extends default WooCommerce Import/Export tools to allow to fast manage its custom data.

Allow to export commissions list in CSV file to statistics purposes.

Summarize sales grouped by sales agent, with total orders amount and total orders count.

You can upload your personal logo to display in sales agents area.

Create all the notifications you want to communicate with your sales agents and notify them of new offers, discounts, coupons etc.

Each notification can be assigned to one or more sales agents.

Here a filterable list of all commissions assigned to your sales agents.

You can set each commission as paid/unpaid to better manage your network.

Assign automatically customer to a B2B group when sales agent register a new customer account. Also available these special options:

• Allow to choose: add a dropdown menu in registration form, sales agents can choose group among those available

Assign a group commission to sales agent that will be apply on each purchase when customer belong the group.

WooCommerce B2B Sales Agents apply some own rules and functions only to default WooCommerce customer role and other functions only to sales_agent role. With this hook, you can extend these functions behaviour to custom roles.

apply_filters( 'wcb2bsa_has_role_customer', array $roles );
apply_filters( 'wcb2bsa_has_role_sales_agent', array $roles );

$roles = array( 'customer' );
$roles = array( 'sales_agent' );

To extend WooCommerce B2B Sales Agents sales agents role functions to a new custom role called "mycustomrole", you can add this code to your functions.php file:

add_filter( 'wcb2bsa_has_role_sales_agent', 'fn_wcb2bsa_has_role_sales_agent' );
function fn_wcb2bsa_has_role_sales_agent( $roles ) {
    $roles[] = 'mycustomrole';
    return $roles;
}

Customize sales agents dashboard by adding, modifying or removing widgets.

apply_filters( 'wcb2bsa_dashboard_widgets', array $widgets );

To change "Current commission percentage" label, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_dashboard_widgets', 'fn_wcb2bsa_dashboard_widgets' );
function fn_wcb2bsa_dashboard_widgets( $widgets ) {
    $widgets['widgets']['current_commissions']['label'] = __( 'New label', 'woocommerce-b2b-sales-agents' );
    return $widgets;
}

To remove "Pending commission value" widget, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_dashboard_widgets', 'fn_wcb2bsa_dashboard_widgets' );
function fn_wcb2bsa_dashboard_widgets( $widgets ) {
    unset( $widgets['widgets']['pending_commissions'] );
    return $widgets;
}

Here available widgets and charts:

• $widgets['widgets']['managed_subagents'] -> Managed subagents number
• $widgets['widgets']['managed_customers'] -> Managed customers number
• $widgets['widgets']['total_orders'] -> Total orders number
• $widgets['widgets']['total_amount'] -> Total orders value
• $widgets['widgets']['total_commissions'] -> Total direct commission value
• $widgets['widgets']['paid_commissions'] -> Paid direct commission value
• $widgets['widgets']['pending_commissions'] -> Pending direct commission value
• $widgets['widgets']['current_commission'] -> Current commission percentage
• $widgets['widgets']['total_subcommissions'] -> Total subcommission value
• $widgets['widgets']['paid_subcommissions'] -> Paid subcommission value
• $widgets['widgets']['pending_subcommissions'] -> Pending subcommission value
• $widgets['widgets']['current_subcommission'] -> Current subcommission percentage
• $widgets['widgets']['total_all_commissions'] -> Total commission value
• $widgets['widgets']['paid_all_commissions'] -> Paid commission value
• $widgets['widgets']['pending_all_commissions'] -> Pending commission value
• $widgets['stats']['subagents'] -> Subagents chart
• $widgets['stats']['customers'] -> Customers chart
• $widgets['stats']['commissions'] -> Commissions chart
• $widgets['stats']['orders'] -> Orders chart

Customize sales agents statistics parameters and data.

apply_filters( 'wcb2bsa_stats_params', array $params );

To change chart bar (line) color, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_stats_params', 'fn_wcb2bsa_stats_params' );
function fn_wcb2bsa_stats_params( $params ) {
    $params['data']['datasets'][0]['backgroundColor'] = 'rgba( 255, 0, 0, 0.5 )';
    return $params;
}

To know more about parameters, please refer to: ChartJS documentation.

Interactive tables allow you to have advanced filters and export functions, but with a large amount of data they can cause slowdowns in page loading. With this hook you can disable interactive tables to improve performance.

apply_filters( 'wcb2bsa_enable_interactive_dashboard', boolean $enable );

$enable = true

To disable interactive tables, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_enable_interactive_dashboard', 'fn_wcb2bsa_enable_interactive_dashboard' );
function fn_wcb2bsa_enable_interactive_dashboard( $enable ) {
    return false;
}

Or, alternatively:

add_filter( 'wcb2bsa_enable_interactive_dashboard', '__return_false' );

Customize sales agents area by adding, modifying or removing styles.

apply_filters( 'wcb2bsa_myaccount_styles', array $styles );

To add a new style, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_myaccount_styles', 'fn_wcb2bsa_myaccount_styles' );
function fn_wcb2bsa_myaccount_styles( $styles ) {
    $styles['style-name'] = 'style-url';
    return $styles;
}

To remove "Font Awesome" style, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_myaccount_styles', 'fn_wcb2bsa_myaccount_styles' );
function fn_wcb2bsa_myaccount_styles( $styles ) {
    unset( $styles['fontawesome'] );
    return $styles;
}

Customize sales agents area by adding, modifying or removing scripts.

apply_filters( 'wcb2bsa_myaccount_scripts', array $scripts );

To add a new script, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_myaccount_scripts', 'fn_wcb2bsa_myaccount_scripts' );
function fn_wcb2bsa_myaccount_scripts( $scripts ) {
    $scripts['script-name'] = 'script-url';
    return $scripts;
}

To remove "Chart JS" script, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_myaccount_scripts', 'fn_wcb2bsa_myaccount_scripts' );
function fn_wcb2bsa_myaccount_scripts( $scripts ) {
    unset( $scripts['chart'] );
    return $scripts;
}

Customize sales agents area logo by replacing with a new one. This override logo inserted by WordPress customizer.

apply_filters( 'wcb2bsa_myaccount_logo_url', string $logo_url );

To change logo, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_myaccount_logo_url', 'fn_wcb2bsa_myaccount_logo_url' );
function fn_wcb2bsa_myaccount_logo_url( $logo_url ) {
    return 'new-logo-url';
}

Customize sales agents area menu by managing items.

apply_filters( 'wcb2bsa_myaccount_menu_items', array $items );

To add a new menu link in "Main" section, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_myaccount_menu_items', 'fn_wcb2bsa_myaccount_menu_items' );
function fn_wcb2bsa_myaccount_menu_items( $items ) {
    $items['main']['entries']['new-endpoint-slug'] = array(
        'label'     => __( 'Title', 'woocommerce-b2b-sales-agents' ),
        'icon'      => 'fas fa-icon'
    );
    return $items;
}

To remove an item from menu in "Profile" section, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_myaccount_menu_items', 'fn_wcb2bsa_myaccount_menu_items' );
function fn_wcb2bsa_myaccount_menu_items( $items ) {
    unset( $items['profile']['entries']['sales-agent-edit-account'] );
    return $items;
}

Here $items structure:

$items = array(
    'main' => array(
        'label'     => esc_html__( 'Main', 'woocommerce-b2b-sales-agents' ),
        'entries'   => array(
            'sales-agent-dashboard'     => array(
                'label'     => esc_html__( 'Dashboard', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-tachometer-alt'
            ),
            'sales-agent-customers'     => array(
                'label'     => esc_html__( 'Customers', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-users'
            ),
            'sales-agent-orders'        => array(
                'label'     => esc_html__( 'Orders', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-shopping-cart'
            ),
            'sales-agent-earnings'   => array(
                'label'     => esc_html__( 'Earnings', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-wallet'
            ),
            'sales-agent-commissions'   => array(
                'label'     => esc_html__( 'Commissions', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-percentage'
            ),
            'sales-agent-notifications'   => array(
                'label'     => esc_html__( 'Notifications', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-bell',
                'counter'   => wcb2bsa_get_notifications_count_by_sales_agent()
            ),
            'sales-agent-statistics'   => array(
                'label'     => esc_html__( 'Statistics', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-chart-bar'
            )
        )
    ),
    'network' => array(
        'label'     => esc_html__( 'Network', 'woocommerce-b2b-sales-agents' ),
        'entries'   => array(
            'sales-agent-subagents'     => array(
                'label'     => esc_html__( 'Subagents', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-user-tie'
            )
        )
    ),
    'profile' => array(
        'label'     => esc_html__( 'Profile', 'woocommerce-b2b-sales-agents' ),
        'entries'   => array(
            'sales-agent-edit-account'  => array(
                'label'     => esc_html__( 'Account', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'far fa-id-badge'
            ),
            'sales-agent-logout'        => array(
                'label'     => esc_html__( 'Logout', 'woocommerce-b2b-sales-agents' ),
                'icon'      => 'fas fa-sign-out-alt'
            )
        )
    )
);

Allow to have different myaccount page templates for customers and sales agents, by changing template search folder from 'woocommerce' to 'woocommerce-b2b-sales-agents'.

apply_filters( 'wcb2bsa_template_override_sales_agent', array $override );

If you want to create a different template for new order email received by customer, when order is created by sales agent, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_template_override_sales_agent', 'fn_wcb2bsa_template_override_sales_agent' );
function fn_wcb2bsa_template_override_sales_agent( $override ) {
    $override[] = 'emails/customer-on-hold-order.php';
    return $override;
}

In this way:

• if order is created by customer, "customer-on-hold-order.php" file used to generate email will located in {YOUR_THEME}/woocommerce/emails folder
• if order is created by sales agent, "customer-on-hold-order.php" file used to generate email will located in {YOUR_THEME}/woocommerce-b2b-sales-agents/emails folder

So you can feel free to customize WooCommerce templates according to user role.

When a sales agent switch on customer account, cart is emptied by default. However, it is possible to change this behavior, avoiding the removal of products previously placed in the cart by the customer.

apply_filters( 'wcb2bsa_empty_cart_on_switch', boolean $empty );

$empty = true

If you don't want to empty cart when a sales agent switch on customer account, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_empty_cart_on_switch', '__return_false' );

Allow to set a custom page URL where redirect sales agents after they switch as customer.

apply_filters( 'wcb2bsa_switch_to_customer_redirect', string $permalink );

If you want to redirect sales agents to homepage instead of shop page, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_switch_to_customer_redirect', 'fn_wcb2bsa_switch_to_customer_redirect' );
function fn_wcb2bsa_switch_to_customer_redirect( $permalink ) {
    return get_home_url();
}

Allow to set a custom page URL where redirect sales agents after they switch from customer to return on their own area.

apply_filters( 'wcb2bsa_switch_to_sales_agent_redirect', string $permalink );

If you want to redirect sales agents to customers page instead of dashboard, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_switch_to_sales_agent_redirect', 'fn_wcb2bsa_switch_to_sales_agent_redirect' );
function fn_wcb2bsa_switch_to_sales_agent_redirect( $permalink ) {
    return wc_get_endpoint_url( 'sales-agent-customers', '', wc_get_page_permalink( 'myaccount' ) );
}

To translate advanced tables labels (ie: "Search", "Export", "View", etc.), you first need to create a new folder (ie: wcb2bsa) in your theme folder (we suggest to create it in a child theme). Now, copy 'woocommerce-b2b-sales-agents/https://woocommerce-b2b.com/sales-agents/wp-content/docs/woocommerce-b2b-sales-agents/assets/vendor/datatables/i18n/en_US.json' file into this new folder and rename the file with your desired language code (ie: it_IT.json). Finally, edit this file and translare strings on right side. To have an example and know more about, please take a look to: DataTables internationalisation.

apply_filters( 'wcb2bsa_dt_i18n_folder', string $url );

If you have: 'wp-content/themes/child-theme/wcb2bsa/xx_XX.json', you can add this code to your functions.php file:

add_filter( 'wcb2bsa_dt_i18n_folder', 'fn_wcb2bsa_dt_i18n_folder' );
function fn_wcb2bsa_dt_i18n_folder( $url ) {
    // https://www.example.com/wp-content/themes/child-theme/wcb2bsa/xx_XX.json
    return get_stylesheet_directory_uri() . '/wcb2bsa/' . get_locale() . '.json';
}

If you prefer, you can also insert a CDN or external URL to JSON translation file.

Customize sales agents assigned subagents list.

apply_filters( 'wcb2bsa_get_subagents_by_sales_agent_args', array $args, int $sales_agent_id );

To exclude a specific user by ID, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_get_subagents_by_sales_agent_args', 'fn_wcb2bsa_get_subagents_by_sales_agent_args', 10, 2 );
function fn_wcb2bsa_get_subagents_by_sales_agent_args( $args, $sales_agent_id ) {
    $args['exclude'] = array( 10 );
    return $args;
}

To know more about $args allowed fields, please refer to WP_User_Query official documentation.

Customize sales agents assigned customers list.

apply_filters( 'wcb2bsa_get_customers_by_sales_agent_args', array $args, int $sales_agent_id );

To exclude a specific user by ID, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_get_customers_by_sales_agent_args', 'fn_wcb2bsa_get_customers_by_sales_agent_args', 10, 2 );
function fn_wcb2bsa_get_customers_by_sales_agent_args( $args, $sales_agent_id ) {
    $args['exclude'] = array( 10 );
    return $args;
}

To know more about $args allowed fields, please refer to WP_User_Query official documentation.

Customize sales agents assigned orders list.

apply_filters( 'wcb2bsa_get_orders_by_sales_agent_args', array $args, int $sales_agent_id );

To get orders with Direct bank transfer payment method, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_get_orders_by_sales_agent_args', 'fn_wcb2bsa_get_orders_by_sales_agent_args', 10, 2 );
function fn_wcb2bsa_get_orders_by_sales_agent_args( $args, $sales_agent_id ) {
    $args['payment_method'] = 'bacs';
    return $args;
}

To know more about $args allowed fields, please refer to WC_Order_Query official documentation.

Customize sales agents assigned notifications list.

apply_filters( 'wcb2bsa_get_notifications_by_sales_agent_args', array $args, int $sales_agent_id );

To exclude a specific notification by ID, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_get_notifications_by_sales_agent_args', 'fn_wcb2bsa_get_notifications_by_sales_agent_args', 10, 2 );
function fn_wcb2bsa_get_notifications_by_sales_agent_args( $args, $sales_agent_id ) {
    $args['exclude'] = array( 10 );
    return $args;
}

To know more about $args allowed fields, please refer to WP_User_Query official documentation.

Decide which orders include in pending commission calculation by order status.

apply_filters( 'wcb2bsa_include_orders_in_pending_commissions_by_status', array $statuses, int $sales_agent_id );

To remove "on-hold" orders from pending commission totals, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_include_orders_in_pending_commissions_by_status', 'fn_wcb2bsa_include_orders_in_pending_commissions_by_status', 10, 2 );
function fn_wcb2bsa_include_orders_in_pending_commissions_by_status( $statuses, $sales_agent_id ) {
    if ( ( $key = array_search( 'on-hold', $statuses ) ) !== false ) {
        unset( $statuses[$key] );
    }
    return $statuses;
}

Default statuses included in pending commission totals are:

• completed
• on-hold
• pending
• processing

Decide which orders exclude in total orders amount calculation by order status.

apply_filters( 'wcb2bsa_exclude_orders_in_totals_by_status', array $statuses, int $sales_agent_id );

To add "on-hold" orders in sales agent total orders amount, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_exclude_orders_in_totals_by_status', 'fn_wcb2bsa_exclude_orders_in_totals_by_status', 10, 2 );
function fn_wcb2bsa_exclude_orders_in_totals_by_status( $statuses, $sales_agent_id ) {
    $statuses[] = 'on-hold';
    return $statuses;
}

Default statuses excluded in sales agent total orders amount are:

• cancelled
• failed
• refunded

You can choose to don't apply a commission to order item type in WooCommerce B2B Sales Agents settings page, but if you install a third part plugin that add some custom item types in orders, you you may want apply sales agents commission on these new items.

apply_filters( 'wcb2bsa_order_item_types_eligible_for_commission', array $items );

To add a new item type in setting eligible items for commission, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_order_item_types_eligible_for_commission', 'fn_wcb2bsa_order_item_types_eligible_for_commission' );
function fn_wcb2bsa_order_item_types_eligible_for_commission( $items ) {
    $items['item-slug'] = __( 'Item name', woocommerce-b2b-sales-agents );
    return $items;
}

Default items are those provided by WooCommerce:

• Products
• Fees
• Shipping costs

Customize price input field added in cart page by changing arguments.

apply_filters( 'wcb2bsa_cart_input', array $args );

$args = array(
    'class' => 'input-text text',
    'min'   => '0',
    'step'  => '0.01'
);

To add a custom class to improve your theme compatibility, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_cart_input', 'fn_wcb2bsa_cart_input' );
function fn_wcb2bsa_cart_input( $args ) {
    $args['class'] .= ' my-custom-class';
    return $args;
}

When page used as sales agents dashboard is not WooCommerce default myaccount page, a notice appears with a link to dashboard.

apply_filters( 'wcb2bsa_link_to_dashboard', string $notice, string $link, string $button, string $text );

$notice = sprintf(
    '<a href="%s" class="button wc-forward">%s</a> %s',
    $link,
    $button,
    $text
);
$link = get_permalink( get_option( 'wcb2bsa_dashboard_page' ) );
$button = __( 'View dashboard', 'woocommerce-b2b-sales-agents' );
$text = __( 'Looking for your sales agent dashboard?', 'woocommerce-b2b-sales-agents' );

To change notice, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_link_to_dashboard', 'fn_wcb2bsa_link_to_dashboard', 10, 4 );
function fn_wcb2bsa_link_to_dashboard( $notice, $link, $button, $text ) {
    $text = __( 'Go to your sales agent dashboard!', 'woocommerce-b2b-sales-agents' );
    return sprintf(
        '<a href="%s" class="button wc-forward">%s</a> %s',
        $link,
        $button,
        $text
    );
}

To remove notice, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_link_to_dashboard', '__return_false' );

Lets you edit the link to the affiliation landing page.

apply_filters( 'wcb2bsa_affiliate_baseurl', string $url );

To change URL, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_affiliate_baseurl', 'fn_wcb2bsa_affiliate_baseurl' );
function fn_wcb2bsa_affiliate_baseurl( $url ) {
    // https://www.example.com/my-registration-page, Page ID 100 
    return get_the_permalink( 100 );
}

Lets you edit the final link to the affiliation landing page, for example to add custom parameters.

apply_filters( 'wcb2bsa_affiliate_permalink', string $url );

To change URL, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_affiliate_permalink', 'fn_wcb2bsa_affiliate_permalink' );
function fn_wcb2bsa_affiliate_permalink( $url ) {
    return $url.'&mycustomparameter=value';
}

Lets you change URL parameter name in affiliate link.

apply_filters( 'wcb2bsa_affiliate_parameter', string $parameter );

$parameter = 'wcb2bsa_affiliate';

To change URL parameter, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_affiliate_parameter', 'fn_wcb2bsa_affiliate_parameter' );
function fn_wcb2bsa_affiliate_parameter( $parameter ) {
    return 'custom_parameter_name';
}

Lets you change affiliation cookie duration (in seconds).

apply_filters( 'wcb2bsa_affiliate_cookie_duration', int $duration );

$duration = 3600;

To change affiliation cookie duration, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_affiliate_cookie_duration', 'fn_wcb2bsa_affiliate_cookie_duration' );
function fn_wcb2bsa_affiliate_cookie_duration( $duration ) {
    return 7200;
}

Customize sales agent status to improve account moderation management.

apply_filters( 'wcb2bsa_sales_agent_statuses', array $statuses );

$statuses = array(
    0 => esc_html__( 'Inactive', 'woocommerce-b2b-sales-agents' ),
    1 => esc_html__( 'Active', 'woocommerce-b2b-sales-agents' )
);

To add a custom status, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_sales_agent_statuses', 'fn_wcb2bsa_sales_agent_statuses' );
function fn_wcb2bsa_sales_agent_statuses( $statuses ) {
    $statuses[3] = esc_html__( 'Pending', 'woocommerce-b2b-sales-agents' );
    return $statuses;
}

Send an email notification to sales agent when his account is activated.

apply_filters( 'wcb2bsa_send_activation_notification', bool $send );

$send = true;

To don't send any email notification to sales agent when his account his active, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_send_activation_notification', 'fn_wcb2bsa_send_activation_notification' );
function fn_wcb2bsa_send_activation_notification( $send ) {
    return false;
}

Or, alternatively:

add_filter( 'wcb2bsa_send_activation_notification', '__return_false' );

Used to manage new subagent form fields when extended form is enabled.

apply_filters( 'wcb2bsa_new_subagent_form_fields', array $fields );

To make phone number required, you can add this code to your functions.php file:

add_action( 'wcb2bsa_new_subagent_form_fields', 'fn_wcb2bsa_new_subagent_form_fields' );
function fn_wcb2bsa_new_subagent_form_fields( $fields ) {
    $fields['billing_phone']['required'] = true;
    return $fields;
}

To remove phone field in extended form, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_new_subagent_form_fields', 'fn_wcb2bsa_new_subagent_form_fields' );
function fn_wcb2bsa_new_subagent_form_fields( $fields ) {
    unset( $fields['billing_phone'] );
    return $fields;
}

Used to manage new subagent form fields arguments to customize fields.

apply_filters( 'wcb2bsa_new_subagent_form_fields_args', array $args );

To apply a custom class to new subagent form fields container, you can add this code to your functions.php file:

add_action( 'wcb2bsa_new_subagent_form_fields_args', 'fn_wcb2bsa_new_subagent_form_fields_args' );
function fn_wcb2bsa_new_subagent_form_fields_args( $args ) {
    $args['class'] = array( 'my_custom_class' );
    return $args;
}

Triggered in sales agents dedicated area in new subagent form modal.

do_action( 'wcb2bsa_new_subagent_form' );

To add a new callback, you can add this code to your functions.php file:

add_action( 'wcb2bsa_new_subagent_form', 'fn_wcb2bsa_new_subagent_form' );
function fn_wcb2bsa_new_subagent_form() {
    // Make action magic happen here...
}

Used to manage new customer form fields when extended form is enabled.

apply_filters( 'wcb2bsa_new_customer_form_fields', array $fields );

To make phone number required, you can add this code to your functions.php file:

add_action( 'wcb2bsa_new_customer_form_fields', 'fn_wcb2bsa_new_customer_form_fields' );
function fn_wcb2bsa_new_customer_form_fields( $fields ) {
    $fields['billing_phone']['required'] = true;
    return $fields;
}

To remove phone field in extended form, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_new_customer_form_fields', 'fn_wcb2bsa_new_customer_form_fields' );
function fn_wcb2bsa_new_customer_form_fields( $fields ) {
    unset( $fields['billing_phone'] );
    return $fields;
}

Used to manage new customer form fields arguments to customize fields.

apply_filters( 'wcb2bsa_new_customer_form_fields_args', array $args );

To apply a custom class to new customer form fields container, you can add this code to your functions.php file:

add_action( 'wcb2bsa_new_customer_form_fields_args', 'fn_wcb2bsa_new_customer_form_fields_args' );
function fn_wcb2bsa_new_customer_form_fields_args( $args ) {
    $args['class'] = array( 'my_custom_class' );
    return $args;
}

Triggered in sales agents dedicated area in new customer form modal.

do_action( 'wcb2bsa_new_customer_form' );

To add a new callback, you can add this code to your functions.php file:

add_action( 'wcb2bsa_new_customer_form', 'fn_wcb2bsa_new_customer_form' );
function fn_wcb2bsa_new_customer_form() {
    // Make action magic happen here...
}

Manage payment methods available list for sales agents.

apply_filters( 'wcb2bsa_payment_methods', array $methods );

$methods = array(
    'paypal' => __( 'Paypal', 'woocommerce-b2b-sales-agents' ),
    'bankwire' => __( 'Bankwire', 'woocommerce-b2b-sales-agents' )
);

add_action( 'wcb2bsa_payment_methods', 'fn_wcb2bsa_payment_methods' );
function fn_wcb2bsa_payment_methods( $methods ) {
    $methods['custom_payment_method'] = __( 'Custom payment method', 'woocommerce-b2b-sales-agents' );
    return $methods;
}

add_action( 'wcb2bsa_payment_methods', 'fn_wcb2bsa_payment_methods' );
function fn_wcb2bsa_payment_methods( $methods ) {
    unset( $methods['paypal'] );
    return $methods;
}

Manage query arguments in admin commissions list.

apply_filters( 'wcb2bsa_admin_commissions_page_args', $args );

To show 50 rows, you can add this code to your functions.php file:

add_action( 'wcb2bsa_admin_commissions_page_args', 'fn_wcb2bsa_admin_commissions_page_args' );
function fn_wcb2bsa_admin_commissions_page_args( $args ) {
    $args['limit'] = 50;
    return $args;
}

If true, allow sales agent to see his own subagents orders and customers data in dashboard lists.

apply_filters( 'wcb2bsa_subagents_full_hierarchy', true );

To disallow all sales agents to add subagents orders/customers, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_subagents_full_hierarchy', 'fn_wcb2bsa_subagents_full_hierarchy' );
function fn_wcb2bsa_subagents_full_hierarchy( $allow ) {
    return false;
}

Or, alternatively:

add_filter( 'wcb2bsa_subagents_full_hierarchy', '__return_false' );

If true, allow sales agent to see his own subagents orders and customers data.

apply_filters( 'wcb2bsa_subagents_hierarchy_readable', true );

To disallow sales agents to see subagents orders/customers, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_subagents_hierarchy_readable', 'fn_wcb2bsa_subagents_hierarchy_readable' );
function fn_wcb2bsa_subagents_hierarchy_readable( $allow ) {
    return false;
}

Or, alternatively:

add_filter( 'wcb2bsa_subagents_hierarchy_readable', '__return_false' );

If true, allow sales agent to edit his own subagents orders and customers data. If false, for example, sales agents cannot change his subagents orders status or add note.

apply_filters( 'wcb2bsa_subagents_hierarchy_writable', true );

To disallow sales agents to edit subagents orders/customers, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_subagents_hierarchy_writable', 'fn_wcb2bsa_subagents_hierarchy_writable' );
function fn_wcb2bsa_subagents_hierarchy_writable( $allow ) {
    return false;
}

Or, alternatively:

add_filter( 'wcb2bsa_subagents_hierarchy_writable', '__return_false' );

Output generator tag in website head to aid debugging.

apply_filters( 'wcb2bsa_show_generator_tag', boolean $show );

$show = true;

To remove generator tag, you can add this code to your functions.php file:

add_filter( 'wcb2bsa_show_generator_tag', 'fn_wcb2bsa_show_generator_tag' );
function fn_wcb2bsa_show_generator_tag( $show ) {
    return false;
}

Or, alternatively:

add_filter( 'wcb2bsa_show_generator_tag', '__return_false' );

Triggered when WordPress initialises.

do_action( 'wcb2bsa_before_init' );

To add a new callback, you can add this code to your functions.php file:

add_action( 'wcb2bsa_before_init', 'fn_wcb2bsa_before_init' );
function fn_wcb2bsa_before_init() {
    // Make action magic happen here...
}

Triggered after plugin has initialized.

do_action( 'wcb2bsa_init' );

To add a new callback, you can add this code to your functions.php file:

add_action( 'wcb2bsa_init', 'fn_wcb2bsa_init' );
function fn_wcb2bsa_init() {
    // Make action magic happen here...
}

Triggered when plugin has loaded.

do_action( 'wcb2bsa_loaded' );

To add a new callback, you can add this code to your functions.php file:

add_action( 'wcb2bsa_wcb2bsa_loaded', 'fn_wcb2bsa_loaded' );
function fn_wcb2bsa_loaded() {
    // Make action magic happen here...
}

Triggered in sales agents dedicated area to print styles.

do_action( 'wcb2bsa_print_styles' );

To add a new callback, you can add this code to your functions.php file:

add_action( 'wcb2bsa_print_styles', 'fn_wcb2bsa_print_styles' );
function fn_wcb2bsa_print_styles() {
    // Make action magic happen here...
}

Triggered in sales agents dedicated area to print scripts.

do_action( 'wcb2bsa_print_scripts' );

To add a new callback, you can add this code to your functions.php file:

add_action( 'wcb2bsa_print_scripts', 'fn_wcb2bsa_print_scripts' );
function fn_wcb2bsa_print_scripts() {
    // Make action magic happen here...
}

This API lets you retrieve and view all products or a specific product by ID.

WooCommerce B2B Sales Agents available meta fields:

• wcb2bsa_min_price: contains product minimum price allowed to sales agents when they edit prices in cart.
  Value is a floating number
  In API GET response, has also a dedicated field alias named "wcb2bsa_min_price"
• wcb2bsa_commissions: contains dedicated commissions by sales agent.
  Value is an associative array with SALES AGENT ID as key and commission percentage as value (it's a floating number).
  In API GET response, has also a dedicated field alias named "wcb2bsa_commissions"

Note: WooCommerce B2B Sales Agents extends default WooCommerce products REST API with own custom meta fields. For more informations, please visit: WooCommerce Official documentation

{
    "id": 60,
    "name": "T-Shirt with Logo",
    "slug": "t-shirt-with-logo",
    "permalink": "https://demo.woocommerce-b2b.com/product/t-shirt-with-logo/",
    "date_created": "2020-06-13 00:00:00",
    "date_created_gmt": "2020-06-13 00:00:00",
    "date_modified": "2020-06-13 00:00:00",
    "date_modified_gmt": "2020-06-13 00:00:00",
    "type": "simple",
    "status": "publish",
    "featured": false,
    "catalog_visibility": "visible",
    "description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
    "short_description": "<p>This is a simple product.</p>\n",
    "sku": "Woo-tshirt-logo",
    "price": "98",
    "regular_price": "100",
    "sale_price": "98",
    "date_on_sale_from": null,
    "date_on_sale_from_gmt": null,
    "date_on_sale_to": null,
    "date_on_sale_to_gmt": null,
    "price_html": "<del><span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">$</span>100.00</span></del> <ins><span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">$</span>98.00</span></ins>",
    "on_sale": true,
    "purchasable": true,
    "total_sales": 0,
    "virtual": false,
    "downloadable": false,
    "downloads": [],
    "download_limit": 0,
    "download_expiry": 0,
    "external_url": "",
    "button_text": "",
    "tax_status": "taxable",
    "tax_class": "",
    "manage_stock": false,
    "stock_quantity": null,
    "stock_status": "instock",
    "backorders": "no",
    "backorders_allowed": false,
    "backordered": false,
    "sold_individually": false,
    "weight": "",
    "dimensions": {
        "length": "10",
        "width": "12",
        "height": "0.5"
    },
    "shipping_required": true,
    "shipping_taxable": true,
    "shipping_class": "",
    "shipping_class_id": 0,
    "reviews_allowed": true,
    "average_rating": "0.00",
    "rating_count": 0,
    "related_ids": [
        50,
        40,
        43,
        51
    ],
    "upsell_ids": [],
    "cross_sell_ids": [],
    "parent_id": 0,
    "purchase_note": "",
    "categories": [
        {
            "id": 20,
            "name": "Tshirts",
            "slug": "tshirts-clothing"
        }
    ],
    "tags": [],
    "images": [
        {
            "id": 83,
            "date_created": "2020-06-13 00:00:00",
            "date_created_gmt": "2020-06-13 00:00:00",
            "date_modified": "2020-06-13 00:00:00",
            "date_modified_gmt": "2020-06-13 00:00:00",
            "src": "https://demo.woocommerce-b2b.com/wp-content/uploads/2020/06/t-shirt-with-logo-1.jpg",
            "name": "t-shirt-with-logo-1.jpg",
            "alt": ""
        }
    ],
    "attributes": [
        {
            "id": 1,
            "name": "Color",
            "position": 0,
            "visible": true,
            "variation": false,
            "options": [
                "Gray"
            ]
        }
    ],
    "default_attributes": [],
    "variations": [],
    "grouped_products": [],
    "menu_order": 0,
    "meta_data": [
        {
            "id": 967,
            "key": "_wpcom_is_markdown",
            "value": "1"
        },
        {
            "id": 3156,
            "key": "wcb2bsa_commissions",
            "value": {
                "9": "10"
            }
        },
        {
            "id": 3157,
            "key": "wcb2bsa_min_price",
            "value": "80"
        }
    ],
    "wcb2bsa_commissions": [
        {
            "9": 10
        }
    ],
    "wcb2bsa_min_price": "80",
    "_links": {
        "self": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/products/60"
            }
        ],
        "collection": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/products"
            }
        ]
    }
}

This API lets you retrieve and view all customers or a specific customer by ID.

WooCommerce B2B Sales Agents available meta fields:

• wcb2bsa_status: contains sales agent status (if moderate registration is enabled).
  Value can be 0 (=disabled) or 1 (=enabled)
  In API GET response, has also a dedicated field alias named "wcb2bsa_status"
• wcb2bsa_affiliate_id: contains unique affiliation code used for customer assignment (only for sales agents).
  Value is a string
  In API GET response, has also a dedicated field alias named "wcb2bsa_affiliate_id"
• wcb2bsa_affiliate_link: contains sales agent unique affiliation link (only for sales agents).
  Value is a URL
  In API GET response, has also a dedicated field alias named "wcb2bsa_affiliate_link"
• wcb2bsa_sales_agent_parent: contains assigned manager sales agent ID (only for sales agents).
  Value is an integer number
  In API GET response, has also a dedicated field alias named "wcb2bsa_sales_agent_parent"
• wcb2bsa_commission: contains global commission percentage (only for sales agents).
  Value is a floating number
  In API GET response, has also a dedicated field alias named "wcb2bsa_commission"
• wcb2bsa_subcommission: contains global subcommission percentage (only for sales agents).
  Value is a floating number
  In API GET response, has also a dedicated field alias named "wcb2bsa_subcommission"
• wcb2bsa_order_notification: contains order notification status (only for sales agents).
  Value can be 0 (=disabled) or 1 (=enabled)
  In API GET response, has also a dedicated field alias named "wcb2bsa_order_notification"
• wcb2bsa_dashboard_period: contains period to consider for dashboard data (only for sales agents).
  Value can be:
  • "e": Ever
  • "d": Today
  • "w": Current week
  • "m": Current month
  • "y": Current year
  
  In API GET response, has also a dedicated field alias named "wcb2bsa_dashboard_period"
• wcb2bsa_payment_method: contains sales agent preferred payment method (only for sales agents).
  Value is a string
  In API GET response, has also a dedicated field alias named "wcb2bsa_payment_method"
• wcb2bsa_payment_method_info: contains sales agent preferred payment method info note (only for sales agents).
  Value is a string
  In API GET response, has also a dedicated field alias named "wcb2bsa_payment_method_info"
• wcb2bsa_parents: contains parent sales agent ID (only for sales agents).
  Value is an array with parent sales agents IDs
  In API GET response, has also a dedicated field alias named "wcb2bsa_sales_agent"
• wcb2bsa_subagents: contains subagents sales agent IDs (only for sales agents).
  Value is an array with subagents IDs
  In API GET response, has also a dedicated field alias named "wcb2bsa_subagents"
• wcb2bsa_customers_default_group: contains default group assigned to customers registered by sales agent (only for sales agents / Only if WooCommerce B2B is installed).
  Value is an integer number or a string ("choose")
  In API GET response, has also a dedicated field alias named "wcb2bsa_customers_default_group"
• wcb2bsa_sales_agent: contains assigned sales agent ID (only for customers).
  Value is an integer number
  In API GET response, has also a dedicated field alias named "wcb2bsa_sales_agent"

Note: WooCommerce B2B Sales Agents extends default WooCommerce products REST API with own custom meta fields. For more informations, please visit: WooCommerce Official documentation

{
    "id": 2,
    "date_created": "2020-06-13T00:00:0",
    "date_created_gmt": "2020-06-13T00:0:0",
    "date_modified": "2020-06-13T00:00:00",
    "date_modified_gmt": "2020-06-13T00:00:00",
    "email": "customer@woocommerce-b2b.com",
    "first_name": "John",
    "last_name": "Doe",
    "role": "customer",
    "username": "customer",
    "billing": {
        "first_name": "John",
        "last_name": "Doe",
        "company": "Google LLC",
        "address_1": "Central Park, 1",
        "address_2": "",
        "city": "New York",
        "postcode": "10001",
        "country": "US",
        "state": "NY",
        "email": "customer@woocommerce-b2b.com",
        "phone": "212-223-6457"
    },
    "shipping": {
        "first_name": "John",
        "last_name": "Doe",
        "company": "Google LLC",
        "address_1": "Central Park, 1",
        "address_2": "",
        "city": "New York",
        "postcode": "10001",
        "country": "US",
        "state": "NY"
    },
    "is_paying_customer": true,
    "avatar_url": "https://secure.gravatar.com/avatar/25c626881bff6847aa6efc0820f01ec5?s=96&d=mm&r=g",
    "meta_data": [
        {
            "id": 62,
            "key": "wc_last_active",
            "value": "1592092800"
        },
        {
        "id": 353,
            "key": "shipping_method",
            "value": [
                "flat_rate:2"
            ]
        },
        {
            "id": 880,
            "key": "wcb2bsa_sales_agent",
            "value": "9"
        }
    ],
    "wcb2bsa_sales_agent": 9,
    "_links": {
        "self": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/customers/2"
            }
        ],
        "collection": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/customers"
            }
        ]
    }
}

{
    "id": 3,
    "date_created": "2020-06-13T00:00:0",
    "date_created_gmt": "2020-06-13T00:0:0",
    "date_modified": "2020-06-13T00:00:00",
    "date_modified_gmt": "2020-06-13T00:00:00",
    "email": "sales@woocommerce-b2b.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "role": "sales_agent",
    "username": "sales",
    "billing": {
        "first_name": "Jane",
        "last_name": "Doe",
        "company": "Google LLC",
        "address_1": "Central Park, 1",
        "address_2": "",
        "city": "New York",
        "postcode": "10001",
        "country": "US",
        "state": "NY",
        "email": "sales@woocommerce-b2b.com",
        "phone": "212-223-6457",
        "vat_number": "0987654321"
    },
    "shipping": {
        "first_name": "Jane",
        "last_name": "Doe",
        "company": "Google LLC",
        "address_1": "Central Park, 1",
        "address_2": "",
        "city": "New York",
        "postcode": "10001",
        "country": "US",
        "state": "NY"
    },
    "is_paying_customer": true,
    "avatar_url": "https://secure.gravatar.com/avatar/25c626881bff6847aa6efc0820f01ec5?s=96&d=mm&r=g",
    "meta_data": [
        {
            "id": 62,
            "key": "wc_last_active",
            "value": "1592092800"
        },
        {
            "id": 848,
            "key": "wcb2bsa_status",
            "value": "1"
        },
        {
            "id": 878,
            "key": "wcb2bsa_affiliate_id",
            "value": "c2FsZXNAd29vY29tbWVyY2UtYjJiLmNvbXwz"
        },
        {
            "id": 910,
            "key": "wcb2bsa_affiliate_link",
            "value": "https://demo.woocommerce-b2b.com/sales-agents/my-account/?wcb2bsa_affiliate=c2FsZXNAd29vY29tbWVyY2UtYjJiLmNvbXwxNA="
        },
        {
            "id": 880,
            "key": "wcb2bsa_commission",
            "value": "10"
        },
        {
            "id": 881,
            "key": "wcb2bsa_subcommission",
            "value": "5"
        },
        {
            "id": 890,
            "key": "wcb2bsa_order_notification",
            "value": "0"
        },
        {
            "id": 891,
            "key": "wcb2bsa_dashboard_period",
            "value": "m"
        },
        {
            "id": 353,
            "key": "wcb2bsa_payment_method",
            "value": "paypal"
        },
        {
            "id": 354,
            "key": "wcb2bsa_payment_method_info",
            "value": "Payment email: sales@paypal.com"
        },
        {
            "id": 900,
            "key": "wcb2bsa_customers_default_group",
            "value": "74"
        },
        {
            "id": 903,
            "key": "wcb2bsa_sales_agent_parent",
            "value": "32"
        },
        {
            "id": 904,
            "key": "wcb2bsa_subagents",
            "value": [
                "44",
                "46",
                "77"
            ]
        }
    ],
    "wcb2bsa_status": "1",
    "wcb2bsa_affiliate_id": "c2FsZXNAd29vY29tbWVyY2UtYjJiLmNvbXwz",
    "wcb2bsa_affiliate_link": "https://demo.woocommerce-b2b.com/sales-agents/my-account/?wcb2bsa_affiliate=c2FsZXNAd29vY29tbWVyY2UtYjJiLmNvbXwxNA=",
    "wcb2bsa_commission": "10",
    "wcb2bsa_subcommission": "5",
    "wcb2bsa_order_notification": "0",
    "wcb2bsa_dashboard_period": "m",
    "wcb2bsa_payment_method": "paypal",
    "wcb2bsa_payment_method_info": "Payment email: sales@paypal.com",
    "wcb2bsa_customers_default_group": 74,
    "wcb2bsa_parents": [
        "32"
    ],
    "wcb2bsa_subagents": [
        "44",
        "46",
        "77"
    ],
    "_links": {
        "self": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/customers/3"
            }
        ],
        "collection": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/customers"
            }
        ]
    }
}

This API lets you retrieve and view all orders or a specific order by ID.

WooCommerce B2B Sales Agents available meta fields:

• wcb2bsa_sales_agent: contains assigned sales agent ID when order placed.
  Value is an integer number
  In API GET response, has also a dedicated field alias named "wcb2bsa_sales_agent"
• wcb2bsa_order_item_types_eligible_for_commission: contains item types on which commissions can be applied and calculated when order placed.
  Value is an associative array with ITEM TYPE as key and enabled flag as value (it's a tinyint number, 0 (=disabled) or 1 (=enabled)).
  In API GET response, has also a dedicated field alias named "wcb2bsa_order_item_types_eligible_for_commission"
• wcb2bsa_created_by: contains who created the order.
  Value is a string, can be "customer", "sales_agent", "admin"
  In API GET response, has also a dedicated field alias named "wcb2bsa_created_by"

Each "line_items" contains specific meta fields:

• wcb2bsa_item_commission: contains single item percentage commission when order placed.
  Value is an floating number
• wcb2bsa_custom_price: contains if item price has been altered and customized by sales agent in cart when order placed.
  Value is a boolean

Note: WooCommerce B2B Sales Agents extends default WooCommerce products REST API with own custom meta fields. For more informations, please visit: WooCommerce Official documentation

{
    "id": 101,
    "parent_id": 0,
    "number": "101",
    "order_key": "wc_order_AZ59JpOFpEQcv",
    "created_via": "checkout",
    "version": "4.3.0",
    "status": "completed",
    "currency": "USD",
    "date_created": "2020-06-13T02:00:0",
    "date_created_gmt": "2020-06-13T00:00:0",
    "date_modified": "2020-06-13T02:00:0",
    "date_modified_gmt": "2020-06-13T00:00:0",
    "discount_total": "0.00",
    "discount_tax": "0.00",
    "shipping_total": "20.00",
    "shipping_tax": "4.40",
    "cart_tax": "51.12",
    "total": "307.90",
    "total_tax": "55.52",
    "prices_include_tax": true,
    "customer_id": 2,
    "customer_ip_address": "***",
    "customer_user_agent": "***",
    "customer_note": "",
    "billing": {
        "first_name": "John",
        "last_name": "Doe",
        "company": "Google LLC",
        "address_1": "Central Park, 1",
        "address_2": "",
        "city": "New York",
        "state": "NY",
        "postcode": "10001",
        "country": "US",
        "email": "customer@woocommerce-b2b.com",
        "phone": "2122236457"
    },
    "shipping": {
        "first_name": "John",
        "last_name": "Doe",
        "company": "Google LLC",
        "address_1": "Central Park, 1",
        "address_2": "",
        "city": "New York",
        "state": "NY",
        "postcode": "10001",
        "country": "US"
    },
    "payment_method": "bacs",
    "payment_method_title": "Direct bank transfer",
    "transaction_id": "",
    "date_paid": "2020-06-13T02:00:0",
    "date_paid_gmt": "2020-06-13T00:00:0",
    "date_completed": "2020-06-13T02:00:0",
    "date_completed_gmt": "2020-06-13T00:00:0",
    "cart_hash": "4c4d2a2498f758a949a05f83a439b8e5",
    "meta_data": [
        {
            "id": 1068,
            "key": "wcb2bsa_sales_agent",
            "value": "3"
        },
        {
            "id": 1069,
            "key": "wcb2bsa_order_item_types_eligible_for_commission",
            "value": {
                "line_item": "1",
                "fee": "1",
                "shipping": "1"
            }
        },
        {
            "id": 1487,
            "key": "wcb2bsa_created_by",
            "value": "sales_agent"
        }
    ],
    "line_items": [
        {
            "id": 9,
            "name": "Hoodie - Blue, Yes",
            "product_id": 12,
            "variation_id": 35,
            "quantity": 7,
            "tax_class": "",
            "subtotal": "232.38",
            "subtotal_tax": "51.12",
            "total": "232.38",
            "total_tax": "51.12",
            "taxes": [
                {
                    "id": 1,
                    "total": "51.12",
                    "subtotal": "51.12"
                }
            ],
            "meta_data": [
                {
                    "id": 82,
                    "key": "pa_color",
                    "value": "blue",
                    "display_key": "Color",
                    "display_value": "Blue"
                },
                {
                    "id": 83,
                    "key": "logo",
                    "value": "Yes",
                    "display_key": "Logo",
                    "display_value": "Yes"
                },
                {
                    "id": 84,
                    "key": "wcb2bsa_item_commission",
                    "value": "10",
                    "display_key": "wcb2bsa_item_commission",
                    "display_value": "10"
                },
                {
                    "id": 1933,
                    "key": "wcb2bsa_custom_price",
                    "value": "true",
                    "display_key": "wcb2bsa_custom_price",
                    "display_value": "true"
                }
            ],
            "sku": "woo-hoodie-blue-logo",
            "price": 33.19672128571428,
            "parent_name": "Hoodie"
        }
    ],
    "tax_lines": [
        {
            "id": 11,
            "rate_code": "TAX-1",
            "rate_id": 1,
            "label": "Tax",
            "compound": false,
            "tax_total": "51.12",
            "shipping_tax_total": "4.40",
            "rate_percent": 22,
            "meta_data": [
                {
                    "id": 98,
                    "key": "wcb2bsa_item_commission",
                    "value": "10",
                    "display_key": "wcb2bsa_item_commission",
                    "display_value": "10"
                }
            ]
        }
    ],
    "shipping_lines": [
        {
            "id": 10,
            "method_title": "Flat rate",
            "method_id": "flat_rate",
            "instance_id": "2",
            "total": "20.00",
            "total_tax": "4.40",
            "taxes": [
                {
                    "id": 1,
                    "total": "4.4",
                    "subtotal": ""
                }
            ],
            "meta_data": [
                {
                    "id": 90,
                    "key": "Products",
                    "value": "Hoodie - Blue, Yes × 7",
                    "display_key": "Products",
                    "display_value": "Hoodie - Blue, Yes × 7"
                },
                {
                    "id": 91,
                    "key": "wcb2bsa_item_commission",
                    "value": "10",
                    "display_key": "wcb2bsa_item_commission",
                    "display_value": "10"
                }
            ]
        }
    ],
    "fee_lines": [],
    "coupon_lines": [],
    "refunds": [],
    "currency_symbol": "$",
    "wcb2bsa_sales_agent": 3,
    "wcb2bsa_order_item_types_eligible_for_commission": {
        "line_item": "1",
        "fee": "1",
        "shipping": "1"
    },
    "wcb2bsa_created_by": "sales_agent",
    "_links": {
        "self": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/orders/101"
            }
        ],
        "collection": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/orders"
            }
        ],
        "customer": [
            {
                "href": "https://demo.woocommerce-b2b.com/sales-agents/wp-json/wc/v3/customers/2"
            }
        ]
    }
}

To know more about WPML configuration, take a look to: WooCommerce B2B Sales Agents compatibility with wpml.

This is a simple guide to configure WooCommerce B2B Sales Agents and WPML to work in the best way.

In some cases, the SiteGround Optimizer plugin can cause problems with the display of the sales agent dashboard or user myaccount page due to a suboptimal plugin configuration.

To resolve, it is sufficient to exclude the URLs of the myaccount page and the sales agent dashboard page from caching, through the SiteGround Optimizer settings:

SG Optimizer -> Caching -> Caching Settings section -> Exclude URLs from Caching

In some cases, a deeper intervention is needed, which can be performed using WordPress hooks and functions that SiteGround Optimizer makes available.

To resolve, it is sufficient to force cache clearing of these pages on login, you can add this code to your functions.php file:

add_action( 'wp_login', 'wcb2bsa_clear_sgcachepress', 10, 2 );
function wcb2bsa_clear_sgcachepress( $user_login, $user ) {
    if ( function_exists( 'sg_cachepress_purge_cache' ) ) {
        sg_cachepress_purge_cache( get_permalink( get_option( 'wcb2bsa_dashboard_page' ) ) ); // Dashboard
        sg_cachepress_purge_cache( get_permalink( wc_get_page_id( 'myaccount' ) ) ); // MyAccount
    }
}