Field Assist API Help Page

Use this API to Get 100 Incremental Primary Orders

API to post external Primary Orders in the SFA

This API is used to create or update outlet wallet balance

Creates new assorted Styles.

Creates new assorted products.

Adds new outlet.

For a List of All regions and Zones of The Company

Creates Beats with Its Hierarchy

Update Multiple Beats

Api to Update the ERPID of an Outlet from the GUID

Api to Update the KYC status of an Outlet

Api to block Outlet from the GUID

Create new outlet.

Update outlet.

updates multiple outlets in the batch (Max 2000 records can be updated in one request)

Fetches the 100 outlets without ERPId after the LastRequestId

Fetches the 100 Billed To Shipped To Address after the epoch time

For a List of All Beat, Territory, Region and Zones of The Company

Api For Create / Update Entity Margin Slabs

Add QPS (Max 2000 records can be updated in one request)

Lists all the Product Categories available

Creates a new category

Change Category of Product

Change Brand Of Category

External Api for CueCards

api to post multiple outlet metric values

Lists all the expenses . Use this to get latest allowances.

Lists all the modern trade sales for the date given. date passed in "MM/dd/yyyy" format

API can be used to fetch Employee Wise Day Summary records of a particular Date.

Upload List of Dispatches for Various Sales Done by ESMs in Transaction database Maximum 2000 in One request

Upload primary sales invoices (Max 2000 records can be uploaded in one request)

Create Invoice Details on the basis of Attendance Id

Distributor Erp IdRetailer Erp Id

Creates or updates multiple Company Stocks.

Update Geographies based on Geography ERPId

This API is used to create or update Position Codes

Lists all the products. Max 1000 products are listed in a request. Use paging ($skip) to get more.

Creates a new product. Method fails if a product of same name exists in the same category.

Updates a product. If Variants are null they are ignored. This method requires that the product model must have either Guid or ERPId set. GUID will be used for reference and can't be Updated

Adds multiple new products in the batch (Max 2000 records can be updated in one request)

This API is used to create or update multiple products (maximum limit of 100 at once in input)

Upload the price of the products (Max 2000 records can be updated in one request)

Update the Product Attributes based on Its Stage

Add Distributor Mappings for New Launched Products

Remove Distributor Mappings for New Launched Products

Activate a Product via ErpId

Update product prices for Super Stockist, distributors and Sub Stockist. (Max 2000 records can be updated in one request)

Update product prices for Regional Super Stockist, distributors and Sub Stockist. (Max 2000 records can be updated in one request)

Update product prices for Regional Super Stockist, distributors and Sub Stockist. (Max 2000 records can be updated in one request)

Update product prices for Regional Super Stockist, distributors and Sub Stockist. (Max 2000 records can be updated in one request)

Update product prices,ERPId and MRP for Regional Super Stockist, distributors and Sub Stockist. (Max 2000 records can be updated in one request)

Api For Create / Update Display Categories

Api for Create / Update Product Basket and Create Product-Basket Mappings

Get Products from ERP Ids

API can be used to fetch 10 incremental records of Approved Van Load Out Details.

API can be used to fetch 10 incremental records of Approved Van Load In Details.

API can be used to fetch 10 incremental records of Approved Van Load Out Details.

API can be used to fetch 10 incremental records of Approved Van Load Out Details.

API can be used to fetch 10 incremental records of Approved Van Load Out Details.

API can be used to fetch 10 incremental records of Van Order Intent.

Fetches the 100 next cancelled order status ids after the LastRequestId

This API is used to create multiple order status (maximum limit of 100 at once in input)

Upload Sku norms (Max 2000 records can be updated in one request)

Upload Category ProductTypes (Max 2000 records can be updated in one request)

Updates a distributor

Adds Distributor To Product Division Mapping

Distributor to Beat mappings - Used to map all types of distributor to beats

Creates Distributor with Product Divsion Mappings

Creates a Distributor

Lists All the Distributors

Lists Employees of a particular distributor

Lists Beats of a particular distributor

Returns all outlets attached to the distributor

Upload the stock of a distributor

View the Stocks of a Particular Distributor (100 at a time) Starting from lastStockId

Add Distributor to outlet Mappings

Removes Distributor to Location Mappings

Add Distributor to User Mappings

Activate a distributor via ErpId

Delete all the User Distributor mapping at once (max 100 records at a time)

Lists all the Retailers mapped to a Distributor

Returns a list of Payments Received.

API can be used to fetch 100 incremental records of payment collected against invoice/order thorugh SFA.This is Live API and data will be available as soon as it get synched to FA Database.

API can be used to fetch Outlet wise payment details.

API can be used to upload Retailer Collection details.

API can be used to fetch 100 incremental Collection records and relevant collection information by seeding a particular Collection ID.

Returns the DayStarts of Employees of your company on a particular date

Get Next productive visit.

Provides List of Visits from Transaction Db

Returns V4 Visit Id and takes input V3 Visit Id

Deactivates a Route Plan

Creates a Route Plan

Update Route Names

Creates a Route Plan

Creates a Route

Map the outlets with Route

creates user beat mapping or position beat mapping based on company setting

Gets opening and closing values for distributor's products.

Gets distributor's products order Vs Invoice Data.

Adds new Product Wise Demand Vs Sales Record.

Lists all the Employees

Add a field user

For deactivating user

add or update manager of user

API to add an Employee in the Company(updates if Employee ERP is present)

Get the BeatPlan of the employee

Upload the beat plan for the employee

Dettach Employee to ProductDivision Mapping Api

Employee to ProductDivision Mapping Api

Update Level 1 Field Users Api

Add or Update Employee Leaves

Provides List of Visits from Transaction Db

Provides List of Visits

No documentation available.

Upload Invoice Details

Fetches the 100 Outlet Creation requests after the LastRequestId

Reviews and Saves the Location as per Request Approval, Max 100 Addition Requests can be executed in one Request

Rejects a outlet Addition Request and adds the reason for rejection

Outlet Creation Request From External API to Manager App

API to create multiple schemes

API to create multiple schemes

Updates Regional pricing for products

Lists all the survey responses From ReportDb.