API Customer management

Customer management

Customer management API allows to add and maintain the customer base in FC+.

Add customer configuration to FC+

Before starting to add customers you need to configure customer format in FC+. The fields will determine which customer info will be displayed in Customer module.

Login to FC+ -> Settings->Customers
‘Current data configuration’ section . Add new fields with field configuration (Column type)

Add customers via API

Once customer configuration is setup, customers can be added to FC+ using API.

GET the list of fields IDs for fields you configured in above step.

Api/Customers/getFields Sample response node:

48123 name Name

POST add new customers to FC+ Api/Customers/save (1 API call = 1 added customer)

Mandatory parameters:

ExternalID -- ID assigned by you to the customer
Location -- JSON formatted location fields. This will be customer location. Optional JSON fields: postalcode, country, county, municipality, estate . Required field rawaddress

e.g. {"rawAddress": "Viru Street 3, Tallinn, 12345, Estonia"}

Fields -- JSON formatted customer field IDs received from Api/customers/getFields command, with values. {“fieldID”: “field value”}

e.g. {"48123":"My new customer,"48124": " Viru Street 3, Tallinn, 12345, Estonia ","48129": "Customer description", "48191": "+372 12 345 678","48192": "5"}.

You can also geocode your newly created customers by using POST Api/Customers/geocode call and adding externalID for the customer you want to geocode.

Edit customers via API

Using POST command and Api/Customers/save call you can make changes to existing customers, using customer ID or External ID.

Delete customers via API

Delete customers from FC+ using

POST Api/Customers/deleteByIds OR Api/Customers/delete

API Customer management

Related Manuals

Customer management