This is a self-service guide. If you follow it step by step, you’ll be able to update your data in FranConnect using data in Excel or Google Sheets, leveraging AI to build the XML, and sending it via FranConnect’s API.
Overview: What You’ll Do
Prepare your data in Excel/Google Sheets.
Retrieve the official FranConnect XML schema from the docs. FranConnect’s API documentation
Use AI [Customer AI environment] (e.g., ChatGPT) to convert your sheet data into XML.
Send the XML to FranConnect via API.
Verify results in the FranConnect app.
Step-by-Step Instructions
Step |
What To Do |
|---|---|
|
In Excel or Google Sheets, create a sheet where each row is one record you want to update. Use column names that match FranConnect’s schema (e.g. |
|
Obtain FranConnect’s API documentation and XML schema, especially the spec around the “submodule” POST path under Update POST endpoint in the FranConnect API docs. [Retrieve Schema > Update] |
|
Take your sheet data and a sample XML template (from the spec). Prompt an AI tool to convert your rows into XML. |
|
Using a tool like Postman / your integration middleware / a simple script: send an HTTP POST to the FranConnect API endpoint, with the XML as the body, correct content type, authentication. |
|
Check for API responses (success / error messages). Then log into your FranConnect app to confirm updates took place. Fix any issues (e.g. missing tags, invalid data) and retry. |
Example Flow
Let’s do a concrete example: Suppose you have a list of 2 stores whose phone numbers need updating.
Your Excel / Google Sheet
referenceId |
Area/Region |
Store Type |
Center Name |
City |
Country |
Store Phone |
|---|---|---|---|---|---|---|
2125440062 |
District 12 |
Default |
Andy Bay |
Dunedin |
New Zealand |
999-999-9999 |
35434454 |
District 10 |
Default |
Ashburton |
Auckland |
New Zealand |
888-888-8888 |
Sample XML Template (as per FranConnect Schema)
Here is what the FranConnect Schema:
<fcRequest>
<fimCenterInfo>
<referenceId></referenceId>
<areaID></areaID>
<storeTypeId></storeTypeId>
<centerName></centerName>
<city></city>
<country></country>
<storePhone></storePhone>
</fimCenterInfo>
<!-- more fimCenterInfo blocks if many rows -->
</fcRequest>
Prompt to Use with AI (e.g., ChatGPT)
Prompt: “Convert the data set below into XML that conforms to the FranConnect [Module Name eg: FIM] module. Use the provided XML template and the field mapping in the attached Excel. Remove any tags that are not required or don’t match the Excel. Return only the final XML in a single code block.”
Convert the data set below into XML that conforms to the FranConnect [Module Name eg: FIM] module. Use the provided XML template and the field mapping in the attached Excel. Remove any tags that are not required or don’t match the Excel. Return only the final XML in a single code block.
<fcRequest>
<fimCenterInfo>
<referenceId></referenceId>
<areaID></areaID>
<storeTypeId></storeTypeId>
<centerName></centerName>
<city></city>
<country></country>
<storePhone></storePhone>
</fimCenterInfo>
<!-- more fimCenterInfo blocks if many rows -->
</fcRequest>
Here is my data:<Excel File Link>
Example AI Output
<fcRequest>
<fimCenterInfo>
<referenceId>2125440062</referenceId>
<areaID>District 12</areaID>
<storeTypeId>Default</storeTypeId>
<centerName>Andy Bay</centerName>
<city>Dunedin</city>
<country>New Zealand</country>
<storePhone>999-999-9999</storePhone>
</fimCenterInfo>
<fimCenterInfo>
<referenceId>35434454</referenceId>
<areaID>District 10</areaID>
<storeTypeId>Default</storeTypeId>
<centerName>Ashburton</centerName>
<city>Auckland</city>
<country>New Zealand</country>
<storePhone>888-888-8888</storePhone>
</fimCenterInfo>
</fcRequest>
How to Send via API
Using Postman or your integration tool:
URL:
https://<your-franconnect-url>/submodule?module=fimMethod: POST
-
Headers:
Content-Type:application/xmlAuthorization:Bearer <your_access_token>(or whatever auth setup FranConnect uses)
Body: The XML above
Send the request.
Expected Result
You get a response with HTTP 200 or similar indicating success.
In FranConnect UI (center info etc.), you see that for
2125440062, store phone is now999-999-9999, and for35434454, phone is888-888-8888.
Video
You can refer to the help video below to see the steps in action.