Example Integration: Creating a Customer or a Prospect

Modified on Wed, 02 Jan 2019 at 05:47 PM

This requires programming knowledge.

With this API you would be able to automate your retail stores / customers data from external system to BeatRoute.


To access this API use API_URL as:

API_URL: v1/customer/create

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/create" + "?key=" + TOKEN


Possible Fields are:

  • name - mandatory
  • remarks - Add remarks of customer
  • br_id - BeatRoute ID (if available)
  • external_id - mandatory
  • type - mandatory
  • class - As defined by company (Class Attribute)
  • stage - As defined by company
  • tsm (if available)
  • route 
  • street - mandatory
  • locality - mandatory
  • city - mandatory
  • district
  • state - mandatory
  • pincode - mandatory
  • landline
  • email
  • fax
  • mobile
  • contact_person

 

Request Would be: 

<request>
<item>
<erp_id></erp_id>
<name>try3</name>
<remarks>Inquired about Mutual Funds</remarks>
  <city></city>
  <contactNo></contactNo>
  <contact_person>nana</contact_person>
  <district></district>
  <email></email>
  <fax></fax>
  <group></group>
  <landline></landline>
  <latitude>28.4723864</latitude>
  <locality></locality>
  <longitude>77.0546024</longitude>
  <mobile>9784578451</mobile>
  <pincode></pincode>
  <profile_per>80.0</profile_per>
  <promoterName></promoterName>
  <retailer_type>GT</retailer_type>
  <route>6390</route>
  <state></state>
  <status>1</status>
  <statutoryFields>
    <id>1</id>
    <value></value>
  </statutoryFields>
  <statutoryFields>
    <id>2</id>
    <value></value>
  </statutoryFields>
  <statutoryFields>
    <id>3</id>
    <value>gdhd</value>
  </statutoryFields>
  <statutoryFields>
    <id>4</id>
    <value></value>
  </statutoryFields>
  <street>babab</street>
  <tsm></tsm>
<item>
</request>



Response would be:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <success>true</success>
    <data>
        <item>
           <br_id></br_id>
            <erp_id>1747104574</erp_id>
            <error></error>
            <field></field>
            <value></value>
            <message></message>
        </item>
    </data>
    <pagination></pagination>
    <status>200</status>
</response>



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article