Example Integration: Getting Customer or Prospect List

Companies are using BeatRoute to enrich retailer / customer profile data. BeatRoute provides various options to analyze the data and do the required functions on them.

If you have any use case which requires BeatRoute retailer / Customer profile data to be moved to some external system, you can download customer data from BeatRoute and create upload in any of your SAP / ERP system. 

Manual upload / downloads are always tiring, time consuming and prone to errors. To minimize the efforts and errors, we have provided a way for the company to consume our API and automate the process.

To access customer data, you can access API with API_URL as:

v1/customer/index

Here v1 is the version number of the application. Please click here to know about BeatRoute API versioning.

Thus the complete URL would be:

BASE_URL + "v1/customer/index" + "?key=" + TOKEN

Search Request can be sent via POST method:

e.g.:

<?xml version="1.0" encoding="UTF-8"?>
<request>
   <search>
      <external_id>100015</external_id>
      <cond1>&gt;</cond1>
      <cond1>created_date</cond1>
      <cond1>2017-04-05</cond1>
   </search>
</request>

Here all requests must be sent with request as wrapper. Search criteria would be sent with "search" wrapper.

Conditions can be: 

1. Equals to: <field>value</field>

2. Greater Than:
<cond1>&gt;</cond1>

<cond1>field_name</cond1>

<cond1>value</cond1>

3. Lower than:

<cond1>&lt;</cond1>

<cond1>field_name</cond1>

<cond1>value</cond1>

4. Between:

<cond1>between</cond1>

<cond1>field_name</cond1>

<cond1>value1</cond1>

<cond1>value2</cond1>

5. Not equal to 

<cond1>&lt;&gt;</cond1>

<cond1>field_name</cond1>

<cond1>value</cond1>

Multiple conditions can be passed through:

<cond1>

<cond2>

<cond3>

On calling this API, system would return data as:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <success>1</success>
    <data>
        <items>
            <item>
                <id>738524</id>
                <city>Mumbai Suburban</city>
                <chain_id></chain_id>
                <district></district>
                <unique_id></unique_id>
                <company_id>57</company_id>
                <contact_person></contact_person>
                <country></country>
                <created_by></created_by>
                <created_date>2017-12-20 17:09:31</created_date>
                <deleted_by></deleted_by>
                <deleted_date></deleted_date>
                <email>test@gmail.com</email>
                <fax></fax>
                <fssai_number></fssai_number>
                <group>0</group>
                <is_available>1</is_available>
                <landline></landline>
                <longitude></longitude>
                <latitude></latitude>
                <locality></locality>
                <mobile>9821772134</mobile>
                <modified_by></modified_by>
                <modified_date></modified_date>
                <name>Test</name>
                <pan></pan>
                <pincode></pincode>
                <retailer_subtype>0</retailer_subtype>
                <retailer_type></retailer_type>
                <status>0</status>
                <street></street>
                <sync_time>2018-01-02 22:11:35</sync_time>
                <route_id></route_id>
                <route_order>0</route_order>
                <stage>0</stage>
                <route></route>
                <state_id></state_id>
                <state></state>
                <external_id></external_id>
                <customFields/>
                <statutoryFields>
                    <item>
                        <id>10</id>
                        <name>GSTIN Number</name>
                    </item>
                </statutoryFields>
            </item>
        </items>
        <_meta>
            <totalCount>1</totalCount>
            <pageCount>1</pageCount>
            <currentPage>1</currentPage>
            <perPage>40</perPage>
        </_meta>
    </data>
    <status>200</status>
</response>