PrimaryOrders

Lists sales visits

APIDescription
GET api/V3/PrimaryOrders/list

Lists all the Prinary Orders. Use '$filter=OrderId gt {lastId}' to get the latest Orders.

Assorted

Manage products

APIDescription
POST api/V3/Assorted/CreateAssortedStyle

Creates new assorted Styles.

POST api/V3/Assorted/CreateAssortedProducts

Creates new assorted products.

Outlet

List and Manage Outlets

APIDescription
GET api/V3/Outlet/Get?lastSyncedId={lastSyncedId}

List outlets max 100 at a time

POST api/V3/Outlet/CreateMultiple

Adds new outlet.

GET api/V3/Outlet/GetRegionsWithZone

For a List of All regions and Zones of The Company

POST api/V3/Outlet/CreateMultipleBeats

Creates Beats with Its Hierarchy

POST api/V3/Outlet/CreateMultipleBeatsWithErp

Creates and update Beats with Its Hierarchy, and erpid is required

GET api/V3/Outlet/DeactivateBeat?erpId={erpId}

For deactivation of beat

GET api/V3/Outlet/ActivateBeat?erpId={erpId}

For activation of beat

GET api/V3/Outlet/DeactivateTerritory?erpId={erpId}

For deactivation of territory

GET api/V3/Outlet/ActivateTerritory?erpId={erpId}

For activation of territory

GET api/V3/Outlet/DeactivateRegion?erpId={erpId}

For deactivation of region

GET api/V3/Outlet/ActivateRegion?erpId={erpId}

For activation of region

GET api/V3/Outlet/DeactivateZone?erpId={erpId}

For deactivation of zone

GET api/V3/Outlet/ActivateZone?erpId={erpId}

For activation of zone

POST api/V3/Outlet/CreateRegionsWithZone

Creates Region with Zone

POST api/V3/Outlet/UpdateErpId/{OutletGuid}

Api to Update the ERPID of an Outlet from the GUID

POST api/V3/Outlet/BlockUnblockOutlets

Api to block Outlet from the GUID

POST api/V3/Outlet/Create

Create new outlet.

POST api/V3/Outlet/Update

Update outlet.

POST api/V3/Outlet/UpdateMultiple

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

GET api/V3/Outlet/OutletsWithoutERP

Only first 200 outlets without ERP Id can be extracted

POST api/V3/Outlet/GetBeatWithHierarchy

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

Categories

Create and Mange Product Categories

APIDescription
GET api/V3/Category/list

Lists all the Product Categories available

POST api/V3/Category/Create

Creates a new category

POST api/V3/Category/ChangeCategoryForProduct

Change Category of Product

POST api/V3/Category/ChangeBrandForCategory

Change Brand Of Category

Allowance

Summary of expenses

APIDescription
GET api/V3/Allowance/list?lastAllowanceId={lastAllowanceId}

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

MTStockAndSale

Lists MT sales

APIDescription
GET api/V3/ModernTrade/Sales/list?date={date}

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

DispatchAgainstOrder

Manage Dispatches against Sale

APIDescription
POST api/V3/DispatchAgainstOrder

Creates List of Dispatches for Various Sales Done by ESMs Maximum 2000 in One request

POST api/V3/DispatchAgainstOrder/TransactionV2

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

IncentiveInfo

Upload Payment Related Transactions

APIDescription
POST api/V3/Incentives/UploadOutletWiseStyles

(Max 2000 records can be updated in one request)

POST api/V3/Incentives/UploadKRAIncentiveMapping

(Max 2000 records can be updated in one request)

POST api/V3/Incentives/UploadIncentiveGrowth

(Max 2000 records can be updated in one request)

POST api/V3/Incentives/NewOutletMonthWise

(Max 2000 records can be updated in one request)

InvoiceDetails

Manage Invoice details

APIDescription
POST api/V3/InvoiceDetails/UploadInvoiceDetails

Upload Previous generated invoices (Max 2000 records can be uploaded in one request)

POST api/V3/InvoiceDetails/UploadPrimarySaleInvoices

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

POST api/V3/InvoiceDetails/GetInvoiceDetailsForOutlets

Get invoices for the given outlets (Max 15 records can be retrieved in one request)

SuggestiveOrder

Suggestive Order

APIDescription
POST api/V3/SuggestiveOrder

API allows company to upload Retailer wise SKU wise suggestive order qty in SFA for any order date Maximum 2000 in One request

FieldUserForWalkInInvoice

Field user for walk in invoice

APIDescription
GET api/V3/FieldUserForWalkInInvoiceController/Get?distributorErpId={distributorErpId}&retailerErpId={retailerErpId}

Distributor Erp IdRetailer Erp Id

Payment

Upload Payment Related Transactions

APIDescription
POST api/V3/Payment/UploadLedgers

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

Products

Manage products

APIDescription
GET api/V3/Product/list

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

POST api/V3/Product/Create

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

POST api/V3/Product/Update

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

POST api/V3/Product/CreateMultiple

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

POST api/V3/Product/UpdatePrice

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

POST api/V3/Product/UpdateProductStage

Update the Product Attributes based on Its Stage

POST api/V3/Product/AddNewLaunchDistributorMapping

Add Distributor Mappings for New Launched Products

POST api/V3/Product/RemoveNewLaunchDistributorMapping

Remove Distributor Mappings for New Launched Products

SkuSalesData

Manage Sales Data, Norms and Pending orders

APIDescription
POST api/V3/SkuSalesData/UploadSkuNorms

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

POST api/V3/SkuSalesData/UploadCategoryProductTypes

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

POST api/V3/SkuSalesData/UploadSkuOutletProductType

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

Distributor

Manage distributor tasks

APIDescription
POST api/V3/Distributor/Update

Updates a distributor

POST api/V3/Distributor/DistributorToPDMapping

Adds Distributor To Product Division Mapping

POST api/V3/Distributor/DistributorToBeatMapping

Distributor to Beat mappings

POST api/V3/Distributor/CreateWithPDs

Creates Distributor with Product Divsion Mappings

POST api/V3/Distributor/Create

Creates a Distributor

GET api/V3/Distributor/list

Lists All the Distributors

GET api/V3/Distributor/Employees/{DistributorERPId}

Lists Employees of a particular distributor

GET api/V3/Distributor/Beats/{DistributorERPId}

Lists Beats of a particular distributor

GET api/V3/Distributor/Outlets/{DistributorERPId}

Returns all outlets attached to the distributor

POST api/V3/Distributor/UpdateStock/{DistributorERPId}

Upload the stock of a distributor

GET api/V3/Distributor/GetStock/{lastStockId}

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

POST api/V3/Distributor/DistributorToOutletMappings

Add Distributor to outlet Mappings

POST api/V3/Distributor/RemoveDistributorToOutletMappings

Removes Distributor to Location Mappings

POST api/V3/Distributor/AddAndRemoveDistributorToOutletMappings

Add and Removes Distributor to outlet and Location Mappings

DispatchAgainstPrimaryOrder

Manage Dispatches against Sale

APIDescription
POST api/V3/DispatchAgainstPrimaryOrder

Creates List of Dispatches for Primary Orders Maximum 2000 in One request

Visits

Lists sales visits

APIDescription
GET api/V3/Visit/list

Lists all the visits. Use '$filter=VisitId gt {lastId}' to get the latest visits.

GET api/V3/Visit/VisitsOfDistributor/{DistributorERPId}

Lists visits for a distributor. This Checks the Distributor Assigned for the Sales item. Sales Level Distributor matched in this Api. Use $filter=VisitId gt lastId to get the latest visits.

GET api/V3/Visit/dayStarts?date={date}

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

GET api/V3/Visit/list?lastVisitId={lastVisitId}&includeUnproductive={includeUnproductive}

Lists all the productive visits.

GET api/V3/Visit/VisitsOfDistributorAfter/{DistributorERPId}?LastVisitId={LastVisitId}

Lists visits for a distributor. This Checks the Distributor Assigned for the Sales item. Sales Level Distributor matched in this Api.

GET api/V3/Visit/SalesOfVisit/{visitId}

Lists the sales orders for a visit

POST api/V3/Visit/rejectedOrders

Accepts rejected orders

EmployeeJourney

APis For Employee Journey Plans

APIDescription
POST api/V3/EmployeeJourney/DeactivateRoutePlan

Deactivates a Route Plan

POST api/V3/EmployeeJourney/CreateRoutePlan

Creates a Route Plan

POST api/V3/EmployeeJourney/UpdateRoute

Update Route Names

POST api/V3/EmployeeJourney/CreateRoute

Creates a Route Plan

POST api/V3/EmployeeJourney/CreateRouteName

Creates a Route

POST api/V3/EmployeeJourney/UpdateRouteOutlet

Map the outlets with Route

Employees

List and Manage Employees

APIDescription
GET api/V3/Employee/list

Lists all the Employees

POST api/V3/Employee/AddFieldUser

Add a field user

GET api/V3/Employee/DeactivateFieldUser?erpId={erpId}

For deactivating user

GET api/V3/Employee/ActivateFieldUser?erpId={erpId}

For activating user

GET api/V3/Employee/DeactivateHierarchy?erpId={erpId}&userRole={userRole}

Deactivate hierarchy

GET api/V3/Employee/ActivateHierarchy?erpId={erpId}&userRole={userRole}

Activate hierarchy

POST api/V3/Employee/AddHierarchy

add or update manager of user

GET api/V3/Employee/{EmployeeERPId}/GetBeatPlan

Get the BeatPlan of the employee

POST api/V3/Employee/{EmployeeERPId}/AddBeatPlan

Upload the beat plan for the employee

POST api/V3/Employee/RemoveEmployeeToPDMapping

Dettach Employee to ProductDivision Mapping Api

POST api/V3/Employee/EmployeeToPDMapping

Employee to ProductDivision Mapping Api

DetailedVisits

Lists sales visits

APIDescription
GET api/V3/DetailedVisit/list?lastVisitId={lastVisitId}&DistributorERPId={DistributorERPId}&includeUnproductive={includeUnproductive}

Provides List of Visits from Transaction Db

NonFAInvoiceDetails

Upload Invoice Details

APIDescription
POST api/V3/NonFAInvoiceDetails/UploadInvoiceDetails

Upload Invoice Details

OutletAdditionRequest

Lists sales visits

APIDescription
GET api/V3/OutletAdditionRequest/list?LastRequestId={LastRequestId}&IsManagerApproved={IsManagerApproved}

Fetches the 100 Outlet Creation requests after the LastRequestId

POST api/V3/OutletAdditionRequest/review

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

GET api/V3/OutletAdditionRequest/reject?RequestId={RequestId}&ReasonForRejection={ReasonForRejection}

Rejects a outlet Addition Request and adds the reason for rejection

RegionalPricing

APIDescription
POST api/V3/RegionalPricing/Update

Updates Regional pricing for products

OrderWithBilledPTR

Manage Dispatches against Sale

APIDescription
POST api/V3/OrderWithBilledPTR

Creates List of Dispatches for Various Sales Done by ESMs Maximum 2000 in One request